Class: DwollaSwagger::WebhooksubscriptionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dwolla_swagger/api/webhooksubscriptions_api.rb

Class Method Summary collapse

Class Method Details

.create(opts = {}) ⇒ WebhookSubscription

Create a new webhook subscription.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/dwolla_swagger/api/webhooksubscriptions_api.rb', line 54

def self.create(opts = {})
  

  # resource path
  path = "/webhook-subscriptions".sub('{format}','json')

  

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/vnd.dwolla.v1.hal+json']
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/vnd.dwolla.v1.hal+json']
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(opts[:'body'])
  

  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make

  response.code == 201 ? obj = response.headers['Location'] : (obj = WebhookSubscription.new() and obj.build_from_hash(response.body))

end

.delete_by_id(id, opts = {}) ⇒ WebhookSubscription

Delete a webhook subscription by id.

Parameters:

  • id —

    ID of webhook subscription to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/dwolla_swagger/api/webhooksubscriptions_api.rb', line 187

def self.delete_by_id(id, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling delete_by_id" if id.nil?
  

  # resource path
  path = "/webhook-subscriptions/{id}".sub('{format}','json')

  
  # check if id parameter is resource URI, otherwise substitute for ID
  path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s)
  

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/vnd.dwolla.v1.hal+json']
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  response = Swagger::Request.new(:DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make

  response.code == 201 ? obj = response.headers['Location'] : (obj = WebhookSubscription.new() and obj.build_from_hash(response.body))

end

.id(id, opts = {}) ⇒ WebhookSubscription

Get a webhook subscription by id.

Parameters:

  • id —

    ID of webhook subscription to get.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/dwolla_swagger/api/webhooksubscriptions_api.rb', line 94

def self.id(id, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling id" if id.nil?
  

  # resource path
  path = "/webhook-subscriptions/{id}".sub('{format}','json')

  
  # check if id parameter is resource URI, otherwise substitute for ID
  path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s)
  

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/vnd.dwolla.v1.hal+json']
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make

  response.code == 201 ? obj = response.headers['Location'] : (obj = WebhookSubscription.new() and obj.build_from_hash(response.body))

end

.list(opts = {}) ⇒ WebhookListResponse

Get the list of webhooks.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/dwolla_swagger/api/webhooksubscriptions_api.rb', line 14

def self.list(opts = {})
  

  # resource path
  path = "/webhook-subscriptions".sub('{format}','json')

  

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/vnd.dwolla.v1.hal+json']
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make

  response.code == 201 ? obj = response.headers['Location'] : (obj = WebhookListResponse.new() and obj.build_from_hash(response.body))

end

.update_subscription(id, opts = {}) ⇒ WebhookSubscription

Update a subscription by id.

Parameters:

  • id —

    ID of webhook to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/dwolla_swagger/api/webhooksubscriptions_api.rb', line 141

def self.update_subscription(id, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling update_subscription" if id.nil?
  

  # resource path
  path = "/webhook-subscriptions/{id}".sub('{format}','json')

  
  # check if id parameter is resource URI, otherwise substitute for ID
  path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s)
  

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/vnd.dwolla.v1.hal+json']
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(opts[:'body'])
  

  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make

  response.code == 201 ? obj = response.headers['Location'] : (obj = WebhookSubscription.new() and obj.build_from_hash(response.body))

end