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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4eff14f0a51cfe9dbcb2e702c6c43413d9f42e053e159f00f7999ab14d34353c
|
4
|
+
data.tar.gz: f39ec4117371eb80dd70823f5a952ca748103dc4b17d027ec4f388788b69b1b2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a5fb07e26676d150e492d7d709acb83fea930e31f662486d641d68ba3f43663b51f1ddab3a6ff26225420c32450db3d9b762cdd8a5f1894d11cc9384dfa8ac00
|
7
|
+
data.tar.gz: 78d177ac61797a9866be291612ff2025fbd6e338f8363c73e92fff46326bdfc496cc84d25160c094da50e3c4263c745a94ef550b0ff832ea5598c2dd7b126b7d
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
mx-platform-ruby (0.
|
4
|
+
mx-platform-ruby (0.16.0)
|
5
5
|
faraday (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -37,8 +37,8 @@ GEM
|
|
37
37
|
jaro_winkler (1.5.4)
|
38
38
|
method_source (1.0.0)
|
39
39
|
multipart-post (2.3.0)
|
40
|
-
parallel (1.
|
41
|
-
parser (3.2.
|
40
|
+
parallel (1.23.0)
|
41
|
+
parser (3.2.2.1)
|
42
42
|
ast (~> 2.4.1)
|
43
43
|
pry (0.13.1)
|
44
44
|
coderay (~> 1.1)
|
@@ -54,12 +54,12 @@ GEM
|
|
54
54
|
rspec-core (~> 3.12.0)
|
55
55
|
rspec-expectations (~> 3.12.0)
|
56
56
|
rspec-mocks (~> 3.12.0)
|
57
|
-
rspec-core (3.12.
|
57
|
+
rspec-core (3.12.2)
|
58
58
|
rspec-support (~> 3.12.0)
|
59
|
-
rspec-expectations (3.12.
|
59
|
+
rspec-expectations (3.12.3)
|
60
60
|
diff-lcs (>= 1.2.0, < 2.0)
|
61
61
|
rspec-support (~> 3.12.0)
|
62
|
-
rspec-mocks (3.12.
|
62
|
+
rspec-mocks (3.12.5)
|
63
63
|
diff-lcs (>= 1.2.0, < 2.0)
|
64
64
|
rspec-support (~> 3.12.0)
|
65
65
|
rspec-support (3.12.0)
|
@@ -73,7 +73,7 @@ GEM
|
|
73
73
|
unicode-display_width (>= 1.4.0, < 1.6)
|
74
74
|
ruby-progressbar (1.13.0)
|
75
75
|
ruby2_keywords (0.0.5)
|
76
|
-
stringio (3.0.
|
76
|
+
stringio (3.0.6)
|
77
77
|
unicode-display_width (1.5.0)
|
78
78
|
|
79
79
|
PLATFORMS
|
@@ -87,4 +87,4 @@ DEPENDENCIES
|
|
87
87
|
rubocop (~> 0.66.0)
|
88
88
|
|
89
89
|
BUNDLED WITH
|
90
|
-
2.4.
|
90
|
+
2.4.12
|
@@ -20,7 +20,7 @@
|
|
20
20
|
require 'mx-platform-ruby'
|
21
21
|
|
22
22
|
instance = MxPlatformRuby::AccountNumberResponse.new(
|
23
|
-
account_guid: ACT-
|
23
|
+
account_guid: ACT-06d7f45b-caae-0f6e-1384-01f52e75dcb1,
|
24
24
|
account_number: 10001,
|
25
25
|
guid: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f,
|
26
26
|
institution_number: 123,
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::AuthorizationCodeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **scope** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::AuthorizationCodeRequest.new(
|
15
|
+
scope: user-guid:USR-101ad774-288b-44ed-ad16-da87d522ea20 member-guid:MBR-54feffb9-8474-47bd-8442-de003910113a account-guid:ACT-32a64160-582a-4f00-ab34-5f49cc35ed35 read-protected
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::AuthorizationCodeRequestBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **authorization_code** | [**AuthorizationCodeRequest**](AuthorizationCodeRequest.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::AuthorizationCodeRequestBody.new(
|
15
|
+
authorization_code: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::AuthorizationCodeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::AuthorizationCodeResponse.new(
|
15
|
+
code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MxPlatformRuby::AuthorizationCodeResponseBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **authorization_code** | [**Array<AuthorizationCodeResponse>**](AuthorizationCodeResponse.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mx-platform-ruby'
|
13
|
+
|
14
|
+
instance = MxPlatformRuby::AuthorizationCodeResponseBody.new(
|
15
|
+
authorization_code: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/MxPlatformApi.md
CHANGED
@@ -24,10 +24,13 @@ All URIs are relative to *https://api.mx.com*
|
|
24
24
|
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
|
25
25
|
| [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
|
26
26
|
| [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user |
|
27
|
+
| [**deprecated_request_payment_processor_authorization_code**](MxPlatformApi.md#deprecated_request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code. |
|
27
28
|
| [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf |
|
29
|
+
| [**download_tax_document**](MxPlatformApi.md#download_tax_document) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf | Download a Tax Document PDF |
|
28
30
|
| [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
|
29
31
|
| [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
|
30
32
|
| [**fetch_statements**](MxPlatformApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements |
|
33
|
+
| [**fetch_tax_documents**](MxPlatformApi.md#fetch_tax_documents) | **POST** /users/{user_guid}/members/{member_guid}/fetch_tax_documents | Fetch Tax Documents |
|
31
34
|
| [**identify_member**](MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member |
|
32
35
|
| [**list_account_numbers_by_account**](MxPlatformApi.md#list_account_numbers_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account |
|
33
36
|
| [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
|
@@ -53,6 +56,7 @@ All URIs are relative to *https://api.mx.com*
|
|
53
56
|
| [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
|
54
57
|
| [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings |
|
55
58
|
| [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags |
|
59
|
+
| [**list_tax_documents**](MxPlatformApi.md#list_tax_documents) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents | List Tax Documents |
|
56
60
|
| [**list_transaction_rules**](MxPlatformApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules |
|
57
61
|
| [**list_transactions**](MxPlatformApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions |
|
58
62
|
| [**list_transactions_by_account**](MxPlatformApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account |
|
@@ -76,9 +80,11 @@ All URIs are relative to *https://api.mx.com*
|
|
76
80
|
| [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
|
77
81
|
| [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
|
78
82
|
| [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging |
|
83
|
+
| [**read_tax_document**](MxPlatformApi.md#read_tax_document) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid} | Read a Tax Document |
|
79
84
|
| [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
|
80
85
|
| [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
|
81
86
|
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
|
87
|
+
| [**request_authorization_code**](MxPlatformApi.md#request_authorization_code) | **POST** /authorization_code | Request an authorization code. |
|
82
88
|
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
|
83
89
|
| [**request_o_auth_window_uri**](MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri |
|
84
90
|
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
|
@@ -1536,6 +1542,76 @@ nil (empty response body)
|
|
1536
1542
|
- **Accept**: Not defined
|
1537
1543
|
|
1538
1544
|
|
1545
|
+
## deprecated_request_payment_processor_authorization_code
|
1546
|
+
|
1547
|
+
> <PaymentProcessorAuthorizationCodeResponseBody> deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
1548
|
+
|
1549
|
+
(Deprecated) Request an authorization code.
|
1550
|
+
|
1551
|
+
(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.
|
1552
|
+
|
1553
|
+
### Examples
|
1554
|
+
|
1555
|
+
```ruby
|
1556
|
+
require 'time'
|
1557
|
+
require 'mx-platform-ruby'
|
1558
|
+
# setup authorization
|
1559
|
+
MxPlatformRuby.configure do |config|
|
1560
|
+
# Configure HTTP basic authorization: basicAuth
|
1561
|
+
config.username = 'YOUR USERNAME'
|
1562
|
+
config.password = 'YOUR PASSWORD'
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1566
|
+
payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code.
|
1567
|
+
|
1568
|
+
begin
|
1569
|
+
# (Deprecated) Request an authorization code.
|
1570
|
+
result = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
|
1571
|
+
p result
|
1572
|
+
rescue MxPlatformRuby::ApiError => e
|
1573
|
+
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: #{e}"
|
1574
|
+
end
|
1575
|
+
```
|
1576
|
+
|
1577
|
+
#### Using the deprecated_request_payment_processor_authorization_code_with_http_info variant
|
1578
|
+
|
1579
|
+
This returns an Array which contains the response data, status code and headers.
|
1580
|
+
|
1581
|
+
> <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
1582
|
+
|
1583
|
+
```ruby
|
1584
|
+
begin
|
1585
|
+
# (Deprecated) Request an authorization code.
|
1586
|
+
data, status_code, headers = api_instance.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
|
1587
|
+
p status_code # => 2xx
|
1588
|
+
p headers # => { ... }
|
1589
|
+
p data # => <PaymentProcessorAuthorizationCodeResponseBody>
|
1590
|
+
rescue MxPlatformRuby::ApiError => e
|
1591
|
+
puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code_with_http_info: #{e}"
|
1592
|
+
end
|
1593
|
+
```
|
1594
|
+
|
1595
|
+
### Parameters
|
1596
|
+
|
1597
|
+
| Name | Type | Description | Notes |
|
1598
|
+
| ---- | ---- | ----------- | ----- |
|
1599
|
+
| **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
|
1600
|
+
|
1601
|
+
### Return type
|
1602
|
+
|
1603
|
+
[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
|
1604
|
+
|
1605
|
+
### Authorization
|
1606
|
+
|
1607
|
+
[basicAuth](../README.md#basicAuth)
|
1608
|
+
|
1609
|
+
### HTTP request headers
|
1610
|
+
|
1611
|
+
- **Content-Type**: application/json
|
1612
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
1613
|
+
|
1614
|
+
|
1539
1615
|
## download_statement_pdf
|
1540
1616
|
|
1541
1617
|
> File download_statement_pdf(member_guid, statement_guid, user_guid)
|
@@ -1610,6 +1686,80 @@ end
|
|
1610
1686
|
- **Accept**: application/vnd.mx.api.v1+pdf
|
1611
1687
|
|
1612
1688
|
|
1689
|
+
## download_tax_document
|
1690
|
+
|
1691
|
+
> File download_tax_document(tax_document_guid, member_guid, user_guid)
|
1692
|
+
|
1693
|
+
Download a Tax Document PDF
|
1694
|
+
|
1695
|
+
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.
|
1696
|
+
|
1697
|
+
### Examples
|
1698
|
+
|
1699
|
+
```ruby
|
1700
|
+
require 'time'
|
1701
|
+
require 'mx-platform-ruby'
|
1702
|
+
# setup authorization
|
1703
|
+
MxPlatformRuby.configure do |config|
|
1704
|
+
# Configure HTTP basic authorization: basicAuth
|
1705
|
+
config.username = 'YOUR USERNAME'
|
1706
|
+
config.password = 'YOUR PASSWORD'
|
1707
|
+
end
|
1708
|
+
|
1709
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1710
|
+
tax_document_guid = 'TAX-987dfds1b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `tax_document`.
|
1711
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
1712
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1713
|
+
|
1714
|
+
begin
|
1715
|
+
# Download a Tax Document PDF
|
1716
|
+
result = api_instance.download_tax_document(tax_document_guid, member_guid, user_guid)
|
1717
|
+
p result
|
1718
|
+
rescue MxPlatformRuby::ApiError => e
|
1719
|
+
puts "Error when calling MxPlatformApi->download_tax_document: #{e}"
|
1720
|
+
end
|
1721
|
+
```
|
1722
|
+
|
1723
|
+
#### Using the download_tax_document_with_http_info variant
|
1724
|
+
|
1725
|
+
This returns an Array which contains the response data, status code and headers.
|
1726
|
+
|
1727
|
+
> <Array(File, Integer, Hash)> download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid)
|
1728
|
+
|
1729
|
+
```ruby
|
1730
|
+
begin
|
1731
|
+
# Download a Tax Document PDF
|
1732
|
+
data, status_code, headers = api_instance.download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid)
|
1733
|
+
p status_code # => 2xx
|
1734
|
+
p headers # => { ... }
|
1735
|
+
p data # => File
|
1736
|
+
rescue MxPlatformRuby::ApiError => e
|
1737
|
+
puts "Error when calling MxPlatformApi->download_tax_document_with_http_info: #{e}"
|
1738
|
+
end
|
1739
|
+
```
|
1740
|
+
|
1741
|
+
### Parameters
|
1742
|
+
|
1743
|
+
| Name | Type | Description | Notes |
|
1744
|
+
| ---- | ---- | ----------- | ----- |
|
1745
|
+
| **tax_document_guid** | **String** | The unique id for a `tax_document`. | |
|
1746
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
1747
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1748
|
+
|
1749
|
+
### Return type
|
1750
|
+
|
1751
|
+
**File**
|
1752
|
+
|
1753
|
+
### Authorization
|
1754
|
+
|
1755
|
+
[basicAuth](../README.md#basicAuth)
|
1756
|
+
|
1757
|
+
### HTTP request headers
|
1758
|
+
|
1759
|
+
- **Content-Type**: Not defined
|
1760
|
+
- **Accept**: application/vnd.mx.api.v1+pdf
|
1761
|
+
|
1762
|
+
|
1613
1763
|
## enhance_transactions
|
1614
1764
|
|
1615
1765
|
> <EnhanceTransactionsResponseBody> enhance_transactions(enhance_transactions_request_body)
|
@@ -1824,6 +1974,78 @@ end
|
|
1824
1974
|
- **Accept**: application/vnd.mx.api.v1+json
|
1825
1975
|
|
1826
1976
|
|
1977
|
+
## fetch_tax_documents
|
1978
|
+
|
1979
|
+
> <MemberResponseBody> fetch_tax_documents(member_guid, user_guid)
|
1980
|
+
|
1981
|
+
Fetch Tax Documents
|
1982
|
+
|
1983
|
+
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.
|
1984
|
+
|
1985
|
+
### Examples
|
1986
|
+
|
1987
|
+
```ruby
|
1988
|
+
require 'time'
|
1989
|
+
require 'mx-platform-ruby'
|
1990
|
+
# setup authorization
|
1991
|
+
MxPlatformRuby.configure do |config|
|
1992
|
+
# Configure HTTP basic authorization: basicAuth
|
1993
|
+
config.username = 'YOUR USERNAME'
|
1994
|
+
config.password = 'YOUR PASSWORD'
|
1995
|
+
end
|
1996
|
+
|
1997
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
1998
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
1999
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
2000
|
+
|
2001
|
+
begin
|
2002
|
+
# Fetch Tax Documents
|
2003
|
+
result = api_instance.fetch_tax_documents(member_guid, user_guid)
|
2004
|
+
p result
|
2005
|
+
rescue MxPlatformRuby::ApiError => e
|
2006
|
+
puts "Error when calling MxPlatformApi->fetch_tax_documents: #{e}"
|
2007
|
+
end
|
2008
|
+
```
|
2009
|
+
|
2010
|
+
#### Using the fetch_tax_documents_with_http_info variant
|
2011
|
+
|
2012
|
+
This returns an Array which contains the response data, status code and headers.
|
2013
|
+
|
2014
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> fetch_tax_documents_with_http_info(member_guid, user_guid)
|
2015
|
+
|
2016
|
+
```ruby
|
2017
|
+
begin
|
2018
|
+
# Fetch Tax Documents
|
2019
|
+
data, status_code, headers = api_instance.fetch_tax_documents_with_http_info(member_guid, user_guid)
|
2020
|
+
p status_code # => 2xx
|
2021
|
+
p headers # => { ... }
|
2022
|
+
p data # => <MemberResponseBody>
|
2023
|
+
rescue MxPlatformRuby::ApiError => e
|
2024
|
+
puts "Error when calling MxPlatformApi->fetch_tax_documents_with_http_info: #{e}"
|
2025
|
+
end
|
2026
|
+
```
|
2027
|
+
|
2028
|
+
### Parameters
|
2029
|
+
|
2030
|
+
| Name | Type | Description | Notes |
|
2031
|
+
| ---- | ---- | ----------- | ----- |
|
2032
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
2033
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
2034
|
+
|
2035
|
+
### Return type
|
2036
|
+
|
2037
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
2038
|
+
|
2039
|
+
### Authorization
|
2040
|
+
|
2041
|
+
[basicAuth](../README.md#basicAuth)
|
2042
|
+
|
2043
|
+
### HTTP request headers
|
2044
|
+
|
2045
|
+
- **Content-Type**: Not defined
|
2046
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
2047
|
+
|
2048
|
+
|
1827
2049
|
## identify_member
|
1828
2050
|
|
1829
2051
|
> <MemberResponseBody> identify_member(member_guid, user_guid)
|
@@ -3758,6 +3980,84 @@ end
|
|
3758
3980
|
- **Accept**: application/vnd.mx.api.v1+json
|
3759
3981
|
|
3760
3982
|
|
3983
|
+
## list_tax_documents
|
3984
|
+
|
3985
|
+
> <TaxDocumentsResponseBody> list_tax_documents(member_guid, user_guid, opts)
|
3986
|
+
|
3987
|
+
List Tax Documents
|
3988
|
+
|
3989
|
+
Use this endpoint to get a paginated list of tax documents.
|
3990
|
+
|
3991
|
+
### Examples
|
3992
|
+
|
3993
|
+
```ruby
|
3994
|
+
require 'time'
|
3995
|
+
require 'mx-platform-ruby'
|
3996
|
+
# setup authorization
|
3997
|
+
MxPlatformRuby.configure do |config|
|
3998
|
+
# Configure HTTP basic authorization: basicAuth
|
3999
|
+
config.username = 'YOUR USERNAME'
|
4000
|
+
config.password = 'YOUR PASSWORD'
|
4001
|
+
end
|
4002
|
+
|
4003
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
4004
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
4005
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
4006
|
+
opts = {
|
4007
|
+
page: 1, # Integer | Specify current page.
|
4008
|
+
records_per_page: 10 # Integer | Specify records per page.
|
4009
|
+
}
|
4010
|
+
|
4011
|
+
begin
|
4012
|
+
# List Tax Documents
|
4013
|
+
result = api_instance.list_tax_documents(member_guid, user_guid, opts)
|
4014
|
+
p result
|
4015
|
+
rescue MxPlatformRuby::ApiError => e
|
4016
|
+
puts "Error when calling MxPlatformApi->list_tax_documents: #{e}"
|
4017
|
+
end
|
4018
|
+
```
|
4019
|
+
|
4020
|
+
#### Using the list_tax_documents_with_http_info variant
|
4021
|
+
|
4022
|
+
This returns an Array which contains the response data, status code and headers.
|
4023
|
+
|
4024
|
+
> <Array(<TaxDocumentsResponseBody>, Integer, Hash)> list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
4025
|
+
|
4026
|
+
```ruby
|
4027
|
+
begin
|
4028
|
+
# List Tax Documents
|
4029
|
+
data, status_code, headers = api_instance.list_tax_documents_with_http_info(member_guid, user_guid, opts)
|
4030
|
+
p status_code # => 2xx
|
4031
|
+
p headers # => { ... }
|
4032
|
+
p data # => <TaxDocumentsResponseBody>
|
4033
|
+
rescue MxPlatformRuby::ApiError => e
|
4034
|
+
puts "Error when calling MxPlatformApi->list_tax_documents_with_http_info: #{e}"
|
4035
|
+
end
|
4036
|
+
```
|
4037
|
+
|
4038
|
+
### Parameters
|
4039
|
+
|
4040
|
+
| Name | Type | Description | Notes |
|
4041
|
+
| ---- | ---- | ----------- | ----- |
|
4042
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
4043
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
4044
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
4045
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
4046
|
+
|
4047
|
+
### Return type
|
4048
|
+
|
4049
|
+
[**TaxDocumentsResponseBody**](TaxDocumentsResponseBody.md)
|
4050
|
+
|
4051
|
+
### Authorization
|
4052
|
+
|
4053
|
+
[basicAuth](../README.md#basicAuth)
|
4054
|
+
|
4055
|
+
### HTTP request headers
|
4056
|
+
|
4057
|
+
- **Content-Type**: Not defined
|
4058
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
4059
|
+
|
4060
|
+
|
3761
4061
|
## list_transaction_rules
|
3762
4062
|
|
3763
4063
|
> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts)
|
@@ -5472,6 +5772,80 @@ end
|
|
5472
5772
|
- **Accept**: application/vnd.mx.api.v1+json
|
5473
5773
|
|
5474
5774
|
|
5775
|
+
## read_tax_document
|
5776
|
+
|
5777
|
+
> <TaxDocumentResponseBody> read_tax_document(tax_document_guid, member_guid, user_guid)
|
5778
|
+
|
5779
|
+
Read a Tax Document
|
5780
|
+
|
5781
|
+
Use this endpoint to read the attributes of the specified tax document.
|
5782
|
+
|
5783
|
+
### Examples
|
5784
|
+
|
5785
|
+
```ruby
|
5786
|
+
require 'time'
|
5787
|
+
require 'mx-platform-ruby'
|
5788
|
+
# setup authorization
|
5789
|
+
MxPlatformRuby.configure do |config|
|
5790
|
+
# Configure HTTP basic authorization: basicAuth
|
5791
|
+
config.username = 'YOUR USERNAME'
|
5792
|
+
config.password = 'YOUR PASSWORD'
|
5793
|
+
end
|
5794
|
+
|
5795
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5796
|
+
tax_document_guid = 'TAX-987dfds1b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `tax_document`.
|
5797
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5798
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5799
|
+
|
5800
|
+
begin
|
5801
|
+
# Read a Tax Document
|
5802
|
+
result = api_instance.read_tax_document(tax_document_guid, member_guid, user_guid)
|
5803
|
+
p result
|
5804
|
+
rescue MxPlatformRuby::ApiError => e
|
5805
|
+
puts "Error when calling MxPlatformApi->read_tax_document: #{e}"
|
5806
|
+
end
|
5807
|
+
```
|
5808
|
+
|
5809
|
+
#### Using the read_tax_document_with_http_info variant
|
5810
|
+
|
5811
|
+
This returns an Array which contains the response data, status code and headers.
|
5812
|
+
|
5813
|
+
> <Array(<TaxDocumentResponseBody>, Integer, Hash)> read_tax_document_with_http_info(tax_document_guid, member_guid, user_guid)
|
5814
|
+
|
5815
|
+
```ruby
|
5816
|
+
begin
|
5817
|
+
# Read a Tax Document
|
5818
|
+
data, status_code, headers = api_instance.read_tax_document_with_http_info(tax_document_guid, member_guid, user_guid)
|
5819
|
+
p status_code # => 2xx
|
5820
|
+
p headers # => { ... }
|
5821
|
+
p data # => <TaxDocumentResponseBody>
|
5822
|
+
rescue MxPlatformRuby::ApiError => e
|
5823
|
+
puts "Error when calling MxPlatformApi->read_tax_document_with_http_info: #{e}"
|
5824
|
+
end
|
5825
|
+
```
|
5826
|
+
|
5827
|
+
### Parameters
|
5828
|
+
|
5829
|
+
| Name | Type | Description | Notes |
|
5830
|
+
| ---- | ---- | ----------- | ----- |
|
5831
|
+
| **tax_document_guid** | **String** | The unique id for a `tax_document`. | |
|
5832
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
5833
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
5834
|
+
|
5835
|
+
### Return type
|
5836
|
+
|
5837
|
+
[**TaxDocumentResponseBody**](TaxDocumentResponseBody.md)
|
5838
|
+
|
5839
|
+
### Authorization
|
5840
|
+
|
5841
|
+
[basicAuth](../README.md#basicAuth)
|
5842
|
+
|
5843
|
+
### HTTP request headers
|
5844
|
+
|
5845
|
+
- **Content-Type**: Not defined
|
5846
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
5847
|
+
|
5848
|
+
|
5475
5849
|
## read_transaction
|
5476
5850
|
|
5477
5851
|
> <TransactionResponseBody> read_transaction(transaction_guid, user_guid)
|
@@ -5686,6 +6060,76 @@ end
|
|
5686
6060
|
- **Accept**: application/vnd.mx.api.v1+json
|
5687
6061
|
|
5688
6062
|
|
6063
|
+
## request_authorization_code
|
6064
|
+
|
6065
|
+
> <AuthorizationCodeResponseBody> request_authorization_code(authorization_code_request_body)
|
6066
|
+
|
6067
|
+
Request an authorization code.
|
6068
|
+
|
6069
|
+
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.
|
6070
|
+
|
6071
|
+
### Examples
|
6072
|
+
|
6073
|
+
```ruby
|
6074
|
+
require 'time'
|
6075
|
+
require 'mx-platform-ruby'
|
6076
|
+
# setup authorization
|
6077
|
+
MxPlatformRuby.configure do |config|
|
6078
|
+
# Configure HTTP basic authorization: basicAuth
|
6079
|
+
config.username = 'YOUR USERNAME'
|
6080
|
+
config.password = 'YOUR PASSWORD'
|
6081
|
+
end
|
6082
|
+
|
6083
|
+
api_instance = MxPlatformRuby::MxPlatformApi.new
|
6084
|
+
authorization_code_request_body = MxPlatformRuby::AuthorizationCodeRequestBody.new # AuthorizationCodeRequestBody | The scope for the authorization code.
|
6085
|
+
|
6086
|
+
begin
|
6087
|
+
# Request an authorization code.
|
6088
|
+
result = api_instance.request_authorization_code(authorization_code_request_body)
|
6089
|
+
p result
|
6090
|
+
rescue MxPlatformRuby::ApiError => e
|
6091
|
+
puts "Error when calling MxPlatformApi->request_authorization_code: #{e}"
|
6092
|
+
end
|
6093
|
+
```
|
6094
|
+
|
6095
|
+
#### Using the request_authorization_code_with_http_info variant
|
6096
|
+
|
6097
|
+
This returns an Array which contains the response data, status code and headers.
|
6098
|
+
|
6099
|
+
> <Array(<AuthorizationCodeResponseBody>, Integer, Hash)> request_authorization_code_with_http_info(authorization_code_request_body)
|
6100
|
+
|
6101
|
+
```ruby
|
6102
|
+
begin
|
6103
|
+
# Request an authorization code.
|
6104
|
+
data, status_code, headers = api_instance.request_authorization_code_with_http_info(authorization_code_request_body)
|
6105
|
+
p status_code # => 2xx
|
6106
|
+
p headers # => { ... }
|
6107
|
+
p data # => <AuthorizationCodeResponseBody>
|
6108
|
+
rescue MxPlatformRuby::ApiError => e
|
6109
|
+
puts "Error when calling MxPlatformApi->request_authorization_code_with_http_info: #{e}"
|
6110
|
+
end
|
6111
|
+
```
|
6112
|
+
|
6113
|
+
### Parameters
|
6114
|
+
|
6115
|
+
| Name | Type | Description | Notes |
|
6116
|
+
| ---- | ---- | ----------- | ----- |
|
6117
|
+
| **authorization_code_request_body** | [**AuthorizationCodeRequestBody**](AuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
|
6118
|
+
|
6119
|
+
### Return type
|
6120
|
+
|
6121
|
+
[**AuthorizationCodeResponseBody**](AuthorizationCodeResponseBody.md)
|
6122
|
+
|
6123
|
+
### Authorization
|
6124
|
+
|
6125
|
+
[basicAuth](../README.md#basicAuth)
|
6126
|
+
|
6127
|
+
### HTTP request headers
|
6128
|
+
|
6129
|
+
- **Content-Type**: application/json
|
6130
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
6131
|
+
|
6132
|
+
|
5689
6133
|
## request_connect_widget_url
|
5690
6134
|
|
5691
6135
|
> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_guid** | **String** | | [optional] |
|
8
|
+
| **member_guid** | **String** | | [optional] |
|
9
|
+
| **user_guid** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mx-platform-ruby'
|
15
|
+
|
16
|
+
instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest.new(
|
17
|
+
account_guid: ACT-4d4c0068-33bc-4d06-bbd6-cd270fd0135c,
|
18
|
+
member_guid: MBR-46637bc5-942d-4229-9370-ddd858bf805e,
|
19
|
+
user_guid: USR-f12b1f5a-7cbe-467c-aa30-0a10d0b2f549
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|