Class: MxPlatformRuby::MxPlatformApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MxPlatformApi

Returns a new instance of MxPlatformApi.



19
20
21
 
# File 'lib/mx-platform-ruby/api/mx_platform_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/mx_platform_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#aggregate_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Aggregate member Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

Parameters:

  • member_guid (String) —

    The unique id for a `member`.

  • user_guid (String) —

    The unique id for a `user`.

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

    the optional parameters

Returns:



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

def aggregate_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = aggregate_member_with_http_info(member_guid, user_guid, opts)
  data
end

#aggregate_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Aggregate member Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody 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
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 39

def aggregate_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.aggregate_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.aggregate_member"
  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 MxPlatformApi.aggregate_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/aggregate'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.aggregate_member",
    :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: MxPlatformApi#aggregate_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_balances(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Check balances This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



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

def check_balances(member_guid, user_guid, opts = {})
  data, _status_code, _headers = check_balances_with_http_info(member_guid, user_guid, opts)
  data
end

#check_balances_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Check balances This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



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
154
155
156
157
158
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 108

def check_balances_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.check_balances ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.check_balances"
  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 MxPlatformApi.check_balances"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/check_balance'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.check_balances",
    :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: MxPlatformApi#check_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_category(user_guid, category_create_request_body, opts = {}) ⇒ CategoryResponseBody

Create category Use this endpoint to create a new custom category for a specific ‘user`.

Parameters:

  • user_guid (String) —

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

  • category_create_request_body (CategoryCreateRequestBody) —

    Custom category object to be created

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

    the optional parameters

Returns:



166
167
168
169
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 166

def create_category(user_guid, category_create_request_body, opts = {})
  data, _status_code, _headers = create_category_with_http_info(user_guid, category_create_request_body, opts)
  data
end

#create_category_with_http_info(user_guid, category_create_request_body, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>

Create category Use this endpoint to create a new custom category for a specific &#x60;user&#x60;.

Parameters:

  • user_guid (String) —

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

  • category_create_request_body (CategoryCreateRequestBody) —

    Custom category object to be created

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

    the optional parameters

Returns:

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

    CategoryResponseBody data, response status code and response headers



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
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 177

def create_category_with_http_info(user_guid, category_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_category ...'
  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 MxPlatformApi.create_category"
  end
  # verify the required parameter 'category_create_request_body' is set
  if @api_client.config.client_side_validation && category_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'category_create_request_body' when calling MxPlatformApi.create_category"
  end
  # resource path
  local_var_path = '/users/{user_guid}/categories'.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/vnd.mx.api.v1+json'])
  # 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(category_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_category",
    :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: MxPlatformApi#create_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_managed_account(user_guid, member_guid, managed_account_create_request_body, opts = {}) ⇒ AccountResponseBody

Create managed account Use this endpoint to create a partner-managed account.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

  • managed_account_create_request_body (ManagedAccountCreateRequestBody) —

    Managed account to be created.

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

    the optional parameters

Returns:



241
242
243
244
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 241

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

#create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>

Create managed account Use this endpoint to create a partner-managed account.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

  • managed_account_create_request_body (ManagedAccountCreateRequestBody) —

    Managed account to be created.

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

    the optional parameters

Returns:

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

    AccountResponseBody data, response status code and response headers



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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 253

def (user_guid, member_guid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_managed_account ...'
  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 MxPlatformApi.create_managed_account"
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.create_managed_account"
  end
  # verify the required parameter 'managed_account_create_request_body' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'managed_account_create_request_body' when calling MxPlatformApi.create_managed_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_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/vnd.mx.api.v1+json'])
  # 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()

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_managed_account",
    :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: MxPlatformApi#create_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_managed_member(user_guid, managed_member_create_request_body, opts = {}) ⇒ MemberResponseBody

Create managed member Use this endpoint to create a new partner-managed ‘member`.

Parameters:

  • user_guid (String) —

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

  • managed_member_create_request_body (ManagedMemberCreateRequestBody) —

    Managed member to be created.

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

    the optional parameters

Returns:



320
321
322
323
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 320

def create_managed_member(user_guid, managed_member_create_request_body, opts = {})
  data, _status_code, _headers = create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts)
  data
end

#create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Create managed member Use this endpoint to create a new partner-managed &#x60;member&#x60;.

Parameters:

  • user_guid (String) —

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

  • managed_member_create_request_body (ManagedMemberCreateRequestBody) —

    Managed member to be created.

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 331

def create_managed_member_with_http_info(user_guid, managed_member_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_managed_member ...'
  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 MxPlatformApi.create_managed_member"
  end
  # verify the required parameter 'managed_member_create_request_body' is set
  if @api_client.config.client_side_validation && managed_member_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'managed_member_create_request_body' when calling MxPlatformApi.create_managed_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members'.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/vnd.mx.api.v1+json'])
  # 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(managed_member_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_managed_member",
    :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: MxPlatformApi#create_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) ⇒ TransactionResponseBody

Create managed transaction Use this endpoint to create a new partner-managed ‘transaction`.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

  • managed_transaction_create_request_body (ManagedTransactionCreateRequestBody) —

    Managed transaction to be created.

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

    the optional parameters

Returns:



395
396
397
398
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 395

def create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body, opts = {})
  data, _status_code, _headers = create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts)
  data
end

#create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>

Create managed transaction Use this endpoint to create a new partner-managed &#x60;transaction&#x60;.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

  • managed_transaction_create_request_body (ManagedTransactionCreateRequestBody) —

    Managed transaction to be created.

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

    the optional parameters

Returns:

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

    TransactionResponseBody data, response status code and response headers



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 407

def create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_managed_transaction ...'
  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 MxPlatformApi.create_managed_transaction"
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.create_managed_transaction"
  end
  # verify the required parameter 'managed_transaction_create_request_body' is set
  if @api_client.config.client_side_validation && managed_transaction_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'managed_transaction_create_request_body' when calling MxPlatformApi.create_managed_transaction"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_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/vnd.mx.api.v1+json'])
  # 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(managed_transaction_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_managed_transaction",
    :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: MxPlatformApi#create_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_member(user_guid, member_create_request_body, opts = {}) ⇒ MemberResponseBody

Create member This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the ‘/institutions/institution_code/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.

Parameters:

  • user_guid (String) —

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

  • member_create_request_body (MemberCreateRequestBody) —

    Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)

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

    the optional parameters

Returns:



474
475
476
477
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 474

def create_member(user_guid, member_create_request_body, opts = {})
  data, _status_code, _headers = create_member_with_http_info(user_guid, member_create_request_body, opts)
  data
end

#create_member_with_http_info(user_guid, member_create_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Create member This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the &#x60;/institutions/institution_code/credentials&#x60; endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.

Parameters:

  • user_guid (String) —

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

  • member_create_request_body (MemberCreateRequestBody) —

    Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 485

def create_member_with_http_info(user_guid, member_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_member ...'
  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 MxPlatformApi.create_member"
  end
  # verify the required parameter 'member_create_request_body' is set
  if @api_client.config.client_side_validation && member_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'member_create_request_body' when calling MxPlatformApi.create_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members'.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/vnd.mx.api.v1+json'])
  # 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(member_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_member",
    :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: MxPlatformApi#create_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tag(user_guid, tag_create_request_body, opts = {}) ⇒ TagResponseBody

Create tag Use this endpoint to create a new custom tag.

Parameters:

  • user_guid (String) —

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

  • tag_create_request_body (TagCreateRequestBody) —

    Tag object to be created with required parameters (tag_guid)

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

    the optional parameters

Returns:



548
549
550
551
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 548

def create_tag(user_guid, tag_create_request_body, opts = {})
  data, _status_code, _headers = create_tag_with_http_info(user_guid, tag_create_request_body, opts)
  data
end

#create_tag_with_http_info(user_guid, tag_create_request_body, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>

Create tag Use this endpoint to create a new custom tag.

Parameters:

  • user_guid (String) —

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

  • tag_create_request_body (TagCreateRequestBody) —

    Tag object to be created with required parameters (tag_guid)

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

    the optional parameters

Returns:

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

    TagResponseBody data, response status code and response headers



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 559

def create_tag_with_http_info(user_guid, tag_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_tag ...'
  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 MxPlatformApi.create_tag"
  end
  # verify the required parameter 'tag_create_request_body' is set
  if @api_client.config.client_side_validation && tag_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'tag_create_request_body' when calling MxPlatformApi.create_tag"
  end
  # resource path
  local_var_path = '/users/{user_guid}/tags'.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/vnd.mx.api.v1+json'])
  # 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(tag_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_tag",
    :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: MxPlatformApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tagging(user_guid, tagging_create_request_body, opts = {}) ⇒ TaggingResponseBody

Create tagging Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.

Parameters:

  • user_guid (String) —

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

  • tagging_create_request_body (TaggingCreateRequestBody) —

    Tagging object to be created with required parameters (tag_guid and transaction_guid)

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

    the optional parameters

Returns:



622
623
624
625
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 622

def create_tagging(user_guid, tagging_create_request_body, opts = {})
  data, _status_code, _headers = create_tagging_with_http_info(user_guid, tagging_create_request_body, opts)
  data
end

#create_tagging_with_http_info(user_guid, tagging_create_request_body, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>

Create tagging Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.

Parameters:

  • user_guid (String) —

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

  • tagging_create_request_body (TaggingCreateRequestBody) —

    Tagging object to be created with required parameters (tag_guid and transaction_guid)

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

    the optional parameters

Returns:

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

    TaggingResponseBody data, response status code and response headers



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 633

def create_tagging_with_http_info(user_guid, tagging_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_tagging ...'
  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 MxPlatformApi.create_tagging"
  end
  # verify the required parameter 'tagging_create_request_body' is set
  if @api_client.config.client_side_validation && tagging_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'tagging_create_request_body' when calling MxPlatformApi.create_tagging"
  end
  # resource path
  local_var_path = '/users/{user_guid}/taggings'.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/vnd.mx.api.v1+json'])
  # 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(tagging_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_tagging",
    :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: MxPlatformApi#create_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_transaction_rule(user_guid, transaction_rule_create_request_body, opts = {}) ⇒ TransactionRuleResponseBody

Create transaction rule Use this endpoint to create a new transaction rule. The newly-created ‘transaction_rule` object will be returned if successful.

Parameters:

  • user_guid (String) —

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

  • transaction_rule_create_request_body (TransactionRuleCreateRequestBody) —

    TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)

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

    the optional parameters

Returns:



696
697
698
699
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 696

def create_transaction_rule(user_guid, transaction_rule_create_request_body, opts = {})
  data, _status_code, _headers = create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts)
  data
end

#create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>

Create transaction rule Use this endpoint to create a new transaction rule. The newly-created &#x60;transaction_rule&#x60; object will be returned if successful.

Parameters:

  • user_guid (String) —

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

  • transaction_rule_create_request_body (TransactionRuleCreateRequestBody) —

    TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)

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

    the optional parameters

Returns:

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

    TransactionRuleResponseBody data, response status code and response headers



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 707

def create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_transaction_rule ...'
  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 MxPlatformApi.create_transaction_rule"
  end
  # verify the required parameter 'transaction_rule_create_request_body' is set
  if @api_client.config.client_side_validation && transaction_rule_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_rule_create_request_body' when calling MxPlatformApi.create_transaction_rule"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transaction_rules'.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/vnd.mx.api.v1+json'])
  # 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(transaction_rule_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_transaction_rule",
    :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: MxPlatformApi#create_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_user(user_create_request_body, opts = {}) ⇒ UserResponseBody

Create user Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.

Parameters:

  • user_create_request_body (UserCreateRequestBody) —

    User object to be created. (None of these parameters are required, but the user object cannot be empty)

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

    the optional parameters

Returns:



769
770
771
772
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 769

def create_user(user_create_request_body, opts = {})
  data, _status_code, _headers = create_user_with_http_info(user_create_request_body, opts)
  data
end

#create_user_with_http_info(user_create_request_body, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>

Create user Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.

Parameters:

  • user_create_request_body (UserCreateRequestBody) —

    User object to be created. (None of these parameters are required, but the user object cannot be empty)

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

    the optional parameters

Returns:

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

    UserResponseBody data, response status code and response headers



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 779

def create_user_with_http_info(user_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_user ...'
  end
  # verify the required parameter 'user_create_request_body' is set
  if @api_client.config.client_side_validation && user_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'user_create_request_body' when calling MxPlatformApi.create_user"
  end
  # resource path
  local_var_path = '/users'

  # 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/vnd.mx.api.v1+json'])
  # 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(user_create_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.create_user",
    :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: MxPlatformApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_category(category_guid, user_guid, opts = {}) ⇒ nil

Delete category Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of ‘204 No Content`.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


838
839
840
841
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 838

def delete_category(category_guid, user_guid, opts = {})
  delete_category_with_http_info(category_guid, user_guid, opts)
  nil
end

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

Delete category Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of &#x60;204 No Content&#x60;.

Parameters:

  • category_guid (String) —

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

  • 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



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 849

def delete_category_with_http_info(category_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_category ...'
  end
  # verify the required parameter 'category_guid' is set
  if @api_client.config.client_side_validation && category_guid.nil?
    fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.delete_category"
  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 MxPlatformApi.delete_category"
  end
  # resource path
  local_var_path = '/users/{user_guid}/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_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 => :"MxPlatformApi.delete_category",
    :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: MxPlatformApi#delete_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_managed_account(member_guid, user_guid, account_guid, opts = {}) ⇒ nil

Delete managed account Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of ‘204 No Content`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

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

    the optional parameters

Returns:

  • (nil) 


906
907
908
909
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 906

def (member_guid, user_guid, , opts = {})
  (member_guid, user_guid, , opts)
  nil
end

#delete_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete managed account Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of &#x60;204 No Content&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 918

def (member_guid, user_guid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_managed_account ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_managed_account"
  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 MxPlatformApi.delete_managed_account"
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.delete_managed_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(.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 => :"MxPlatformApi.delete_managed_account",
    :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: MxPlatformApi#delete_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_managed_member(member_guid, user_guid, opts = {}) ⇒ nil

Delete managed member Use this endpoint to delete the specified partner-managed ‘member`. The endpoint will respond with a status of `204 No Content` without a resource.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


978
979
980
981
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 978

def delete_managed_member(member_guid, user_guid, opts = {})
  delete_managed_member_with_http_info(member_guid, user_guid, opts)
  nil
end

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

Delete managed member Use this endpoint to delete the specified partner-managed &#x60;member&#x60;. The endpoint will respond with a status of &#x60;204 No Content&#x60; without a resource.

Parameters:

  • member_guid (String) —

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

  • 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



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 989

def delete_managed_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_managed_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_managed_member"
  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 MxPlatformApi.delete_managed_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_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 => :"MxPlatformApi.delete_managed_member",
    :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: MxPlatformApi#delete_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) ⇒ nil

Delete managed transaction Use this endpoint to delete the specified partner-managed ‘transaction`. The endpoint will respond with a status of `204 No Content` without a resource.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • transaction_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


1046
1047
1048
1049
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1046

def delete_managed_transaction(member_guid, user_guid, transaction_guid, opts = {})
  delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts)
  nil
end

#delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete managed transaction Use this endpoint to delete the specified partner-managed &#x60;transaction&#x60;. The endpoint will respond with a status of &#x60;204 No Content&#x60; without a resource.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • transaction_guid (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1058

def delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_managed_transaction ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_managed_transaction"
  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 MxPlatformApi.delete_managed_transaction"
  end
  # verify the required parameter 'transaction_guid' is set
  if @api_client.config.client_side_validation && transaction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.delete_managed_transaction"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_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 => :"MxPlatformApi.delete_managed_transaction",
    :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: MxPlatformApi#delete_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_member(member_guid, user_guid, opts = {}) ⇒ nil

Delete member Accessing this endpoint will permanently delete a member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


1118
1119
1120
1121
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1118

def delete_member(member_guid, user_guid, opts = {})
  delete_member_with_http_info(member_guid, user_guid, opts)
  nil
end

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

Delete member Accessing this endpoint will permanently delete a member.

Parameters:

  • member_guid (String) —

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

  • 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



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1129

def delete_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.delete_member"
  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 MxPlatformApi.delete_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_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 => :"MxPlatformApi.delete_member",
    :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: MxPlatformApi#delete_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tag(tag_guid, user_guid, opts = {}) ⇒ nil

Delete tag Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of ‘204 No Content`.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


1185
1186
1187
1188
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1185

def delete_tag(tag_guid, user_guid, opts = {})
  delete_tag_with_http_info(tag_guid, user_guid, opts)
  nil
end

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

Delete tag Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of &#x60;204 No Content&#x60;.

Parameters:

  • tag_guid (String) —

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

  • 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



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1196

def delete_tag_with_http_info(tag_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_tag ...'
  end
  # verify the required parameter 'tag_guid' is set
  if @api_client.config.client_side_validation && tag_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.delete_tag"
  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 MxPlatformApi.delete_tag"
  end
  # resource path
  local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_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 => :"MxPlatformApi.delete_tag",
    :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: MxPlatformApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tagging(tagging_guid, user_guid, opts = {}) ⇒ nil

Delete tagging Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.

Parameters:

  • tagging_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


1252
1253
1254
1255
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1252

def delete_tagging(tagging_guid, user_guid, opts = {})
  delete_tagging_with_http_info(tagging_guid, user_guid, opts)
  nil
end

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

Delete tagging Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.

Parameters:

  • tagging_guid (String) —

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

  • 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



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1263

def delete_tagging_with_http_info(tagging_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_tagging ...'
  end
  # verify the required parameter 'tagging_guid' is set
  if @api_client.config.client_side_validation && tagging_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tagging_guid' when calling MxPlatformApi.delete_tagging"
  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 MxPlatformApi.delete_tagging"
  end
  # resource path
  local_var_path = '/users/{user_guid}/taggings/{tagging_guid}'.sub('{' + 'tagging_guid' + '}', CGI.escape(tagging_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 => :"MxPlatformApi.delete_tagging",
    :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: MxPlatformApi#delete_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_transaction_rule(transaction_rule_guid, user_guid, opts = {}) ⇒ nil

Delete transaction rule Use this endpoint to permanently delete a transaction rule based on its unique GUID.

Parameters:

  • transaction_rule_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


1319
1320
1321
1322
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1319

def delete_transaction_rule(transaction_rule_guid, user_guid, opts = {})
  delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts)
  nil
end

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

Delete transaction rule Use this endpoint to permanently delete a transaction rule based on its unique GUID.

Parameters:

  • transaction_rule_guid (String) —

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

  • 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



1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1330

def delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_transaction_rule ...'
  end
  # verify the required parameter 'transaction_rule_guid' is set
  if @api_client.config.client_side_validation && transaction_rule_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling MxPlatformApi.delete_transaction_rule"
  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 MxPlatformApi.delete_transaction_rule"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_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 => :"MxPlatformApi.delete_transaction_rule",
    :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: MxPlatformApi#delete_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user(user_guid, opts = {}) ⇒ nil

Delete user Use this endpoint to delete the specified ‘user`. The response will have a status of `204 No Content` without an object.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


1385
1386
1387
1388
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1385

def delete_user(user_guid, opts = {})
  delete_user_with_http_info(user_guid, opts)
  nil
end

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

Delete user Use this endpoint to delete the specified &#x60;user&#x60;. The response will have a status of &#x60;204 No Content&#x60; without an object.

Parameters:

  • 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



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1395

def delete_user_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_user ...'
  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 MxPlatformApi.delete_user"
  end
  # resource path
  local_var_path = '/users/{user_guid}'.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 => :"MxPlatformApi.delete_user",
    :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: MxPlatformApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_statement_pdf(member_guid, statement_guid, user_guid, opts = {}) ⇒ File

Download statement pdf Use this endpoint to download a specified statement PDF.

Parameters:

  • member_guid (String) —

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

  • statement_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

  • (File) 


1448
1449
1450
1451
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1448

def download_statement_pdf(member_guid, statement_guid, user_guid, opts = {})
  data, _status_code, _headers = download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts)
  data
end

#download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts = {}) ⇒ Array<(File, Integer, Hash)>

Download statement pdf Use this endpoint to download a specified statement PDF.

Parameters:

  • member_guid (String) —

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

  • statement_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1460

def download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.download_statement_pdf ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.download_statement_pdf"
  end
  # verify the required parameter 'statement_guid' is set
  if @api_client.config.client_side_validation && statement_guid.nil?
    fail ArgumentError, "Missing the required parameter 'statement_guid' when calling MxPlatformApi.download_statement_pdf"
  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 MxPlatformApi.download_statement_pdf"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'statement_guid' + '}', CGI.escape(statement_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+pdf'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.download_statement_pdf",
    :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: MxPlatformApi#download_statement_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enhance_transactions(enhance_transactions_request_body, opts = {}) ⇒ EnhanceTransactionsResponseBody

Enhance transactions Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

Parameters:

  • enhance_transactions_request_body (EnhanceTransactionsRequestBody) —

    Transaction object to be enhanced

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

    the optional parameters

Returns:



1521
1522
1523
1524
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1521

def enhance_transactions(enhance_transactions_request_body, opts = {})
  data, _status_code, _headers = enhance_transactions_with_http_info(enhance_transactions_request_body, opts)
  data
end

#enhance_transactions_with_http_info(enhance_transactions_request_body, opts = {}) ⇒ Array<(EnhanceTransactionsResponseBody, Integer, Hash)>

Enhance transactions Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

Parameters:

  • enhance_transactions_request_body (EnhanceTransactionsRequestBody) —

    Transaction object to be enhanced

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

    the optional parameters

Returns:



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1531

def enhance_transactions_with_http_info(enhance_transactions_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.enhance_transactions ...'
  end
  # verify the required parameter 'enhance_transactions_request_body' is set
  if @api_client.config.client_side_validation && enhance_transactions_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'enhance_transactions_request_body' when calling MxPlatformApi.enhance_transactions"
  end
  # resource path
  local_var_path = '/transactions/enhance'

  # 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/vnd.mx.api.v1+json'])
  # 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(enhance_transactions_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.enhance_transactions",
    :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: MxPlatformApi#enhance_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#extend_history(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Extend history Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.

Parameters:

  • member_guid (String) —

    The unique identifier for a &#x60;member&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Returns:



1590
1591
1592
1593
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1590

def extend_history(member_guid, user_guid, opts = {})
  data, _status_code, _headers = extend_history_with_http_info(member_guid, user_guid, opts)
  data
end

#extend_history_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Extend history Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.

Parameters:

  • member_guid (String) —

    The unique identifier for a &#x60;member&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1601

def extend_history_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.extend_history ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.extend_history"
  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 MxPlatformApi.extend_history"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/extend_history'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.extend_history",
    :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: MxPlatformApi#extend_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_statements(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Fetch statements Use this endpoint to fetch the statements associated with a particular member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



1659
1660
1661
1662
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1659

def fetch_statements(member_guid, user_guid, opts = {})
  data, _status_code, _headers = fetch_statements_with_http_info(member_guid, user_guid, opts)
  data
end

#fetch_statements_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Fetch statements Use this endpoint to fetch the statements associated with a particular member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1670

def fetch_statements_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.fetch_statements ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.fetch_statements"
  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 MxPlatformApi.fetch_statements"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/fetch_statements'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.fetch_statements",
    :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: MxPlatformApi#fetch_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identify_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Identify member The identify endpoint begins an identification process for an already-existing member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



1728
1729
1730
1731
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1728

def identify_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = identify_member_with_http_info(member_guid, user_guid, opts)
  data
end

#identify_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Identify member The identify endpoint begins an identification process for an already-existing member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1739

def identify_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.identify_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.identify_member"
  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 MxPlatformApi.identify_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/identify'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.identify_member",
    :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: MxPlatformApi#identify_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_numbers_by_account(account_guid, user_guid, opts = {}) ⇒ AccountNumbersResponseBody

List account numbers by account This endpoint returns a list of account numbers associated with the specified ‘account`.

Parameters:

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



1799
1800
1801
1802
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1799

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

#list_account_numbers_by_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(AccountNumbersResponseBody, Integer, Hash)>

List account numbers by account This endpoint returns a list of account numbers associated with the specified &#x60;account&#x60;.

Parameters:

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    AccountNumbersResponseBody data, response status code and response headers



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1812

def (, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_account_numbers_by_account ...'
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.list_account_numbers_by_account"
  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 MxPlatformApi.list_account_numbers_by_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/accounts/{account_guid}/account_numbers'.sub('{' + 'account_guid' + '}', CGI.escape(.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_account_numbers_by_account",
    :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: MxPlatformApi#list_account_numbers_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_numbers_by_member(member_guid, user_guid, opts = {}) ⇒ AccountNumbersResponseBody

List account numbers by member This endpoint returns a list of account numbers associated with the specified ‘member`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



1874
1875
1876
1877
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1874

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

#list_account_numbers_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(AccountNumbersResponseBody, Integer, Hash)>

List account numbers by member This endpoint returns a list of account numbers associated with the specified &#x60;member&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    AccountNumbersResponseBody data, response status code and response headers



1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1887

def (member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_account_numbers_by_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_account_numbers_by_member"
  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 MxPlatformApi.list_account_numbers_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/account_numbers'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_account_numbers_by_member",
    :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: MxPlatformApi#list_account_numbers_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_owners_by_member(member_guid, user_guid, opts = {}) ⇒ AccountOwnersResponseBody

List account owners by member This endpoint returns an array with information about every account associated with a particular member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



1949
1950
1951
1952
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1949

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

#list_account_owners_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(AccountOwnersResponseBody, Integer, Hash)>

List account owners by member This endpoint returns an array with information about every account associated with a particular member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    AccountOwnersResponseBody data, response status code and response headers



1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 1962

def (member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_account_owners_by_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_account_owners_by_member"
  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 MxPlatformApi.list_account_owners_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/account_owners'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_account_owners_by_member",
    :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: MxPlatformApi#list_account_owners_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_categories(user_guid, opts = {}) ⇒ CategoriesResponseBody

List categories Use this endpoint to list all categories associated with a ‘user`, including both default and custom categories.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2023
2024
2025
2026
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2023

def list_categories(user_guid, opts = {})
  data, _status_code, _headers = list_categories_with_http_info(user_guid, opts)
  data
end

#list_categories_with_http_info(user_guid, opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>

List categories Use this endpoint to list all categories associated with a &#x60;user&#x60;, including both default and custom categories.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    CategoriesResponseBody data, response status code and response headers



2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2035

def list_categories_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_categories ...'
  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 MxPlatformApi.list_categories"
  end
  # resource path
  local_var_path = '/users/{user_guid}/categories'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_categories",
    :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: MxPlatformApi#list_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_default_categories(opts = {}) ⇒ CategoriesResponseBody

List default categories Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its ‘is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2091
2092
2093
2094
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2091

def list_default_categories(opts = {})
  data, _status_code, _headers = list_default_categories_with_http_info(opts)
  data
end

#list_default_categories_by_user(user_guid, opts = {}) ⇒ CategoriesResponseBody

List default categories by user Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its ‘is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2155
2156
2157
2158
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2155

def list_default_categories_by_user(user_guid, opts = {})
  data, _status_code, _headers = list_default_categories_by_user_with_http_info(user_guid, opts)
  data
end

#list_default_categories_by_user_with_http_info(user_guid, opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>

List default categories by user Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its &#x60;is_default&#x60; field set to &#x60;true&#x60;. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    CategoriesResponseBody data, response status code and response headers



2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2167

def list_default_categories_by_user_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories_by_user ...'
  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 MxPlatformApi.list_default_categories_by_user"
  end
  # resource path
  local_var_path = '/users/{user_guid}/categories/default'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_default_categories_by_user",
    :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: MxPlatformApi#list_default_categories_by_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_default_categories_with_http_info(opts = {}) ⇒ Array<(CategoriesResponseBody, Integer, Hash)>

List default categories Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its &#x60;is_default&#x60; field set to &#x60;true&#x60;. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    CategoriesResponseBody data, response status code and response headers



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2102

def list_default_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories ...'
  end
  # resource path
  local_var_path = '/categories/default'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_default_categories",
    :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: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_favorite_institutions(opts = {}) ⇒ InstitutionsResponseBody

List favorite institutions This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2223
2224
2225
2226
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2223

def list_favorite_institutions(opts = {})
  data, _status_code, _headers = list_favorite_institutions_with_http_info(opts)
  data
end

#list_favorite_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>

List favorite institutions This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    InstitutionsResponseBody data, response status code and response headers



2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2234

def list_favorite_institutions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_favorite_institutions ...'
  end
  # resource path
  local_var_path = '/institutions/favorites'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_favorite_institutions",
    :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: MxPlatformApi#list_favorite_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_holdings(user_guid, opts = {}) ⇒ HoldingsResponseBody

List holdings This endpoint returns all holdings associated with the specified ‘user` across all accounts and members.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter holdings from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter holdings to this date.

Returns:



2289
2290
2291
2292
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2289

def list_holdings(user_guid, opts = {})
  data, _status_code, _headers = list_holdings_with_http_info(user_guid, opts)
  data
end

#list_holdings_by_member(member_guid, user_guid, opts = {}) ⇒ HoldingsResponseBody

List holdings by member This endpoint returns all holdings associated with the specified ‘member` across all accounts.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter holdings from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter holdings to this date.

Returns:



2365
2366
2367
2368
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2365

def list_holdings_by_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
  data
end

#list_holdings_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(HoldingsResponseBody, Integer, Hash)>

List holdings by member This endpoint returns all holdings associated with the specified &#x60;member&#x60; across all accounts.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter holdings from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter holdings to this date.

Returns:

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

    HoldingsResponseBody data, response status code and response headers



2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2380

def list_holdings_by_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_holdings_by_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_holdings_by_member"
  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 MxPlatformApi.list_holdings_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/holdings'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_holdings_by_member",
    :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: MxPlatformApi#list_holdings_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_holdings_with_http_info(user_guid, opts = {}) ⇒ Array<(HoldingsResponseBody, Integer, Hash)>

List holdings This endpoint returns all holdings associated with the specified &#x60;user&#x60; across all accounts and members.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter holdings from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter holdings to this date.

Returns:

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

    HoldingsResponseBody data, response status code and response headers



2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2303

def list_holdings_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_holdings ...'
  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 MxPlatformApi.list_holdings"
  end
  # resource path
  local_var_path = '/users/{user_guid}/holdings'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_holdings",
    :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: MxPlatformApi#list_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_institution_credentials(institution_code, opts = {}) ⇒ CredentialsResponseBody

List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.

Parameters:

  • institution_code (String) —

    The institution_code of the institution.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2443
2444
2445
2446
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2443

def list_institution_credentials(institution_code, opts = {})
  data, _status_code, _headers = list_institution_credentials_with_http_info(institution_code, opts)
  data
end

#list_institution_credentials_with_http_info(institution_code, opts = {}) ⇒ Array<(CredentialsResponseBody, Integer, Hash)>

List institution credentials Use this endpoint to see which credentials will be needed to create a member for a specific institution.

Parameters:

  • institution_code (String) —

    The institution_code of the institution.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    CredentialsResponseBody data, response status code and response headers



2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2455

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_institution_credentials",
    :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: MxPlatformApi#list_institution_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_institutions(opts = {}) ⇒ InstitutionsResponseBody

List institutions This endpoint returns a list of institutions based on the specified search term or parameter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    This will list only institutions in which the appended string appears.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :supports_account_identification (Boolean) —

    Filter only institutions which support account identification.

  • :supports_account_statement (Boolean) —

    Filter only institutions which support account statements.

  • :supports_account_verification (Boolean) —

    Filter only institutions which support account verification.

  • :supports_transaction_history (Boolean) —

    Filter only institutions which support extended transaction history.

Returns:



2516
2517
2518
2519
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2516

def list_institutions(opts = {})
  data, _status_code, _headers = list_institutions_with_http_info(opts)
  data
end

#list_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>

List institutions This endpoint returns a list of institutions based on the specified search term or parameter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    This will list only institutions in which the appended string appears.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :supports_account_identification (Boolean) —

    Filter only institutions which support account identification.

  • :supports_account_statement (Boolean) —

    Filter only institutions which support account statements.

  • :supports_account_verification (Boolean) —

    Filter only institutions which support account verification.

  • :supports_transaction_history (Boolean) —

    Filter only institutions which support extended transaction history.

Returns:

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

    InstitutionsResponseBody data, response status code and response headers



2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2532

def list_institutions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_institutions ...'
  end
  # resource path
  local_var_path = '/institutions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'supports_account_identification'] = opts[:'supports_account_identification'] if !opts[:'supports_account_identification'].nil?
  query_params[:'supports_account_statement'] = opts[:'supports_account_statement'] if !opts[:'supports_account_statement'].nil?
  query_params[:'supports_account_verification'] = opts[:'supports_account_verification'] if !opts[:'supports_account_verification'].nil?
  query_params[:'supports_transaction_history'] = opts[:'supports_transaction_history'] if !opts[:'supports_transaction_history'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_institutions",
    :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: MxPlatformApi#list_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_managed_accounts(user_guid, member_guid, opts = {}) ⇒ AccountsResponseBody

List managed accounts Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2591
2592
2593
2594
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2591

def list_managed_accounts(user_guid, member_guid, opts = {})
  data, _status_code, _headers = list_managed_accounts_with_http_info(user_guid, member_guid, opts)
  data
end

#list_managed_accounts_with_http_info(user_guid, member_guid, opts = {}) ⇒ Array<(AccountsResponseBody, Integer, Hash)>

List managed accounts Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    AccountsResponseBody data, response status code and response headers



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2604

def list_managed_accounts_with_http_info(user_guid, member_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_accounts ...'
  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 MxPlatformApi.list_managed_accounts"
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_managed_accounts"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_managed_accounts",
    :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: MxPlatformApi#list_managed_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_managed_institutions(opts = {}) ⇒ InstitutionsResponseBody

List managed institutions This endpoint returns a list of institutions which can be used to create partner-managed members.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2664
2665
2666
2667
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2664

def list_managed_institutions(opts = {})
  data, _status_code, _headers = list_managed_institutions_with_http_info(opts)
  data
end

#list_managed_institutions_with_http_info(opts = {}) ⇒ Array<(InstitutionsResponseBody, Integer, Hash)>

List managed institutions This endpoint returns a list of institutions which can be used to create partner-managed members.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    InstitutionsResponseBody data, response status code and response headers



2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2675

def list_managed_institutions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_institutions ...'
  end
  # resource path
  local_var_path = '/managed_institutions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_managed_institutions",
    :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: MxPlatformApi#list_managed_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_managed_members(user_guid, opts = {}) ⇒ MembersResponseBody

List managed members This endpoint returns a list of all the partner-managed members associated with the specified ‘user`.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2728
2729
2730
2731
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2728

def list_managed_members(user_guid, opts = {})
  data, _status_code, _headers = list_managed_members_with_http_info(user_guid, opts)
  data
end

#list_managed_members_with_http_info(user_guid, opts = {}) ⇒ Array<(MembersResponseBody, Integer, Hash)>

List managed members This endpoint returns a list of all the partner-managed members associated with the specified &#x60;user&#x60;.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    MembersResponseBody data, response status code and response headers



2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2740

def list_managed_members_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_members ...'
  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 MxPlatformApi.list_managed_members"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_managed_members",
    :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: MxPlatformApi#list_managed_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_managed_transactions(user_guid, member_guid, opts = {}) ⇒ TransactionsResponseBody

List managed transactions This endpoint returns a list of all the partner-managed transactions associated with the specified ‘account`, scoped through a `user` and a `member`.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2798
2799
2800
2801
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2798

def list_managed_transactions(user_guid, member_guid, opts = {})
  data, _status_code, _headers = list_managed_transactions_with_http_info(user_guid, member_guid, opts)
  data
end

#list_managed_transactions_with_http_info(user_guid, member_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>

List managed transactions This endpoint returns a list of all the partner-managed transactions associated with the specified &#x60;account&#x60;, scoped through a &#x60;user&#x60; and a &#x60;member&#x60;.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    TransactionsResponseBody data, response status code and response headers



2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2811

def list_managed_transactions_with_http_info(user_guid, member_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_managed_transactions ...'
  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 MxPlatformApi.list_managed_transactions"
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_managed_transactions"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_managed_transactions",
    :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: MxPlatformApi#list_managed_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_member_challenges(member_guid, user_guid, opts = {}) ⇒ ChallengesResponseBody

List member challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of ‘CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2873
2874
2875
2876
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2873

def list_member_challenges(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_challenges_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_challenges_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(ChallengesResponseBody, Integer, Hash)>

List member challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of &#x60;CHALLENGED&#x60;, then code &#x60;204 No Content&#x60; will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of &#x60;CHALLENGED&#x60;, then code &#x60;200 OK&#x60; will be returned - along with the corresponding credentials.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    ChallengesResponseBody data, response status code and response headers



2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2886

def list_member_challenges_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_member_challenges ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_member_challenges"
  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 MxPlatformApi.list_member_challenges"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/challenges'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_member_challenges",
    :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: MxPlatformApi#list_member_challenges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_member_credentials(member_guid, user_guid, opts = {}) ⇒ CredentialsResponseBody

List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



2948
2949
2950
2951
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2948

def list_member_credentials(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_credentials_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_credentials_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(CredentialsResponseBody, Integer, Hash)>

List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    CredentialsResponseBody data, response status code and response headers



2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 2961

def list_member_credentials_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_member_credentials ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_member_credentials"
  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 MxPlatformApi.list_member_credentials"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/credentials'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_member_credentials",
    :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: MxPlatformApi#list_member_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_members(user_guid, opts = {}) ⇒ MembersResponseBody

List members This endpoint returns an array which contains information on every member associated with a specific user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3022
3023
3024
3025
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3022

def list_members(user_guid, opts = {})
  data, _status_code, _headers = list_members_with_http_info(user_guid, opts)
  data
end

#list_members_with_http_info(user_guid, opts = {}) ⇒ Array<(MembersResponseBody, Integer, Hash)>

List members This endpoint returns an array which contains information on every member associated with a specific user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    MembersResponseBody data, response status code and response headers



3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3034

def list_members_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_members ...'
  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 MxPlatformApi.list_members"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_members",
    :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: MxPlatformApi#list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_merchants(opts = {}) ⇒ MerchantsResponseBody

List merchants This endpoint returns a paginated list of all the merchants in the MX system.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3090
3091
3092
3093
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3090

def list_merchants(opts = {})
  data, _status_code, _headers = list_merchants_with_http_info(opts)
  data
end

#list_merchants_with_http_info(opts = {}) ⇒ Array<(MerchantsResponseBody, Integer, Hash)>

List merchants This endpoint returns a paginated list of all the merchants in the MX system.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    MerchantsResponseBody data, response status code and response headers



3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3101

def list_merchants_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_merchants ...'
  end
  # resource path
  local_var_path = '/merchants'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_merchants",
    :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: MxPlatformApi#list_merchants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_statements_by_member(member_guid, user_guid, opts = {}) ⇒ StatementsResponseBody

List statements by member Use this endpoint to get an array of available statements.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3155
3156
3157
3158
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3155

def list_statements_by_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_statements_by_member_with_http_info(member_guid, user_guid, opts)
  data
end

#list_statements_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(StatementsResponseBody, Integer, Hash)>

List statements by member Use this endpoint to get an array of available statements.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    StatementsResponseBody data, response status code and response headers



3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3168

def list_statements_by_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_statements_by_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_statements_by_member"
  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 MxPlatformApi.list_statements_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/statements'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_statements_by_member",
    :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: MxPlatformApi#list_statements_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_taggings(user_guid, opts = {}) ⇒ TaggingsResponseBody

List taggings Use this endpoint to retrieve a list of all the taggings associated with a specific user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3229
3230
3231
3232
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3229

def list_taggings(user_guid, opts = {})
  data, _status_code, _headers = list_taggings_with_http_info(user_guid, opts)
  data
end

#list_taggings_with_http_info(user_guid, opts = {}) ⇒ Array<(TaggingsResponseBody, Integer, Hash)>

List taggings Use this endpoint to retrieve a list of all the taggings associated with a specific user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    TaggingsResponseBody data, response status code and response headers



3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3241

def list_taggings_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_taggings ...'
  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 MxPlatformApi.list_taggings"
  end
  # resource path
  local_var_path = '/users/{user_guid}/taggings'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_taggings",
    :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: MxPlatformApi#list_taggings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tags(user_guid, opts = {}) ⇒ TagsResponseBody

List tags Use this endpoint to list all tags associated with the specified ‘user`. Each user includes the `Business` tag by default.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3298
3299
3300
3301
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3298

def list_tags(user_guid, opts = {})
  data, _status_code, _headers = list_tags_with_http_info(user_guid, opts)
  data
end

#list_tags_with_http_info(user_guid, opts = {}) ⇒ Array<(TagsResponseBody, Integer, Hash)>

List tags Use this endpoint to list all tags associated with the specified &#x60;user&#x60;. Each user includes the &#x60;Business&#x60; tag by default.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    TagsResponseBody data, response status code and response headers



3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3310

def list_tags_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_tags ...'
  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 MxPlatformApi.list_tags"
  end
  # resource path
  local_var_path = '/users/{user_guid}/tags'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_tags",
    :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: MxPlatformApi#list_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transaction_rules(user_guid, opts = {}) ⇒ TransactionRulesResponseBody

List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3367
3368
3369
3370
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3367

def list_transaction_rules(user_guid, opts = {})
  data, _status_code, _headers = list_transaction_rules_with_http_info(user_guid, opts)
  data
end

#list_transaction_rules_with_http_info(user_guid, opts = {}) ⇒ Array<(TransactionRulesResponseBody, Integer, Hash)>

List transaction rules Use this endpoint to read the attributes of all existing transaction rules belonging to the user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3379

def list_transaction_rules_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transaction_rules ...'
  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 MxPlatformApi.list_transaction_rules"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transaction_rules'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_transaction_rules",
    :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: MxPlatformApi#list_transaction_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transactions(user_guid, opts = {}) ⇒ TransactionsResponseBody

List transactions Requests to this endpoint return a list of transactions associated with the specified ‘user`, accross all members and accounts associated with that `user`.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:



3438
3439
3440
3441
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3438

def list_transactions(user_guid, opts = {})
  data, _status_code, _headers = list_transactions_with_http_info(user_guid, opts)
  data
end

#list_transactions_by_account(account_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody

List transactions by account This endpoint returns a list of the last 90 days of transactions associated with the specified account.

Parameters:

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:



3514
3515
3516
3517
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3514

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

#list_transactions_by_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>

List transactions by account This endpoint returns a list of the last 90 days of transactions associated with the specified account.

Parameters:

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:

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

    TransactionsResponseBody data, response status code and response headers



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3529

def (, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions_by_account ...'
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.list_transactions_by_account"
  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 MxPlatformApi.list_transactions_by_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/accounts/{account_guid}/transactions'.sub('{' + 'account_guid' + '}', CGI.escape(.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_transactions_by_account",
    :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: MxPlatformApi#list_transactions_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transactions_by_member(member_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody

List transactions by member Requests to this endpoint return a list of transactions associated with the specified ‘member`, accross all accounts associated with that `member`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:



3595
3596
3597
3598
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3595

def list_transactions_by_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
  data
end

#list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>

List transactions by member Requests to this endpoint return a list of transactions associated with the specified &#x60;member&#x60;, accross all accounts associated with that &#x60;member&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:

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

    TransactionsResponseBody data, response status code and response headers



3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3610

def list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions_by_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_transactions_by_member"
  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 MxPlatformApi.list_transactions_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/transactions'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_transactions_by_member",
    :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: MxPlatformApi#list_transactions_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transactions_by_tag(tag_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody

List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:



3676
3677
3678
3679
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3676

def list_transactions_by_tag(tag_guid, user_guid, opts = {})
  data, _status_code, _headers = list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
  data
end

#list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>

List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:

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

    TransactionsResponseBody data, response status code and response headers



3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3691

def list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions_by_tag ...'
  end
  # verify the required parameter 'tag_guid' is set
  if @api_client.config.client_side_validation && tag_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.list_transactions_by_tag"
  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 MxPlatformApi.list_transactions_by_tag"
  end
  # resource path
  local_var_path = '/users/{user_guid}/tags/{tag_guid}/transactions'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_transactions_by_tag",
    :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: MxPlatformApi#list_transactions_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transactions_with_http_info(user_guid, opts = {}) ⇒ Array<(TransactionsResponseBody, Integer, Hash)>

List transactions Requests to this endpoint return a list of transactions associated with the specified &#x60;user&#x60;, accross all members and accounts associated with that &#x60;user&#x60;.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:

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

    TransactionsResponseBody data, response status code and response headers



3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3452

def list_transactions_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_transactions ...'
  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 MxPlatformApi.list_transactions"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_transactions",
    :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: MxPlatformApi#list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_accounts(user_guid, opts = {}) ⇒ AccountsResponseBody

List accounts This endpoint returns a list of all the accounts associated with the specified ‘user`.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3754
3755
3756
3757
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3754

def list_user_accounts(user_guid, opts = {})
  data, _status_code, _headers = list_user_accounts_with_http_info(user_guid, opts)
  data
end

#list_user_accounts_with_http_info(user_guid, opts = {}) ⇒ Array<(AccountsResponseBody, Integer, Hash)>

List accounts This endpoint returns a list of all the accounts associated with the specified &#x60;user&#x60;.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    AccountsResponseBody data, response status code and response headers



3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3766

def list_user_accounts_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_user_accounts ...'
  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 MxPlatformApi.list_user_accounts"
  end
  # resource path
  local_var_path = '/users/{user_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_user_accounts",
    :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: MxPlatformApi#list_user_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_users(opts = {}) ⇒ UsersResponseBody

List users Use this endpoint to list every user you’ve created in the MX Platform API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



3822
3823
3824
3825
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3822

def list_users(opts = {})
  data, _status_code, _headers = list_users_with_http_info(opts)
  data
end

#list_users_with_http_info(opts = {}) ⇒ Array<(UsersResponseBody, Integer, Hash)>

List users Use this endpoint to list every user you&#39;ve created in the MX Platform API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:

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

    UsersResponseBody data, response status code and response headers



3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3833

def list_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_users ...'
  end
  # resource path
  local_var_path = '/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.list_users",
    :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: MxPlatformApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_account(account_guid, user_guid, opts = {}) ⇒ AccountResponseBody

Read account This endpoint returns the specified ‘account` resource.

Parameters:

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Returns:



3885
3886
3887
3888
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3885

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

#read_account_with_http_info(account_guid, user_guid, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>

Read account This endpoint returns the specified &#x60;account&#x60; resource.

Parameters:

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    AccountResponseBody data, response status code and response headers



3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3896

def (, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_account ...'
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.read_account"
  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 MxPlatformApi.read_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/accounts/{account_guid}'.sub('{' + 'account_guid' + '}', CGI.escape(.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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_account",
    :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: MxPlatformApi#read_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_category(category_guid, user_guid, opts = {}) ⇒ CategoryResponseBody

Read a custom category Use this endpoint to read the attributes of either a default category or a custom category.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



3954
3955
3956
3957
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3954

def read_category(category_guid, user_guid, opts = {})
  data, _status_code, _headers = read_category_with_http_info(category_guid, user_guid, opts)
  data
end

#read_category_with_http_info(category_guid, user_guid, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>

Read a custom category Use this endpoint to read the attributes of either a default category or a custom category.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    CategoryResponseBody data, response status code and response headers



3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 3965

def read_category_with_http_info(category_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_category ...'
  end
  # verify the required parameter 'category_guid' is set
  if @api_client.config.client_side_validation && category_guid.nil?
    fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_category"
  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 MxPlatformApi.read_category"
  end
  # resource path
  local_var_path = '/users/{user_guid}/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_category",
    :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: MxPlatformApi#read_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_default_category(category_guid, user_guid, opts = {}) ⇒ CategoryResponseBody

Read a default category Use this endpoint to read the attributes of a default category.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4023
4024
4025
4026
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4023

def read_default_category(category_guid, user_guid, opts = {})
  data, _status_code, _headers = read_default_category_with_http_info(category_guid, user_guid, opts)
  data
end

#read_default_category_with_http_info(category_guid, user_guid, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>

Read a default category Use this endpoint to read the attributes of a default category.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    CategoryResponseBody data, response status code and response headers



4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4034

def read_default_category_with_http_info(category_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_default_category ...'
  end
  # verify the required parameter 'category_guid' is set
  if @api_client.config.client_side_validation && category_guid.nil?
    fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_default_category"
  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 MxPlatformApi.read_default_category"
  end
  # resource path
  local_var_path = '/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_default_category",
    :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: MxPlatformApi#read_default_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_holding(holding_guid, user_guid, opts = {}) ⇒ HoldingResponseBody

Read holding Use this endpoint to read the attributes of a specific ‘holding`.

Parameters:

  • holding_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4092
4093
4094
4095
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4092

def read_holding(holding_guid, user_guid, opts = {})
  data, _status_code, _headers = read_holding_with_http_info(holding_guid, user_guid, opts)
  data
end

#read_holding_with_http_info(holding_guid, user_guid, opts = {}) ⇒ Array<(HoldingResponseBody, Integer, Hash)>

Read holding Use this endpoint to read the attributes of a specific &#x60;holding&#x60;.

Parameters:

  • holding_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    HoldingResponseBody data, response status code and response headers



4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4103

def read_holding_with_http_info(holding_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_holding ...'
  end
  # verify the required parameter 'holding_guid' is set
  if @api_client.config.client_side_validation && holding_guid.nil?
    fail ArgumentError, "Missing the required parameter 'holding_guid' when calling MxPlatformApi.read_holding"
  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 MxPlatformApi.read_holding"
  end
  # resource path
  local_var_path = '/users/{user_guid}/holdings/{holding_guid}'.sub('{' + 'holding_guid' + '}', CGI.escape(holding_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_holding",
    :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: MxPlatformApi#read_holding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_institution(institution_code, opts = {}) ⇒ InstitutionResponseBody

Read institution This endpoint returns information about the institution specified by ‘institution_code`.

Parameters:

  • institution_code (String) —

    The institution_code of the institution.

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

    the optional parameters

Returns:



4160
4161
4162
4163
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4160

def read_institution(institution_code, opts = {})
  data, _status_code, _headers = read_institution_with_http_info(institution_code, opts)
  data
end

#read_institution_with_http_info(institution_code, opts = {}) ⇒ Array<(InstitutionResponseBody, Integer, Hash)>

Read institution This endpoint returns information about the institution specified by &#x60;institution_code&#x60;.

Parameters:

  • institution_code (String) —

    The institution_code of the institution.

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

    the optional parameters

Returns:

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

    InstitutionResponseBody data, response status code and response headers



4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4170

def read_institution_with_http_info(institution_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_institution ...'
  end
  # verify the required parameter 'institution_code' is set
  if @api_client.config.client_side_validation && institution_code.nil?
    fail ArgumentError, "Missing the required parameter 'institution_code' when calling MxPlatformApi.read_institution"
  end
  # resource path
  local_var_path = '/institutions/{institution_code}'.sub('{' + 'institution_code' + '}', CGI.escape(institution_code.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/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_institution",
    :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: MxPlatformApi#read_institution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_managed_account(member_guid, user_guid, account_guid, opts = {}) ⇒ AccountResponseBody

Read managed account Use this endpoint to read the attributes of a partner-managed account according to its unique guid.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

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

    the optional parameters

Returns:



4225
4226
4227
4228
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4225

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

#read_managed_account_with_http_info(member_guid, user_guid, account_guid, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>

Read managed account Use this endpoint to read the attributes of a partner-managed account according to its unique guid.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

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

    the optional parameters

Returns:

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

    AccountResponseBody data, response status code and response headers



4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4237

def (member_guid, user_guid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_managed_account ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_managed_account"
  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 MxPlatformApi.read_managed_account"
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.read_managed_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(.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/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_managed_account",
    :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: MxPlatformApi#read_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_managed_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Read managed member This endpoint returns the attributes of the specified partner-managed ‘member`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4299
4300
4301
4302
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4299

def read_managed_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = read_managed_member_with_http_info(member_guid, user_guid, opts)
  data
end

#read_managed_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Read managed member This endpoint returns the attributes of the specified partner-managed &#x60;member&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4310

def read_managed_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_managed_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_managed_member"
  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 MxPlatformApi.read_managed_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_managed_member",
    :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: MxPlatformApi#read_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_managed_transaction(member_guid, user_guid, transaction_guid, opts = {}) ⇒ TransactionResponseBody

Read managed transaction Requests to this endpoint will return the attributes of the specified partner-managed ‘transaction`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • transaction_guid (String) —

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

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

    the optional parameters

Returns:



4369
4370
4371
4372
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4369

def read_managed_transaction(member_guid, user_guid, transaction_guid, opts = {})
  data, _status_code, _headers = read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts)
  data
end

#read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>

Read managed transaction Requests to this endpoint will return the attributes of the specified partner-managed &#x60;transaction&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • transaction_guid (String) —

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

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

    the optional parameters

Returns:

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

    TransactionResponseBody data, response status code and response headers



4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4381

def read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_managed_transaction ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_managed_transaction"
  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 MxPlatformApi.read_managed_transaction"
  end
  # verify the required parameter 'transaction_guid' is set
  if @api_client.config.client_side_validation && transaction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.read_managed_transaction"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_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/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_managed_transaction",
    :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: MxPlatformApi#read_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Read member Use this endpoint to read the attributes of a specific member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4443
4444
4445
4446
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4443

def read_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = read_member_with_http_info(member_guid, user_guid, opts)
  data
end

#read_member_status(member_guid, user_guid, opts = {}) ⇒ MemberStatusResponseBody

Read member status This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4512
4513
4514
4515
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4512

def read_member_status(member_guid, user_guid, opts = {})
  data, _status_code, _headers = read_member_status_with_http_info(member_guid, user_guid, opts)
  data
end

#read_member_status_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberStatusResponseBody, Integer, Hash)>

Read member status This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberStatusResponseBody data, response status code and response headers



4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4523

def read_member_status_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_member_status ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_member_status"
  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 MxPlatformApi.read_member_status"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/status'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_member_status",
    :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: MxPlatformApi#read_member_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Read member Use this endpoint to read the attributes of a specific member.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4454

def read_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_member"
  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 MxPlatformApi.read_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_member",
    :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: MxPlatformApi#read_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_merchant(merchant_guid, opts = {}) ⇒ MerchantResponseBody

Read merchant Returns information about a particular merchant, such as a logo, name, and website.

Parameters:

  • merchant_guid (String) —

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

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

    the optional parameters

Returns:



4580
4581
4582
4583
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4580

def read_merchant(merchant_guid, opts = {})
  data, _status_code, _headers = read_merchant_with_http_info(merchant_guid, opts)
  data
end

#read_merchant_location(merchant_location_guid, opts = {}) ⇒ MerchantLocationResponseBody

Read merchant location This endpoint returns the specified merchant_location resource.

Parameters:

  • merchant_location_guid (String) —

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

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

    the optional parameters

Returns:



4643
4644
4645
4646
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4643

def read_merchant_location(merchant_location_guid, opts = {})
  data, _status_code, _headers = read_merchant_location_with_http_info(merchant_location_guid, opts)
  data
end

#read_merchant_location_with_http_info(merchant_location_guid, opts = {}) ⇒ Array<(MerchantLocationResponseBody, Integer, Hash)>

Read merchant location This endpoint returns the specified merchant_location resource.

Parameters:

  • merchant_location_guid (String) —

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

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

    the optional parameters

Returns:



4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4653

def read_merchant_location_with_http_info(merchant_location_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_merchant_location ...'
  end
  # verify the required parameter 'merchant_location_guid' is set
  if @api_client.config.client_side_validation && merchant_location_guid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_location_guid' when calling MxPlatformApi.read_merchant_location"
  end
  # resource path
  local_var_path = '/merchant_locations/{merchant_location_guid}'.sub('{' + 'merchant_location_guid' + '}', CGI.escape(merchant_location_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/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_merchant_location",
    :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: MxPlatformApi#read_merchant_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_merchant_with_http_info(merchant_guid, opts = {}) ⇒ Array<(MerchantResponseBody, Integer, Hash)>

Read merchant Returns information about a particular merchant, such as a logo, name, and website.

Parameters:

  • merchant_guid (String) —

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

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

    the optional parameters

Returns:

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

    MerchantResponseBody data, response status code and response headers



4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4590

def read_merchant_with_http_info(merchant_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_merchant ...'
  end
  # verify the required parameter 'merchant_guid' is set
  if @api_client.config.client_side_validation && merchant_guid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_guid' when calling MxPlatformApi.read_merchant"
  end
  # resource path
  local_var_path = '/merchants/{merchant_guid}'.sub('{' + 'merchant_guid' + '}', CGI.escape(merchant_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/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_merchant",
    :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: MxPlatformApi#read_merchant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_statement_by_member(member_guid, statement_guid, user_guid, opts = {}) ⇒ StatementResponseBody

Read statement by member Use this endpoint to read a JSON representation of the statement.

Parameters:

  • member_guid (String) —

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

  • statement_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4708
4709
4710
4711
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4708

def read_statement_by_member(member_guid, statement_guid, user_guid, opts = {})
  data, _status_code, _headers = read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts)
  data
end

#read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts = {}) ⇒ Array<(StatementResponseBody, Integer, Hash)>

Read statement by member Use this endpoint to read a JSON representation of the statement.

Parameters:

  • member_guid (String) —

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

  • statement_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    StatementResponseBody data, response status code and response headers



4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4720

def read_statement_by_member_with_http_info(member_guid, statement_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_statement_by_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_statement_by_member"
  end
  # verify the required parameter 'statement_guid' is set
  if @api_client.config.client_side_validation && statement_guid.nil?
    fail ArgumentError, "Missing the required parameter 'statement_guid' when calling MxPlatformApi.read_statement_by_member"
  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 MxPlatformApi.read_statement_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'statement_guid' + '}', CGI.escape(statement_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_statement_by_member",
    :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: MxPlatformApi#read_statement_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_tag(tag_guid, user_guid, opts = {}) ⇒ TagResponseBody

Read tag Use this endpoint to read the attributes of a particular tag according to its unique GUID.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4782
4783
4784
4785
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4782

def read_tag(tag_guid, user_guid, opts = {})
  data, _status_code, _headers = read_tag_with_http_info(tag_guid, user_guid, opts)
  data
end

#read_tag_with_http_info(tag_guid, user_guid, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>

Read tag Use this endpoint to read the attributes of a particular tag according to its unique GUID.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    TagResponseBody data, response status code and response headers



4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4793

def read_tag_with_http_info(tag_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_tag ...'
  end
  # verify the required parameter 'tag_guid' is set
  if @api_client.config.client_side_validation && tag_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.read_tag"
  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 MxPlatformApi.read_tag"
  end
  # resource path
  local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_tag",
    :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: MxPlatformApi#read_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_tagging(tagging_guid, user_guid, opts = {}) ⇒ TaggingResponseBody

Read tagging Use this endpoint to read the attributes of a ‘tagging` according to its unique GUID.

Parameters:

  • tagging_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4851
4852
4853
4854
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4851

def read_tagging(tagging_guid, user_guid, opts = {})
  data, _status_code, _headers = read_tagging_with_http_info(tagging_guid, user_guid, opts)
  data
end

#read_tagging_with_http_info(tagging_guid, user_guid, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>

Read tagging Use this endpoint to read the attributes of a &#x60;tagging&#x60; according to its unique GUID.

Parameters:

  • tagging_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    TaggingResponseBody data, response status code and response headers



4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4862

def read_tagging_with_http_info(tagging_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_tagging ...'
  end
  # verify the required parameter 'tagging_guid' is set
  if @api_client.config.client_side_validation && tagging_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tagging_guid' when calling MxPlatformApi.read_tagging"
  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 MxPlatformApi.read_tagging"
  end
  # resource path
  local_var_path = '/users/{user_guid}/taggings/{tagging_guid}'.sub('{' + 'tagging_guid' + '}', CGI.escape(tagging_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_tagging",
    :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: MxPlatformApi#read_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_transaction(transaction_guid, user_guid, opts = {}) ⇒ TransactionResponseBody

Read transaction Requests to this endpoint will return the attributes of the specified ‘transaction`.

Parameters:

  • transaction_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4920
4921
4922
4923
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4920

def read_transaction(transaction_guid, user_guid, opts = {})
  data, _status_code, _headers = read_transaction_with_http_info(transaction_guid, user_guid, opts)
  data
end

#read_transaction_rule(transaction_rule_guid, user_guid, opts = {}) ⇒ TransactionRuleResponseBody

Read transaction rule Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.

Parameters:

  • transaction_rule_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:



4989
4990
4991
4992
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4989

def read_transaction_rule(transaction_rule_guid, user_guid, opts = {})
  data, _status_code, _headers = read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts)
  data
end

#read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>

Read transaction rule Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.

Parameters:

  • transaction_rule_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    TransactionRuleResponseBody data, response status code and response headers



5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5000

def read_transaction_rule_with_http_info(transaction_rule_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_transaction_rule ...'
  end
  # verify the required parameter 'transaction_rule_guid' is set
  if @api_client.config.client_side_validation && transaction_rule_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling MxPlatformApi.read_transaction_rule"
  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 MxPlatformApi.read_transaction_rule"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_transaction_rule",
    :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: MxPlatformApi#read_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_transaction_with_http_info(transaction_guid, user_guid, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>

Read transaction Requests to this endpoint will return the attributes of the specified &#x60;transaction&#x60;.

Parameters:

  • transaction_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    TransactionResponseBody data, response status code and response headers



4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 4931

def read_transaction_with_http_info(transaction_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_transaction ...'
  end
  # verify the required parameter 'transaction_guid' is set
  if @api_client.config.client_side_validation && transaction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.read_transaction"
  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 MxPlatformApi.read_transaction"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_transaction",
    :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: MxPlatformApi#read_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_user(user_guid, opts = {}) ⇒ UserResponseBody

Read user Use this endpoint to read the attributes of a specific user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Returns:



5057
5058
5059
5060
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5057

def read_user(user_guid, opts = {})
  data, _status_code, _headers = read_user_with_http_info(user_guid, opts)
  data
end

#read_user_with_http_info(user_guid, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>

Read user Use this endpoint to read the attributes of a specific user.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Returns:

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

    UserResponseBody data, response status code and response headers



5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5067

def read_user_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_user ...'
  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 MxPlatformApi.read_user"
  end
  # resource path
  local_var_path = '/users/{user_guid}'.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/vnd.mx.api.v1+json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.read_user",
    :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: MxPlatformApi#read_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_connect_widget_url(user_guid, opts = {}) ⇒ ConnectWidgetResponseBody

Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :connect_widget_request_body (ConnectWidgetRequestBody) —

    Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)

Returns:



5121
5122
5123
5124
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5121

def request_connect_widget_url(user_guid, opts = {})
  data, _status_code, _headers = request_connect_widget_url_with_http_info(user_guid, opts)
  data
end

#request_connect_widget_url_with_http_info(user_guid, opts = {}) ⇒ Array<(ConnectWidgetResponseBody, Integer, Hash)>

Request connect widget url This endpoint will return a URL for an embeddable version of MX Connect.

Parameters:

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :connect_widget_request_body (ConnectWidgetRequestBody) —

    Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)

Returns:

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

    ConnectWidgetResponseBody data, response status code and response headers



5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5132

def request_connect_widget_url_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_connect_widget_url ...'
  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 MxPlatformApi.request_connect_widget_url"
  end
  # resource path
  local_var_path = '/users/{user_guid}/connect_widget_url'.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/vnd.mx.api.v1+json'])
  # 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[:'connect_widget_request_body'])

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.request_connect_widget_url",
    :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: MxPlatformApi#request_connect_widget_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_o_auth_window_uri(member_guid, user_guid, opts = {}) ⇒ OAuthWindowResponseBody

Request oauth window uri This endpoint will generate an ‘oauth_window_uri` for the specified `member`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :referral_source (String) —

    Must be either &#x60;BROWSER&#x60; or &#x60;APP&#x60; depending on the implementation. Defaults to &#x60;BROWSER&#x60;.

  • :ui_message_webview_url_scheme (String) —

    A scheme for routing the user back to the application state they were previously in.

  • :skip_aggregation (Boolean) —

    Setting this parameter to &#x60;true&#x60; will prevent the member from automatically aggregating after being redirected from the authorization page.

Returns:



5194
5195
5196
5197
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5194

def request_o_auth_window_uri(member_guid, user_guid, opts = {})
  data, _status_code, _headers = request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
  data
end

#request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(OAuthWindowResponseBody, Integer, Hash)>

Request oauth window uri This endpoint will generate an &#x60;oauth_window_uri&#x60; for the specified &#x60;member&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :referral_source (String) —

    Must be either &#x60;BROWSER&#x60; or &#x60;APP&#x60; depending on the implementation. Defaults to &#x60;BROWSER&#x60;.

  • :ui_message_webview_url_scheme (String) —

    A scheme for routing the user back to the application state they were previously in.

  • :skip_aggregation (Boolean) —

    Setting this parameter to &#x60;true&#x60; will prevent the member from automatically aggregating after being redirected from the authorization page.

Returns:

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

    OAuthWindowResponseBody data, response status code and response headers



5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5208

def request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_o_auth_window_uri ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.request_o_auth_window_uri"
  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 MxPlatformApi.request_o_auth_window_uri"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/oauth_window_uri'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'referral_source'] = opts[:'referral_source'] if !opts[:'referral_source'].nil?
  query_params[:'ui_message_webview_url_scheme'] = opts[:'ui_message_webview_url_scheme'] if !opts[:'ui_message_webview_url_scheme'].nil?
  query_params[:'skip_aggregation'] = opts[:'skip_aggregation'] if !opts[:'skip_aggregation'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.request_o_auth_window_uri",
    :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: MxPlatformApi#request_o_auth_window_uri\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_widget_url(user_guid, widget_request_body, opts = {}) ⇒ WidgetResponseBody

Request widget url This endpoint allows partners to get a URL by passing the ‘widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.

Parameters:

  • user_guid (String) —

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

  • widget_request_body (WidgetRequestBody) —

    The widget url configuration options.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The desired language of the widget.

Returns:



5270
5271
5272
5273
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5270

def request_widget_url(user_guid, widget_request_body, opts = {})
  data, _status_code, _headers = request_widget_url_with_http_info(user_guid, widget_request_body, opts)
  data
end

#request_widget_url_with_http_info(user_guid, widget_request_body, opts = {}) ⇒ Array<(WidgetResponseBody, Integer, Hash)>

Request widget url This endpoint allows partners to get a URL by passing the &#x60;widget_type&#x60; in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the &#x60;widget_type&#x60; to &#x60;connect_widget&#x60;. Partners may also pass an optional &#x60;Accept-Language&#x60; header as well as a number of configuration options. Note that this is a &#x60;POST&#x60; request.

Parameters:

  • user_guid (String) —

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

  • widget_request_body (WidgetRequestBody) —

    The widget url configuration options.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The desired language of the widget.

Returns:

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

    WidgetResponseBody data, response status code and response headers



5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5282

def request_widget_url_with_http_info(user_guid, widget_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_widget_url ...'
  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 MxPlatformApi.request_widget_url"
  end
  # verify the required parameter 'widget_request_body' is set
  if @api_client.config.client_side_validation && widget_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'widget_request_body' when calling MxPlatformApi.request_widget_url"
  end
  # resource path
  local_var_path = '/users/{user_guid}/widget_urls'.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/vnd.mx.api.v1+json'])
  # 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
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.request_widget_url",
    :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: MxPlatformApi#request_widget_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#resume_aggregation(member_guid, user_guid, member_resume_request_body, opts = {}) ⇒ MemberResponseBody

Resume aggregation This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • member_resume_request_body (MemberResumeRequestBody) —

    Member object with MFA challenge answers

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

    the optional parameters

Returns:



5347
5348
5349
5350
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5347

def resume_aggregation(member_guid, user_guid, member_resume_request_body, opts = {})
  data, _status_code, _headers = resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts)
  data
end

#resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Resume aggregation This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • member_resume_request_body (MemberResumeRequestBody) —

    Member object with MFA challenge answers

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5359

def resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.resume_aggregation ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.resume_aggregation"
  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 MxPlatformApi.resume_aggregation"
  end
  # verify the required parameter 'member_resume_request_body' is set
  if @api_client.config.client_side_validation && member_resume_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'member_resume_request_body' when calling MxPlatformApi.resume_aggregation"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/resume'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(member_resume_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.resume_aggregation",
    :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: MxPlatformApi#resume_aggregation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) ⇒ AccountResponseBody

Update account by member This endpoint allows you to update certain attributes of an ‘account` resource.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • account_update_request_body (AccountUpdateRequestBody) —

    Account object to be created with optional parameters (is_hidden)

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

    the optional parameters

Returns:



5428
5429
5430
5431
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5428

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

#update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>

Update account by member This endpoint allows you to update certain attributes of an &#x60;account&#x60; resource.

Parameters:

  • user_guid (String) —

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

  • member_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • account_update_request_body (AccountUpdateRequestBody) —

    Account object to be created with optional parameters (is_hidden)

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

    the optional parameters

Returns:

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

    AccountResponseBody data, response status code and response headers



5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5441

def (user_guid, member_guid, , , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_account_by_member ...'
  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 MxPlatformApi.update_account_by_member"
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_account_by_member"
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.update_account_by_member"
  end
  # verify the required parameter 'account_update_request_body' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_update_request_body' when calling MxPlatformApi.update_account_by_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/accounts/{account_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(.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/vnd.mx.api.v1+json'])
  # 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()

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_account_by_member",
    :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: MxPlatformApi#update_account_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_category(category_guid, user_guid, category_update_request_body, opts = {}) ⇒ CategoryResponseBody

Update category Use this endpoint to update the attributes of a custom category according to its unique GUID.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

  • category_update_request_body (CategoryUpdateRequestBody) —

    Category object to be updated (While no single parameter is required, the &#x60;category&#x60; object cannot be empty)

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

    the optional parameters

Returns:



5513
5514
5515
5516
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5513

def update_category(category_guid, user_guid, category_update_request_body, opts = {})
  data, _status_code, _headers = update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts)
  data
end

#update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts = {}) ⇒ Array<(CategoryResponseBody, Integer, Hash)>

Update category Use this endpoint to update the attributes of a custom category according to its unique GUID.

Parameters:

  • category_guid (String) —

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

  • user_guid (String) —

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

  • category_update_request_body (CategoryUpdateRequestBody) —

    Category object to be updated (While no single parameter is required, the &#x60;category&#x60; object cannot be empty)

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

    the optional parameters

Returns:

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

    CategoryResponseBody data, response status code and response headers



5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5525

def update_category_with_http_info(category_guid, user_guid, category_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_category ...'
  end
  # verify the required parameter 'category_guid' is set
  if @api_client.config.client_side_validation && category_guid.nil?
    fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.update_category"
  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 MxPlatformApi.update_category"
  end
  # verify the required parameter 'category_update_request_body' is set
  if @api_client.config.client_side_validation && category_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'category_update_request_body' when calling MxPlatformApi.update_category"
  end
  # resource path
  local_var_path = '/users/{user_guid}/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(category_update_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_category",
    :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: MxPlatformApi#update_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) ⇒ AccountResponseBody

Update managed account Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • managed_account_update_request_body (ManagedAccountUpdateRequestBody) —

    Managed account object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:



5594
5595
5596
5597
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5594

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

#update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body, opts = {}) ⇒ Array<(AccountResponseBody, Integer, Hash)>

Update managed account Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • account_guid (String) —

    The unique id for an &#x60;account&#x60;.

  • managed_account_update_request_body (ManagedAccountUpdateRequestBody) —

    Managed account object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:

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

    AccountResponseBody data, response status code and response headers



5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5607

def (member_guid, user_guid, , , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_managed_account ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_managed_account"
  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 MxPlatformApi.update_managed_account"
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.update_managed_account"
  end
  # verify the required parameter 'managed_account_update_request_body' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'managed_account_update_request_body' when calling MxPlatformApi.update_managed_account"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(.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/vnd.mx.api.v1+json'])
  # 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()

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_managed_account",
    :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: MxPlatformApi#update_managed_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_managed_member(member_guid, user_guid, managed_member_update_request_body, opts = {}) ⇒ MemberResponseBody

Update managed member Use this endpoint to update the attributes of the specified partner_managed ‘member`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • managed_member_update_request_body (ManagedMemberUpdateRequestBody) —

    Managed member object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:



5679
5680
5681
5682
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5679

def update_managed_member(member_guid, user_guid, managed_member_update_request_body, opts = {})
  data, _status_code, _headers = update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts)
  data
end

#update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Update managed member Use this endpoint to update the attributes of the specified partner_managed &#x60;member&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • managed_member_update_request_body (ManagedMemberUpdateRequestBody) —

    Managed member object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5691

def update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_managed_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_managed_member"
  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 MxPlatformApi.update_managed_member"
  end
  # verify the required parameter 'managed_member_update_request_body' is set
  if @api_client.config.client_side_validation && managed_member_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'managed_member_update_request_body' when calling MxPlatformApi.update_managed_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(managed_member_update_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_managed_member",
    :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: MxPlatformApi#update_managed_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) ⇒ TransactionResponseBody

Update managed transaction Use this endpoint to update the attributes of the specified partner_managed ‘transaction`.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • transaction_guid (String) —

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

  • managed_transaction_update_request_body (ManagedTransactionUpdateRequestBody) —

    Managed transaction object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:



5760
5761
5762
5763
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5760

def update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {})
  data, _status_code, _headers = update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts)
  data
end

#update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>

Update managed transaction Use this endpoint to update the attributes of the specified partner_managed &#x60;transaction&#x60;.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • transaction_guid (String) —

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

  • managed_transaction_update_request_body (ManagedTransactionUpdateRequestBody) —

    Managed transaction object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:

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

    TransactionResponseBody data, response status code and response headers



5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5773

def update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_managed_transaction ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_managed_transaction"
  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 MxPlatformApi.update_managed_transaction"
  end
  # verify the required parameter 'transaction_guid' is set
  if @api_client.config.client_side_validation && transaction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.update_managed_transaction"
  end
  # verify the required parameter 'managed_transaction_update_request_body' is set
  if @api_client.config.client_side_validation && managed_transaction_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'managed_transaction_update_request_body' when calling MxPlatformApi.update_managed_transaction"
  end
  # resource path
  local_var_path = '/users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_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/vnd.mx.api.v1+json'])
  # 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(managed_transaction_update_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_managed_transaction",
    :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: MxPlatformApi#update_managed_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_member(member_guid, user_guid, member_update_request_body, opts = {}) ⇒ MemberResponseBody

Update member Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • member_update_request_body (MemberUpdateRequestBody) —

    Member object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:



5845
5846
5847
5848
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5845

def update_member(member_guid, user_guid, member_update_request_body, opts = {})
  data, _status_code, _headers = update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts)
  data
end

#update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Update member Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.

Parameters:

  • member_guid (String) —

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

  • user_guid (String) —

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

  • member_update_request_body (MemberUpdateRequestBody) —

    Member object to be updated (While no single parameter is required, the request body can&#39;t be empty)

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

    the optional parameters

Returns:

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

    MemberResponseBody data, response status code and response headers



5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5857

def update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.update_member"
  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 MxPlatformApi.update_member"
  end
  # verify the required parameter 'member_update_request_body' is set
  if @api_client.config.client_side_validation && member_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'member_update_request_body' when calling MxPlatformApi.update_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(member_update_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_member",
    :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: MxPlatformApi#update_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tag(tag_guid, user_guid, tag_update_request_body, opts = {}) ⇒ TagResponseBody

Update tag Use this endpoint to update the name of a specific tag according to its unique GUID.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

  • tag_update_request_body (TagUpdateRequestBody) —

    Tag object to be updated with required parameter (tag_guid)

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

    the optional parameters

Returns:



5925
5926
5927
5928
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5925

def update_tag(tag_guid, user_guid, tag_update_request_body, opts = {})
  data, _status_code, _headers = update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts)
  data
end

#update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts = {}) ⇒ Array<(TagResponseBody, Integer, Hash)>

Update tag Use this endpoint to update the name of a specific tag according to its unique GUID.

Parameters:

  • tag_guid (String) —

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

  • user_guid (String) —

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

  • tag_update_request_body (TagUpdateRequestBody) —

    Tag object to be updated with required parameter (tag_guid)

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

    the optional parameters

Returns:

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

    TagResponseBody data, response status code and response headers



5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 5937

def update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_tag ...'
  end
  # verify the required parameter 'tag_guid' is set
  if @api_client.config.client_side_validation && tag_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tag_guid' when calling MxPlatformApi.update_tag"
  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 MxPlatformApi.update_tag"
  end
  # verify the required parameter 'tag_update_request_body' is set
  if @api_client.config.client_side_validation && tag_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'tag_update_request_body' when calling MxPlatformApi.update_tag"
  end
  # resource path
  local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(tag_update_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_tag",
    :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: MxPlatformApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tagging(tagging_guid, user_guid, tagging_update_request_body, opts = {}) ⇒ TaggingResponseBody

Update tagging Use this endpoint to update a tagging.

Parameters:

  • tagging_guid (String) —

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

  • user_guid (String) —

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

  • tagging_update_request_body (TaggingUpdateRequestBody) —

    Tagging object to be updated with required parameter (tag_guid)

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

    the optional parameters

Returns:



6005
6006
6007
6008
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6005

def update_tagging(tagging_guid, user_guid, tagging_update_request_body, opts = {})
  data, _status_code, _headers = update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts)
  data
end

#update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts = {}) ⇒ Array<(TaggingResponseBody, Integer, Hash)>

Update tagging Use this endpoint to update a tagging.

Parameters:

  • tagging_guid (String) —

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

  • user_guid (String) —

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

  • tagging_update_request_body (TaggingUpdateRequestBody) —

    Tagging object to be updated with required parameter (tag_guid)

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

    the optional parameters

Returns:

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

    TaggingResponseBody data, response status code and response headers



6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6017

def update_tagging_with_http_info(tagging_guid, user_guid, tagging_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_tagging ...'
  end
  # verify the required parameter 'tagging_guid' is set
  if @api_client.config.client_side_validation && tagging_guid.nil?
    fail ArgumentError, "Missing the required parameter 'tagging_guid' when calling MxPlatformApi.update_tagging"
  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 MxPlatformApi.update_tagging"
  end
  # verify the required parameter 'tagging_update_request_body' is set
  if @api_client.config.client_side_validation && tagging_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'tagging_update_request_body' when calling MxPlatformApi.update_tagging"
  end
  # resource path
  local_var_path = '/users/{user_guid}/taggings/{tagging_guid}'.sub('{' + 'tagging_guid' + '}', CGI.escape(tagging_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(tagging_update_request_body)

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

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

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_tagging",
    :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: MxPlatformApi#update_tagging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_transaction(transaction_guid, user_guid, transaction_update_request_body, opts = {}) ⇒ TransactionResponseBody

Update transaction Use this endpoint to update the ‘description` of a specific transaction according to its unique GUID.

Parameters:

  • transaction_guid (String) —

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

  • user_guid (String) —

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

  • transaction_update_request_body (TransactionUpdateRequestBody) —

    Transaction object to be updated with a new description

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

    the optional parameters

Returns:



6085
6086
6087
6088
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6085

def update_transaction(transaction_guid, user_guid, transaction_update_request_body, opts = {})
  data, _status_code, _headers = update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts)
  data
end

#update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) ⇒ TransactionRuleResponseBody

Update transaction_rule Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.

Parameters:

  • transaction_rule_guid (String) —

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

  • user_guid (String) —

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

  • transaction_rule_update_request_body (TransactionRuleUpdateRequestBody) —

    TransactionRule object to be updated

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

    the optional parameters

Returns:



6165
6166
6167
6168
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6165

def update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {})
  data, _status_code, _headers = update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts)
  data
end

#update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {}) ⇒ Array<(TransactionRuleResponseBody, Integer, Hash)>

Update transaction_rule Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.

Parameters:

  • transaction_rule_guid (String) —

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

  • user_guid (String) —

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

  • transaction_rule_update_request_body (TransactionRuleUpdateRequestBody) —

    TransactionRule object to be updated

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

    the optional parameters

Returns:

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

    TransactionRuleResponseBody data, response status code and response headers



6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6177

def update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_transaction_rule ...'
  end
  # verify the required parameter 'transaction_rule_guid' is set
  if @api_client.config.client_side_validation && transaction_rule_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_rule_guid' when calling MxPlatformApi.update_transaction_rule"
  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 MxPlatformApi.update_transaction_rule"
  end
  # verify the required parameter 'transaction_rule_update_request_body' is set
  if @api_client.config.client_side_validation && transaction_rule_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_rule_update_request_body' when calling MxPlatformApi.update_transaction_rule"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transaction_rules/{transaction_rule_guid}'.sub('{' + 'transaction_rule_guid' + '}', CGI.escape(transaction_rule_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(transaction_rule_update_request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionRuleResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_transaction_rule",
    :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: MxPlatformApi#update_transaction_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts = {}) ⇒ Array<(TransactionResponseBody, Integer, Hash)>

Update transaction Use this endpoint to update the &#x60;description&#x60; of a specific transaction according to its unique GUID.

Parameters:

  • transaction_guid (String) —

    The unique id for a &#x60;transaction&#x60;.

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

  • transaction_update_request_body (TransactionUpdateRequestBody) —

    Transaction object to be updated with a new description

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransactionResponseBody, Integer, Hash)>) —

    TransactionResponseBody data, response status code and response headers



6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6097

def update_transaction_with_http_info(transaction_guid, user_guid, transaction_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_transaction ...'
  end
  # verify the required parameter 'transaction_guid' is set
  if @api_client.config.client_side_validation && transaction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.update_transaction"
  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 MxPlatformApi.update_transaction"
  end
  # verify the required parameter 'transaction_update_request_body' is set
  if @api_client.config.client_side_validation && transaction_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_update_request_body' when calling MxPlatformApi.update_transaction"
  end
  # resource path
  local_var_path = '/users/{user_guid}/transactions/{transaction_guid}'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
  # 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(transaction_update_request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_transaction",
    :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: MxPlatformApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user(user_guid, user_update_request_body, opts = {}) ⇒ UserResponseBody

Update user Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.

Parameters:

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

  • user_update_request_body (UserUpdateRequestBody) —

    User object to be updated (None of these parameters are required, but the user object cannot be empty.)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6244
6245
6246
6247
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6244

def update_user(user_guid, user_update_request_body, opts = {})
  data, _status_code, _headers = update_user_with_http_info(user_guid, user_update_request_body, opts)
  data
end

#update_user_with_http_info(user_guid, user_update_request_body, opts = {}) ⇒ Array<(UserResponseBody, Integer, Hash)>

Update user Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.

Parameters:

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

  • user_update_request_body (UserUpdateRequestBody) —

    User object to be updated (None of these parameters are required, but the user object cannot be empty.)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UserResponseBody, Integer, Hash)>) —

    UserResponseBody data, response status code and response headers



6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6255

def update_user_with_http_info(user_guid, user_update_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_user ...'
  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 MxPlatformApi.update_user"
  end
  # verify the required parameter 'user_update_request_body' is set
  if @api_client.config.client_side_validation && user_update_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'user_update_request_body' when calling MxPlatformApi.update_user"
  end
  # resource path
  local_var_path = '/users/{user_guid}'.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/vnd.mx.api.v1+json'])
  # 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(user_update_request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'UserResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MxPlatformApi.update_user",
    :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: MxPlatformApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verify_member(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Verify member The verify endpoint begins a verification process for a member.

Parameters:

  • member_guid (String) —

    The unique id for a &#x60;member&#x60;.

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6318
6319
6320
6321
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6318

def verify_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = verify_member_with_http_info(member_guid, user_guid, opts)
  data
end

#verify_member_with_http_info(member_guid, user_guid, opts = {}) ⇒ Array<(MemberResponseBody, Integer, Hash)>

Verify member The verify endpoint begins a verification process for a member.

Parameters:

  • member_guid (String) —

    The unique id for a &#x60;member&#x60;.

  • user_guid (String) —

    The unique id for a &#x60;user&#x60;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MemberResponseBody, Integer, Hash)>) —

    MemberResponseBody data, response status code and response headers



6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
 
# File 'lib/mx-platform-ruby/api/mx_platform_api.rb', line 6329

def verify_member_with_http_info(member_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MxPlatformApi.verify_member ...'
  end
  # verify the required parameter 'member_guid' is set
  if @api_client.config.client_side_validation && member_guid.nil?
    fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.verify_member"
  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 MxPlatformApi.verify_member"
  end
  # resource path
  local_var_path = '/users/{user_guid}/members/{member_guid}/verify'.sub('{' + 'member_guid' + '}', CGI.escape(member_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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MemberResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"MxPlatformApi.verify_member",
    :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: MxPlatformApi#verify_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end