Class: MxPlatformRuby::MicrodepositsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/api/microdeposits_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MicrodepositsApi

Returns a new instance of MicrodepositsApi.



19
20
21
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts = {}) ⇒ MicrodepositResponseBody

Verify a Microdeposit Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the ‘status` is `VERIFIED`. Poll the `/users/user_guid/micro_deposits/micro_deposit_guid` (read microdeposit) endpoint until you see this status or an error state.

Parameters:

  • microdeposit_guid (String) —

    The unique identifier for the microdeposit. Defined by MX.

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 28

def micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts = {})
  data, _status_code, _headers = micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts)
  data
end

#micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts = {}) ⇒ Array<(MicrodepositResponseBody, Integer, Hash)>

Verify a Microdeposit Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the &#x60;status&#x60; is &#x60;VERIFIED&#x60;. Poll the &#x60;/users/user_guid/micro_deposits/micro_deposit_guid&#x60; (read microdeposit) endpoint until you see this status or an error state.

Parameters:

  • microdeposit_guid (String) —

    The unique identifier for the microdeposit. Defined by MX.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(MicrodepositResponseBody, Integer, Hash)>) —

    MicrodepositResponseBody data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
88
89
90
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 39

def micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrodepositsApi.micro_deposits_microdeposit_guid_verify_put ...'
  end
  # verify the required parameter 'microdeposit_guid' is set
  if @api_client.config.client_side_validation && microdeposit_guid.nil?
    fail ArgumentError, "Missing the required parameter 'microdeposit_guid' when calling MicrodepositsApi.micro_deposits_microdeposit_guid_verify_put"
  end
  # resource path
  local_var_path = '/micro_deposits/{microdeposit_guid}/verify'.sub('{' + 'microdeposit_guid' + '}', CGI.escape(microdeposit_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'microdeposit_verify_request_body'])

  # return_type
  return_type = opts[:debug_return_type] || 'MicrodepositResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MicrodepositsApi.micro_deposits_microdeposit_guid_verify_put",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MicrodepositsApi#micro_deposits_microdeposit_guid_verify_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_micro_deposits_get(user_guid, opts = {}) ⇒ MicrodepositsResponseBody

List all microdeposits for a user Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 97

def users_user_guid_micro_deposits_get(user_guid, opts = {})
  data, _status_code, _headers = users_user_guid_micro_deposits_get_with_http_info(user_guid, opts)
  data
end

#users_user_guid_micro_deposits_get_with_http_info(user_guid, opts = {}) ⇒ Array<(MicrodepositsResponseBody, Integer, Hash)>

List all microdeposits for a user Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(MicrodepositsResponseBody, Integer, Hash)>) —

    MicrodepositsResponseBody data, response status code and response headers



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 107

def users_user_guid_micro_deposits_get_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_get ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_get"
  end
  # resource path
  local_var_path = '/users/{user_guid}/micro_deposits'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MicrodepositsResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid, opts = {}) ⇒ nil

Delete a microdeposit Use this endpoint to delete the specified microdeposit.

Parameters:

  • micro_deposit_guid (String) —

    The unique identifier for the microdeposit. Defined by MX.

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

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

    the optional parameters

Returns:

  • (nil) 


161
162
163
164
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 161

def users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid, opts = {})
  users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid, opts)
  nil
end

#users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a microdeposit Use this endpoint to delete the specified microdeposit.

Parameters:

  • micro_deposit_guid (String) —

    The unique identifier for the microdeposit. Defined by MX.

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 172

def users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete ...'
  end
  # verify the required parameter 'micro_deposit_guid' is set
  if @api_client.config.client_side_validation && micro_deposit_guid.nil?
    fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete"
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete"
  end
  # resource path
  local_var_path = '/users/{user_guid}/micro_deposits/{micro_deposit_guid}'.sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_micro_deposit_guid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid, opts = {}) ⇒ MicrodepositResponseBody

Read a microdeposit for a user Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.
</br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

  • micro_deposit_guid (String) —

    The unique identifier for the microdeposit. Defined by MX.

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

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 228

def users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid, opts = {})
  data, _status_code, _headers = users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid, opts)
  data
end

#users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid, opts = {}) ⇒ Array<(MicrodepositResponseBody, Integer, Hash)>

Read a microdeposit for a user Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. &lt;br&gt;&lt;/br&gt; Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

  • micro_deposit_guid (String) —

    The unique identifier for the microdeposit. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(MicrodepositResponseBody, Integer, Hash)>) —

    MicrodepositResponseBody data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 239

def users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get"
  end
  # verify the required parameter 'micro_deposit_guid' is set
  if @api_client.config.client_side_validation && micro_deposit_guid.nil?
    fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get"
  end
  # resource path
  local_var_path = '/users/{user_guid}/micro_deposits/{micro_deposit_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MicrodepositResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_micro_deposit_guid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body, opts = {}) ⇒ MicrodepositResponseBody

Create a microdeposit Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 297

def users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body, opts = {})
  data, _status_code, _headers = users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body, opts)
  data
end

#users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body, opts = {}) ⇒ Array<(MicrodepositResponseBody, Integer, Hash)>

Create a microdeposit Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(MicrodepositResponseBody, Integer, Hash)>) —

    MicrodepositResponseBody data, response status code and response headers



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/mx-platform-ruby/api/microdeposits_api.rb', line 308

def users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_post ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_post"
  end
  # verify the required parameter 'microdeposit_request_body' is set
  if @api_client.config.client_side_validation && microdeposit_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'microdeposit_request_body' when calling MicrodepositsApi.users_user_guid_micro_deposits_post"
  end
  # resource path
  local_var_path = '/users/{user_guid}/micro_deposits'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(microdeposit_request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'MicrodepositResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end