Skip to content

Commit 19e06fe

Browse files
author
devexperience
committed
Generated version 0.16.0
This pull request was automatically generated by a GitHub Action to generate version 0.16.0 of this library.
1 parent ef81ea7 commit 19e06fe

17 files changed

Lines changed: 1659 additions & 3 deletions

.openapi-generator/FILES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ docs/TaggingUpdateRequest.md
9797
docs/TaggingUpdateRequestBody.md
9898
docs/TaggingsResponseBody.md
9999
docs/TagsResponseBody.md
100+
docs/TaxDocumentResponse.md
101+
docs/TaxDocumentResponseBody.md
102+
docs/TaxDocumentsResponseBody.md
100103
docs/TransactionResponse.md
101104
docs/TransactionResponseBody.md
102105
docs/TransactionRuleCreateRequest.md
@@ -218,6 +221,9 @@ lib/mx-platform-ruby/models/tagging_update_request.rb
218221
lib/mx-platform-ruby/models/tagging_update_request_body.rb
219222
lib/mx-platform-ruby/models/taggings_response_body.rb
220223
lib/mx-platform-ruby/models/tags_response_body.rb
224+
lib/mx-platform-ruby/models/tax_document_response.rb
225+
lib/mx-platform-ruby/models/tax_document_response_body.rb
226+
lib/mx-platform-ruby/models/tax_documents_response_body.rb
221227
lib/mx-platform-ruby/models/transaction_response.rb
222228
lib/mx-platform-ruby/models/transaction_response_body.rb
223229
lib/mx-platform-ruby/models/transaction_rule_create_request.rb
@@ -339,6 +345,9 @@ spec/models/tagging_update_request_body_spec.rb
339345
spec/models/tagging_update_request_spec.rb
340346
spec/models/taggings_response_body_spec.rb
341347
spec/models/tags_response_body_spec.rb
348+
spec/models/tax_document_response_body_spec.rb
349+
spec/models/tax_document_response_spec.rb
350+
spec/models/tax_documents_response_body_spec.rb
342351
spec/models/transaction_response_body_spec.rb
343352
spec/models/transaction_response_spec.rb
344353
spec/models/transaction_rule_create_request_body_spec.rb

docs/AccountNumberResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
require 'mx-platform-ruby'
2121

2222
instance = MxPlatformRuby::AccountNumberResponse.new(
23-
account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
23+
account_guid: ACT-06d7f45b-caae-0f6e-1384-01f52e75dcb1,
2424
account_number: 10001,
2525
guid: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f,
2626
institution_number: 123,

docs/MxPlatformApi.md

Lines changed: 302 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ All URIs are relative to *https://api.mx.com*
2626
| [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user |
2727
| [**deprecated_request_payment_processor_authorization_code**](MxPlatformApi.md#deprecated_request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code. |
2828
| [**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 |
2930
| [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
3031
| [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
3132
| [**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 |
3234
| [**identify_member**](MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member |
3335
| [**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 |
3436
| [**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 |
@@ -54,6 +56,7 @@ All URIs are relative to *https://api.mx.com*
5456
| [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
5557
| [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings |
5658
| [**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 |
5760
| [**list_transaction_rules**](MxPlatformApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules |
5861
| [**list_transactions**](MxPlatformApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions |
5962
| [**list_transactions_by_account**](MxPlatformApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account |
@@ -77,6 +80,7 @@ All URIs are relative to *https://api.mx.com*
7780
| [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
7881
| [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
7982
| [**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 |
8084
| [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
8185
| [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
8286
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
@@ -1682,6 +1686,80 @@ end
16821686
- **Accept**: application/vnd.mx.api.v1+pdf
16831687

16841688

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 &#x60;tax_document&#x60;. | |
1746+
| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
1747+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
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+
16851763
## enhance_transactions
16861764

16871765
> <EnhanceTransactionsResponseBody> enhance_transactions(enhance_transactions_request_body)
@@ -1896,6 +1974,78 @@ end
18961974
- **Accept**: application/vnd.mx.api.v1+json
18971975

18981976

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 &#x60;member&#x60;. | |
2033+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
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+
18992049
## identify_member
19002050

19012051
> <MemberResponseBody> identify_member(member_guid, user_guid)
@@ -3830,6 +3980,84 @@ end
38303980
- **Accept**: application/vnd.mx.api.v1+json
38313981

38323982

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 &#x60;member&#x60;. | |
4043+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
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+
38334061
## list_transaction_rules
38344062

38354063
> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts)
@@ -5544,6 +5772,80 @@ end
55445772
- **Accept**: application/vnd.mx.api.v1+json
55455773

55465774

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 &#x60;tax_document&#x60;. | |
5832+
| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5833+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
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+
55475849
## read_transaction
55485850

55495851
> <TransactionResponseBody> read_transaction(transaction_guid, user_guid)

0 commit comments

Comments
 (0)