Class: DwollaSwagger::MasspaymentsApi

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

Class Method Summary collapse

Class Method Details

.by_id(id, opts = {}) ⇒ MassPayment

Get a mass payment by id.

Parameters:

  • id —

    ID of mass payment to get.

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

    the optional parameters

Returns:



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/dwolla_swagger/api/masspayments_api.rb', line 155

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

  # resource path
  path = "/mass-payments/{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 = MassPayment.new() and obj.build_from_hash(response.body))

end

.create(opts = {}) ⇒ Unit

Create a new mass payment.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/dwolla_swagger/api/masspayments_api.rb', line 115

def self.create(opts = {})
  

  # resource path
  path = "/mass-payments".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 = Unit.new() and obj.build_from_hash(response.body))

end

.get_by_account(id, opts = {}) ⇒ MassPaymentListResponse

Get an account's mass payments.

Parameters:

  • id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :limit (int) —

    How many results to return.

  • :offset (int) —

    How many results to skip.

Returns:



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
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/dwolla_swagger/api/masspayments_api.rb', line 17

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

  # resource path
  path = "/accounts/{id}/mass-payments".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 = {}
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'offset'] = opts[:'offset'] if opts[:'offset']

  # 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 = MassPaymentListResponse.new() and obj.build_from_hash(response.body))

end

.get_by_customer(id, opts = {}) ⇒ MassPaymentListResponse

Get a customer's mass payments.

Parameters:

  • id —

    Customer ID

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

    the optional parameters

Options Hash (opts):

  • :limit (int) —

    How many results to return.

  • :offset (int) —

    How many results to skip.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/dwolla_swagger/api/masspayments_api.rb', line 67

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

  # resource path
  path = "/customers/{id}/mass-payments".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 = {}
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'offset'] = opts[:'offset'] if opts[:'offset']

  # 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 = MassPaymentListResponse.new() and obj.build_from_hash(response.body))

end