mx-platform-ruby 0.14.1 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +8 -8
- data/docs/AccountNumberResponse.md +1 -1
- data/docs/AuthorizationCodeRequest.md +18 -0
- data/docs/AuthorizationCodeRequestBody.md +18 -0
- data/docs/AuthorizationCodeResponse.md +18 -0
- data/docs/AuthorizationCodeResponseBody.md +18 -0
- data/docs/MxPlatformApi.md +444 -0
- data/docs/PaymentProcessorAuthorizationCodeRequest.md +22 -0
- data/docs/PaymentProcessorAuthorizationCodeRequestBody.md +18 -0
- data/docs/PaymentProcessorAuthorizationCodeResponse.md +18 -0
- data/docs/PaymentProcessorAuthorizationCodeResponseBody.md +18 -0
- data/docs/TaxDocumentResponse.md +36 -0
- data/docs/TaxDocumentResponseBody.md +18 -0
- data/docs/TaxDocumentsResponseBody.md +20 -0
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +430 -0
- data/lib/mx-platform-ruby/models/authorization_code_request.rb +219 -0
- data/lib/mx-platform-ruby/models/authorization_code_request_body.rb +218 -0
- data/lib/mx-platform-ruby/models/authorization_code_response.rb +219 -0
- data/lib/mx-platform-ruby/models/authorization_code_response_body.rb +220 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +239 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +218 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +219 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +218 -0
- data/lib/mx-platform-ruby/models/tax_document_response.rb +309 -0
- data/lib/mx-platform-ruby/models/tax_document_response_body.rb +218 -0
- data/lib/mx-platform-ruby/models/tax_documents_response_body.rb +229 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/lib/mx-platform-ruby.rb +11 -0
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +80 -0
- data/spec/models/authorization_code_request_body_spec.rb +34 -0
- data/spec/models/authorization_code_request_spec.rb +34 -0
- data/spec/models/authorization_code_response_body_spec.rb +34 -0
- data/spec/models/authorization_code_response_spec.rb +34 -0
- data/spec/models/payment_processor_authorization_code_request_body_spec.rb +34 -0
- data/spec/models/payment_processor_authorization_code_request_spec.rb +46 -0
- data/spec/models/payment_processor_authorization_code_response_body_spec.rb +34 -0
- data/spec/models/payment_processor_authorization_code_response_spec.rb +34 -0
- data/spec/models/tax_document_response_body_spec.rb +34 -0
- data/spec/models/tax_document_response_spec.rb +88 -0
- data/spec/models/tax_documents_response_body_spec.rb +40 -0
- metadata +133 -89
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeRequest**](PaymentProcessorAuthorizationCodeRequest.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new(
|
15
|
+
payment_processor_authorization_code: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **authorization_code** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse.new(
|
15
|
+
authorization_code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeResponse**](PaymentProcessorAuthorizationCodeResponse.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody.new(
|
15
|
+
payment_processor_authorization_code: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# MxPlatformRuby::TaxDocumentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **content_hash** | **String** | | [optional] |
|
8
|
+
| **created_at** | **String** | | [optional] |
|
9
|
+
| **document_type** | **String** | | [optional] |
|
10
|
+
| **guid** | **String** | | [optional] |
|
11
|
+
| **issued_on** | **String** | | [optional] |
|
12
|
+
| **member_guid** | **String** | | [optional] |
|
13
|
+
| **tax_year** | **String** | | [optional] |
|
14
|
+
| **updated_at** | **String** | | [optional] |
|
15
|
+
| **uri** | **String** | | [optional] |
|
16
|
+
| **user_guid** | **String** | | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'mx-platform-ruby'
|
22
|
+
|
23
|
+
instance = MxPlatformRuby::TaxDocumentResponse.new(
|
24
|
+
content_hash: a16c580c4fcdfa8088edaa7b4d35b290,
|
25
|
+
created_at: 2022-10-18T19:23:16Z,
|
26
|
+
document_type: TAX1099_C,
|
27
|
+
guid: TAX-ee8776ea-468b-4b02-b95d-743adf6ba50e,
|
28
|
+
issued_on: 2022-03-31,
|
29
|
+
member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
|
30
|
+
tax_year: 2023,
|
31
|
+
updated_at: 2022-10-18T19:23:16Z,
|
32
|
+
uri: /users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/tax_documents/TAX-ee8776ea-468b-4b02-b95d-743adf6ba50e.pdf,
|
33
|
+
user_guid: USR-11141024-90b3-1bce-cac9-c06ced52ab4c
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::TaxDocumentResponseBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **tax_document** | [**TaxDocumentResponse**](TaxDocumentResponse.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::TaxDocumentResponseBody.new(
|
15
|
+
tax_document: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MxPlatformRuby::TaxDocumentsResponseBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
|
8
|
+
| **tax_documents** | [**Array<TaxDocumentResponse>**](TaxDocumentResponse.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mx-platform-ruby'
|
14
|
+
|
15
|
+
instance = MxPlatformRuby::TaxDocumentsResponseBody.new(
|
16
|
+
pagination: null,
|
17
|
+
tax_documents: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -1450,6 +1450,74 @@ module MxPlatformRuby
|
|
1450
1450
|
return data, status_code, headers
|
1451
1451
|
end
|
1452
1452
|
|
1453
|
+
# (Deprecated) Request an authorization code.
|
1454
|
+
# (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
|
1455
|
+
# @param payment_processor_authorization_code_request_body [PaymentProcessorAuthorizationCodeRequestBody] The scope for the authorization code.
|
1456
|
+
# @param [Hash] opts the optional parameters
|
1457
|
+
# @return [PaymentProcessorAuthorizationCodeResponseBody]
|
1458
|
+
def deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body, opts = {})
|
1459
|
+
data, _status_code, _headers = deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, opts)
|
1460
|
+
data
|
1461
|
+
end
|
1462
|
+
|
1463
|
+
# (Deprecated) Request an authorization code.
|
1464
|
+
# (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
|
1465
|
+
# @param payment_processor_authorization_code_request_body [PaymentProcessorAuthorizationCodeRequestBody] The scope for the authorization code.
|
1466
|
+
# @param [Hash] opts the optional parameters
|
1467
|
+
# @return [Array<(PaymentProcessorAuthorizationCodeResponseBody, Integer, Hash)>] PaymentProcessorAuthorizationCodeResponseBody data, response status code and response headers
|
1468
|
+
def deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, opts = {})
|
1469
|
+
if @api_client.config.debugging
|
1470
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.deprecated_request_payment_processor_authorization_code ...'
|
1471
|
+
end
|
1472
|
+
# verify the required parameter 'payment_processor_authorization_code_request_body' is set
|
1473
|
+
if @api_client.config.client_side_validation && payment_processor_authorization_code_request_body.nil?
|
1474
|
+
fail ArgumentError, "Missing the required parameter 'payment_processor_authorization_code_request_body' when calling MxPlatformApi.deprecated_request_payment_processor_authorization_code"
|
1475
|
+
end
|
1476
|
+
# resource path
|
1477
|
+
local_var_path = '/payment_processor_authorization_code'
|
1478
|
+
|
1479
|
+
# query parameters
|
1480
|
+
query_params = opts[:query_params] || {}
|
1481
|
+
|
1482
|
+
# header parameters
|
1483
|
+
header_params = opts[:header_params] || {}
|
1484
|
+
# HTTP header 'Accept' (if needed)
|
1485
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
1486
|
+
# HTTP header 'Content-Type'
|
1487
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1488
|
+
if !content_type.nil?
|
1489
|
+
header_params['Content-Type'] = content_type
|
1490
|
+
end
|
1491
|
+
|
1492
|
+
# form parameters
|
1493
|
+
form_params = opts[:form_params] || {}
|
1494
|
+
|
1495
|
+
# http body (model)
|
1496
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_processor_authorization_code_request_body)
|
1497
|
+
|
1498
|
+
# return_type
|
1499
|
+
return_type = opts[:debug_return_type] || 'PaymentProcessorAuthorizationCodeResponseBody'
|
1500
|
+
|
1501
|
+
# auth_names
|
1502
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
1503
|
+
|
1504
|
+
new_options = opts.merge(
|
1505
|
+
:operation => :"MxPlatformApi.deprecated_request_payment_processor_authorization_code",
|
1506
|
+
:header_params => header_params,
|
1507
|
+
:query_params => query_params,
|
1508
|
+
:form_params => form_params,
|
1509
|
+
:body => post_body,
|
1510
|
+
:auth_names => auth_names,
|
1511
|
+
:return_type => return_type
|
1512
|
+
)
|
1513
|
+
|
1514
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1515
|
+
if @api_client.config.debugging
|
1516
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#deprecated_request_payment_processor_authorization_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1517
|
+
end
|
1518
|
+
return data, status_code, headers
|
1519
|
+
end
|
1520
|
+
|
1453
1521
|
# Download statement pdf
|
1454
1522
|
# Use this endpoint to download a specified statement PDF.
|
1455
1523
|
# @param member_guid [String] The unique id for a `member`.
|
@@ -1525,6 +1593,81 @@ module MxPlatformRuby
|
|
1525
1593
|
return data, status_code, headers
|
1526
1594
|
end
|
1527
1595
|
|
1596
|
+
# Download a Tax Document PDF
|
1597
|
+
# Use this endpoint to download a PDF version of the specified tax document. The endpoint URL is the base URL appended with the uri of the tax_document.
|
1598
|
+
# @param tax_document_guid [String] The unique id for a `tax_document`.
|
1599
|
+
# @param member_guid [String] The unique id for a `member`.
|
1600
|
+
# @param user_guid [String] The unique id for a `user`.
|
1601
|
+
# @param [Hash] opts the optional parameters
|
1602
|
+
# @return [File]
|
1603
|
+
def download_tax_document(tax_document_guid, member_guid, user_guid, opts = {})
|
1604
|
+
data, _status_code, _headers = download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, opts)
|
1605
|
+
data
|
1606
|
+
end
|
1607
|
+
|
1608
|
+
# Download a Tax Document PDF
|
1609
|
+
# Use this endpoint to download a PDF version of the specified tax document. The endpoint URL is the base URL appended with the uri of the tax_document.
|
1610
|
+
# @param tax_document_guid [String] The unique id for a `tax_document`.
|
1611
|
+
# @param member_guid [String] The unique id for a `member`.
|
1612
|
+
# @param user_guid [String] The unique id for a `user`.
|
1613
|
+
# @param [Hash] opts the optional parameters
|
1614
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1615
|
+
def download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, opts = {})
|
1616
|
+
if @api_client.config.debugging
|
1617
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.download_tax_document ...'
|
1618
|
+
end
|
1619
|
+
# verify the required parameter 'tax_document_guid' is set
|
1620
|
+
if @api_client.config.client_side_validation && tax_document_guid.nil?
|
1621
|
+
fail ArgumentError, "Missing the required parameter 'tax_document_guid' when calling MxPlatformApi.download_tax_document"
|
1622
|
+
end
|
1623
|
+
# verify the required parameter 'member_guid' is set
|
1624
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
1625
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.download_tax_document"
|
1626
|
+
end
|
1627
|
+
# verify the required parameter 'user_guid' is set
|
1628
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
1629
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.download_tax_document"
|
1630
|
+
end
|
1631
|
+
# resource path
|
1632
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf'.sub('{' + 'tax_document_guid' + '}', CGI.escape(tax_document_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
1633
|
+
|
1634
|
+
# query parameters
|
1635
|
+
query_params = opts[:query_params] || {}
|
1636
|
+
|
1637
|
+
# header parameters
|
1638
|
+
header_params = opts[:header_params] || {}
|
1639
|
+
# HTTP header 'Accept' (if needed)
|
1640
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+pdf'])
|
1641
|
+
|
1642
|
+
# form parameters
|
1643
|
+
form_params = opts[:form_params] || {}
|
1644
|
+
|
1645
|
+
# http body (model)
|
1646
|
+
post_body = opts[:debug_body]
|
1647
|
+
|
1648
|
+
# return_type
|
1649
|
+
return_type = opts[:debug_return_type] || 'File'
|
1650
|
+
|
1651
|
+
# auth_names
|
1652
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
1653
|
+
|
1654
|
+
new_options = opts.merge(
|
1655
|
+
:operation => :"MxPlatformApi.download_tax_document",
|
1656
|
+
:header_params => header_params,
|
1657
|
+
:query_params => query_params,
|
1658
|
+
:form_params => form_params,
|
1659
|
+
:body => post_body,
|
1660
|
+
:auth_names => auth_names,
|
1661
|
+
:return_type => return_type
|
1662
|
+
)
|
1663
|
+
|
1664
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1665
|
+
if @api_client.config.debugging
|
1666
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#download_tax_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1667
|
+
end
|
1668
|
+
return data, status_code, headers
|
1669
|
+
end
|
1670
|
+
|
1528
1671
|
# Enhance transactions
|
1529
1672
|
# Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.
|
1530
1673
|
# @param enhance_transactions_request_body [EnhanceTransactionsRequestBody] Transaction object to be enhanced
|
@@ -1731,6 +1874,75 @@ module MxPlatformRuby
|
|
1731
1874
|
return data, status_code, headers
|
1732
1875
|
end
|
1733
1876
|
|
1877
|
+
# Fetch Tax Documents
|
1878
|
+
# Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated data using the other document endpoints in this reference. This request may also trigger multi-factor authentication which requires end-user input and a specific process for answering authentication challenges.
|
1879
|
+
# @param member_guid [String] The unique id for a `member`.
|
1880
|
+
# @param user_guid [String] The unique id for a `user`.
|
1881
|
+
# @param [Hash] opts the optional parameters
|
1882
|
+
# @return [MemberResponseBody]
|
1883
|
+
def fetch_tax_documents(member_guid, user_guid, opts = {})
|
1884
|
+
data, _status_code, _headers = fetch_tax_documents_with_http_info(member_guid, user_guid, opts)
|
1885
|
+
data
|
1886
|
+
end
|
1887
|
+
|
1888
|
+
# Fetch Tax Documents
|
1889
|
+
# Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated data using the other document endpoints in this reference. This request may also trigger multi-factor authentication which requires end-user input and a specific process for answering authentication challenges.
|
1890
|
+
# @param member_guid [String] The unique id for a `member`.
|
1891
|
+
# @param user_guid [String] The unique id for a `user`.
|
1892
|
+
# @param [Hash] opts the optional parameters
|
1893
|
+
# @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
|
1894
|
+
def fetch_tax_documents_with_http_info(member_guid, user_guid, opts = {})
|
1895
|
+
if @api_client.config.debugging
|
1896
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.fetch_tax_documents ...'
|
1897
|
+
end
|
1898
|
+
# verify the required parameter 'member_guid' is set
|
1899
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
1900
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.fetch_tax_documents"
|
1901
|
+
end
|
1902
|
+
# verify the required parameter 'user_guid' is set
|
1903
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
1904
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.fetch_tax_documents"
|
1905
|
+
end
|
1906
|
+
# resource path
|
1907
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/fetch_tax_documents'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
1908
|
+
|
1909
|
+
# query parameters
|
1910
|
+
query_params = opts[:query_params] || {}
|
1911
|
+
|
1912
|
+
# header parameters
|
1913
|
+
header_params = opts[:header_params] || {}
|
1914
|
+
# HTTP header 'Accept' (if needed)
|
1915
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
1916
|
+
|
1917
|
+
# form parameters
|
1918
|
+
form_params = opts[:form_params] || {}
|
1919
|
+
|
1920
|
+
# http body (model)
|
1921
|
+
post_body = opts[:debug_body]
|
1922
|
+
|
1923
|
+
# return_type
|
1924
|
+
return_type = opts[:debug_return_type] || 'MemberResponseBody'
|
1925
|
+
|
1926
|
+
# auth_names
|
1927
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
1928
|
+
|
1929
|
+
new_options = opts.merge(
|
1930
|
+
:operation => :"MxPlatformApi.fetch_tax_documents",
|
1931
|
+
:header_params => header_params,
|
1932
|
+
:query_params => query_params,
|
1933
|
+
:form_params => form_params,
|
1934
|
+
:body => post_body,
|
1935
|
+
:auth_names => auth_names,
|
1936
|
+
:return_type => return_type
|
1937
|
+
)
|
1938
|
+
|
1939
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1940
|
+
if @api_client.config.debugging
|
1941
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#fetch_tax_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1942
|
+
end
|
1943
|
+
return data, status_code, headers
|
1944
|
+
end
|
1945
|
+
|
1734
1946
|
# Identify member
|
1735
1947
|
# The identify endpoint begins an identification process for an already-existing member.
|
1736
1948
|
# @param member_guid [String] The unique id for a `member`.
|
@@ -3534,6 +3746,81 @@ module MxPlatformRuby
|
|
3534
3746
|
return data, status_code, headers
|
3535
3747
|
end
|
3536
3748
|
|
3749
|
+
# List Tax Documents
|
3750
|
+
# Use this endpoint to get a paginated list of tax documents.
|
3751
|
+
# @param member_guid [String] The unique id for a `member`.
|
3752
|
+
# @param user_guid [String] The unique id for a `user`.
|
3753
|
+
# @param [Hash] opts the optional parameters
|
3754
|
+
# @option opts [Integer] :page Specify current page.
|
3755
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
3756
|
+
# @return [TaxDocumentsResponseBody]
|
3757
|
+
def list_tax_documents(member_guid, user_guid, opts = {})
|
3758
|
+
data, _status_code, _headers = list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
3759
|
+
data
|
3760
|
+
end
|
3761
|
+
|
3762
|
+
# List Tax Documents
|
3763
|
+
# Use this endpoint to get a paginated list of tax documents.
|
3764
|
+
# @param member_guid [String] The unique id for a `member`.
|
3765
|
+
# @param user_guid [String] The unique id for a `user`.
|
3766
|
+
# @param [Hash] opts the optional parameters
|
3767
|
+
# @option opts [Integer] :page Specify current page.
|
3768
|
+
# @option opts [Integer] :records_per_page Specify records per page.
|
3769
|
+
# @return [Array<(TaxDocumentsResponseBody, Integer, Hash)>] TaxDocumentsResponseBody data, response status code and response headers
|
3770
|
+
def list_tax_documents_with_http_info(member_guid, user_guid, opts = {})
|
3771
|
+
if @api_client.config.debugging
|
3772
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.list_tax_documents ...'
|
3773
|
+
end
|
3774
|
+
# verify the required parameter 'member_guid' is set
|
3775
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
3776
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.list_tax_documents"
|
3777
|
+
end
|
3778
|
+
# verify the required parameter 'user_guid' is set
|
3779
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
3780
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_tax_documents"
|
3781
|
+
end
|
3782
|
+
# resource path
|
3783
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/tax_documents'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
3784
|
+
|
3785
|
+
# query parameters
|
3786
|
+
query_params = opts[:query_params] || {}
|
3787
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
3788
|
+
query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
|
3789
|
+
|
3790
|
+
# header parameters
|
3791
|
+
header_params = opts[:header_params] || {}
|
3792
|
+
# HTTP header 'Accept' (if needed)
|
3793
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
3794
|
+
|
3795
|
+
# form parameters
|
3796
|
+
form_params = opts[:form_params] || {}
|
3797
|
+
|
3798
|
+
# http body (model)
|
3799
|
+
post_body = opts[:debug_body]
|
3800
|
+
|
3801
|
+
# return_type
|
3802
|
+
return_type = opts[:debug_return_type] || 'TaxDocumentsResponseBody'
|
3803
|
+
|
3804
|
+
# auth_names
|
3805
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
3806
|
+
|
3807
|
+
new_options = opts.merge(
|
3808
|
+
:operation => :"MxPlatformApi.list_tax_documents",
|
3809
|
+
:header_params => header_params,
|
3810
|
+
:query_params => query_params,
|
3811
|
+
:form_params => form_params,
|
3812
|
+
:body => post_body,
|
3813
|
+
:auth_names => auth_names,
|
3814
|
+
:return_type => return_type
|
3815
|
+
)
|
3816
|
+
|
3817
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3818
|
+
if @api_client.config.debugging
|
3819
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#list_tax_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3820
|
+
end
|
3821
|
+
return data, status_code, headers
|
3822
|
+
end
|
3823
|
+
|
3537
3824
|
# List transaction rules
|
3538
3825
|
# Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
|
3539
3826
|
# @param user_guid [String] The unique id for a `user`.
|
@@ -5175,6 +5462,81 @@ module MxPlatformRuby
|
|
5175
5462
|
return data, status_code, headers
|
5176
5463
|
end
|
5177
5464
|
|
5465
|
+
# Read a Tax Document
|
5466
|
+
# Use this endpoint to read the attributes of the specified tax document.
|
5467
|
+
# @param tax_document_guid [String] The unique id for a `tax_document`.
|
5468
|
+
# @param member_guid [String] The unique id for a `member`.
|
5469
|
+
# @param user_guid [String] The unique id for a `user`.
|
5470
|
+
# @param [Hash] opts the optional parameters
|
5471
|
+
# @return [TaxDocumentResponseBody]
|
5472
|
+
def read_tax_document(tax_document_guid, member_guid, user_guid, opts = {})
|
5473
|
+
data, _status_code, _headers = read_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, opts)
|
5474
|
+
data
|
5475
|
+
end
|
5476
|
+
|
5477
|
+
# Read a Tax Document
|
5478
|
+
# Use this endpoint to read the attributes of the specified tax document.
|
5479
|
+
# @param tax_document_guid [String] The unique id for a `tax_document`.
|
5480
|
+
# @param member_guid [String] The unique id for a `member`.
|
5481
|
+
# @param user_guid [String] The unique id for a `user`.
|
5482
|
+
# @param [Hash] opts the optional parameters
|
5483
|
+
# @return [Array<(TaxDocumentResponseBody, Integer, Hash)>] TaxDocumentResponseBody data, response status code and response headers
|
5484
|
+
def read_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, opts = {})
|
5485
|
+
if @api_client.config.debugging
|
5486
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.read_tax_document ...'
|
5487
|
+
end
|
5488
|
+
# verify the required parameter 'tax_document_guid' is set
|
5489
|
+
if @api_client.config.client_side_validation && tax_document_guid.nil?
|
5490
|
+
fail ArgumentError, "Missing the required parameter 'tax_document_guid' when calling MxPlatformApi.read_tax_document"
|
5491
|
+
end
|
5492
|
+
# verify the required parameter 'member_guid' is set
|
5493
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
5494
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling MxPlatformApi.read_tax_document"
|
5495
|
+
end
|
5496
|
+
# verify the required parameter 'user_guid' is set
|
5497
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
5498
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_tax_document"
|
5499
|
+
end
|
5500
|
+
# resource path
|
5501
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}'.sub('{' + 'tax_document_guid' + '}', CGI.escape(tax_document_guid.to_s)).sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
|
5502
|
+
|
5503
|
+
# query parameters
|
5504
|
+
query_params = opts[:query_params] || {}
|
5505
|
+
|
5506
|
+
# header parameters
|
5507
|
+
header_params = opts[:header_params] || {}
|
5508
|
+
# HTTP header 'Accept' (if needed)
|
5509
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
5510
|
+
|
5511
|
+
# form parameters
|
5512
|
+
form_params = opts[:form_params] || {}
|
5513
|
+
|
5514
|
+
# http body (model)
|
5515
|
+
post_body = opts[:debug_body]
|
5516
|
+
|
5517
|
+
# return_type
|
5518
|
+
return_type = opts[:debug_return_type] || 'TaxDocumentResponseBody'
|
5519
|
+
|
5520
|
+
# auth_names
|
5521
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
5522
|
+
|
5523
|
+
new_options = opts.merge(
|
5524
|
+
:operation => :"MxPlatformApi.read_tax_document",
|
5525
|
+
:header_params => header_params,
|
5526
|
+
:query_params => query_params,
|
5527
|
+
:form_params => form_params,
|
5528
|
+
:body => post_body,
|
5529
|
+
:auth_names => auth_names,
|
5530
|
+
:return_type => return_type
|
5531
|
+
)
|
5532
|
+
|
5533
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
5534
|
+
if @api_client.config.debugging
|
5535
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#read_tax_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5536
|
+
end
|
5537
|
+
return data, status_code, headers
|
5538
|
+
end
|
5539
|
+
|
5178
5540
|
# Read transaction
|
5179
5541
|
# Requests to this endpoint will return the attributes of the specified `transaction`.
|
5180
5542
|
# @param transaction_guid [String] The unique id for a `transaction`.
|
@@ -5376,6 +5738,74 @@ module MxPlatformRuby
|
|
5376
5738
|
return data, status_code, headers
|
5377
5739
|
end
|
5378
5740
|
|
5741
|
+
# Request an authorization code.
|
5742
|
+
# Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
|
5743
|
+
# @param authorization_code_request_body [AuthorizationCodeRequestBody] The scope for the authorization code.
|
5744
|
+
# @param [Hash] opts the optional parameters
|
5745
|
+
# @return [AuthorizationCodeResponseBody]
|
5746
|
+
def request_authorization_code(authorization_code_request_body, opts = {})
|
5747
|
+
data, _status_code, _headers = request_authorization_code_with_http_info(authorization_code_request_body, opts)
|
5748
|
+
data
|
5749
|
+
end
|
5750
|
+
|
5751
|
+
# Request an authorization code.
|
5752
|
+
# Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
|
5753
|
+
# @param authorization_code_request_body [AuthorizationCodeRequestBody] The scope for the authorization code.
|
5754
|
+
# @param [Hash] opts the optional parameters
|
5755
|
+
# @return [Array<(AuthorizationCodeResponseBody, Integer, Hash)>] AuthorizationCodeResponseBody data, response status code and response headers
|
5756
|
+
def request_authorization_code_with_http_info(authorization_code_request_body, opts = {})
|
5757
|
+
if @api_client.config.debugging
|
5758
|
+
@api_client.config.logger.debug 'Calling API: MxPlatformApi.request_authorization_code ...'
|
5759
|
+
end
|
5760
|
+
# verify the required parameter 'authorization_code_request_body' is set
|
5761
|
+
if @api_client.config.client_side_validation && authorization_code_request_body.nil?
|
5762
|
+
fail ArgumentError, "Missing the required parameter 'authorization_code_request_body' when calling MxPlatformApi.request_authorization_code"
|
5763
|
+
end
|
5764
|
+
# resource path
|
5765
|
+
local_var_path = '/authorization_code'
|
5766
|
+
|
5767
|
+
# query parameters
|
5768
|
+
query_params = opts[:query_params] || {}
|
5769
|
+
|
5770
|
+
# header parameters
|
5771
|
+
header_params = opts[:header_params] || {}
|
5772
|
+
# HTTP header 'Accept' (if needed)
|
5773
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
5774
|
+
# HTTP header 'Content-Type'
|
5775
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
5776
|
+
if !content_type.nil?
|
5777
|
+
header_params['Content-Type'] = content_type
|
5778
|
+
end
|
5779
|
+
|
5780
|
+
# form parameters
|
5781
|
+
form_params = opts[:form_params] || {}
|
5782
|
+
|
5783
|
+
# http body (model)
|
5784
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(authorization_code_request_body)
|
5785
|
+
|
5786
|
+
# return_type
|
5787
|
+
return_type = opts[:debug_return_type] || 'AuthorizationCodeResponseBody'
|
5788
|
+
|
5789
|
+
# auth_names
|
5790
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
5791
|
+
|
5792
|
+
new_options = opts.merge(
|
5793
|
+
:operation => :"MxPlatformApi.request_authorization_code",
|
5794
|
+
:header_params => header_params,
|
5795
|
+
:query_params => query_params,
|
5796
|
+
:form_params => form_params,
|
5797
|
+
:body => post_body,
|
5798
|
+
:auth_names => auth_names,
|
5799
|
+
:return_type => return_type
|
5800
|
+
)
|
5801
|
+
|
5802
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5803
|
+
if @api_client.config.debugging
|
5804
|
+
@api_client.config.logger.debug "API called: MxPlatformApi#request_authorization_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5805
|
+
end
|
5806
|
+
return data, status_code, headers
|
5807
|
+
end
|
5808
|
+
|
5379
5809
|
# Request connect widget url
|
5380
5810
|
# This endpoint will return a URL for an embeddable version of MX Connect.
|
5381
5811
|
# @param user_guid [String] The unique id for a `user`.
|