Skip to content

Commit 8ee57e6

Browse files
author
devexperience
committed
Generated version 0.13.0
This pull request was automatically generated by a GitHub Action to generate version 0.13.0 of this library.
1 parent 82c6164 commit 8ee57e6

18 files changed

Lines changed: 1870 additions & 6 deletions

‎.openapi-generator/FILES‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,9 @@ docs/TaggingUpdateRequest.md
9494
docs/TaggingUpdateRequestBody.md
9595
docs/TaggingsResponseBody.md
9696
docs/TagsResponseBody.md
97+
docs/TaxDocumentResponse.md
98+
docs/TaxDocumentResponseBody.md
99+
docs/TaxDocumentsResponseBody.md
97100
docs/TransactionResponse.md
98101
docs/TransactionResponseBody.md
99102
docs/TransactionRuleCreateRequest.md
@@ -229,6 +232,9 @@ src/main/java/com/mx/client/model/TaggingUpdateRequest.java
229232
src/main/java/com/mx/client/model/TaggingUpdateRequestBody.java
230233
src/main/java/com/mx/client/model/TaggingsResponseBody.java
231234
src/main/java/com/mx/client/model/TagsResponseBody.java
235+
src/main/java/com/mx/client/model/TaxDocumentResponse.java
236+
src/main/java/com/mx/client/model/TaxDocumentResponseBody.java
237+
src/main/java/com/mx/client/model/TaxDocumentsResponseBody.java
232238
src/main/java/com/mx/client/model/TransactionResponse.java
233239
src/main/java/com/mx/client/model/TransactionResponseBody.java
234240
src/main/java/com/mx/client/model/TransactionRuleCreateRequest.java
@@ -346,6 +352,9 @@ src/test/java/com/mx/client/model/TaggingUpdateRequestBodyTest.java
346352
src/test/java/com/mx/client/model/TaggingUpdateRequestTest.java
347353
src/test/java/com/mx/client/model/TaggingsResponseBodyTest.java
348354
src/test/java/com/mx/client/model/TagsResponseBodyTest.java
355+
src/test/java/com/mx/client/model/TaxDocumentResponseBodyTest.java
356+
src/test/java/com/mx/client/model/TaxDocumentResponseTest.java
357+
src/test/java/com/mx/client/model/TaxDocumentsResponseBodyTest.java
349358
src/test/java/com/mx/client/model/TransactionResponseBodyTest.java
350359
src/test/java/com/mx/client/model/TransactionResponseTest.java
351360
src/test/java/com/mx/client/model/TransactionRuleCreateRequestBodyTest.java

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ mvn clean package
2424
```
2525

2626
Then manually install the following JARs:
27-
- `target/mx-platform-java-0.12.0.jar`
27+
- `target/mx-platform-java-0.13.0.jar`
2828
- `target/lib/*.jar`
2929

3030
### Maven users
@@ -35,7 +35,7 @@ Add this dependency to your project's POM:
3535
<dependency>
3636
<groupId>com.mx</groupId>
3737
<artifactId>mx-platform-java</artifactId>
38-
<version>0.12.0</version>
38+
<version>0.13.0</version>
3939
<scope>compile</scope>
4040
</dependency>
4141
```

‎docs/MxPlatformApi.md‎

Lines changed: 292 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ Method | HTTP request | Description
2626
[**deleteUser**](MxPlatformApi.md#deleteUser) | **DELETE** /users/{user_guid} | Delete user
2727
[**deprecatedRequestPaymentProcessorAuthorizationCode**](MxPlatformApi.md#deprecatedRequestPaymentProcessorAuthorizationCode) | **POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code.
2828
[**downloadStatementPDF**](MxPlatformApi.md#downloadStatementPDF) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf
29+
[**downloadTaxDocument**](MxPlatformApi.md#downloadTaxDocument) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf | Download a Tax Document PDF
2930
[**enhanceTransactions**](MxPlatformApi.md#enhanceTransactions) | **POST** /transactions/enhance | Enhance transactions
3031
[**extendHistory**](MxPlatformApi.md#extendHistory) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
3132
[**fetchStatements**](MxPlatformApi.md#fetchStatements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
33+
[**fetchTaxDocuments**](MxPlatformApi.md#fetchTaxDocuments) | **POST** /users/{user_guid}/members/{member_guid}/fetch_tax_documents | Fetch Tax Documents
3234
[**identifyMember**](MxPlatformApi.md#identifyMember) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member
3335
[**listAccountNumbersByAccount**](MxPlatformApi.md#listAccountNumbersByAccount) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account
3436
[**listAccountNumbersByMember**](MxPlatformApi.md#listAccountNumbersByMember) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member
@@ -54,6 +56,7 @@ Method | HTTP request | Description
5456
[**listStatementsByMember**](MxPlatformApi.md#listStatementsByMember) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member
5557
[**listTaggings**](MxPlatformApi.md#listTaggings) | **GET** /users/{user_guid}/taggings | List taggings
5658
[**listTags**](MxPlatformApi.md#listTags) | **GET** /users/{user_guid}/tags | List tags
59+
[**listTaxDocuments**](MxPlatformApi.md#listTaxDocuments) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents | List Tax Documents
5760
[**listTransactionRules**](MxPlatformApi.md#listTransactionRules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules
5861
[**listTransactions**](MxPlatformApi.md#listTransactions) | **GET** /users/{user_guid}/transactions | List transactions
5962
[**listTransactionsByAccount**](MxPlatformApi.md#listTransactionsByAccount) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account
@@ -77,6 +80,7 @@ Method | HTTP request | Description
7780
[**readStatementByMember**](MxPlatformApi.md#readStatementByMember) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member
7881
[**readTag**](MxPlatformApi.md#readTag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag
7982
[**readTagging**](MxPlatformApi.md#readTagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging
83+
[**readTaxDocument**](MxPlatformApi.md#readTaxDocument) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid} | Read a Tax Document
8084
[**readTransaction**](MxPlatformApi.md#readTransaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction
8185
[**readTransactionRule**](MxPlatformApi.md#readTransactionRule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule
8286
[**readUser**](MxPlatformApi.md#readUser) | **GET** /users/{user_guid} | Read user
@@ -1638,6 +1642,78 @@ Name | Type | Description | Notes
16381642
|-------------|-------------|------------------|
16391643
**200** | OK | - |
16401644

1645+
<a name="downloadTaxDocument"></a>
1646+
# **downloadTaxDocument**
1647+
> File downloadTaxDocument(taxDocumentGuid, memberGuid, userGuid)
1648+
1649+
Download a Tax Document PDF
1650+
1651+
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.
1652+
1653+
### Example
1654+
```java
1655+
// Import classes:
1656+
import com.mx.client.ApiClient;
1657+
import com.mx.client.ApiException;
1658+
import com.mx.client.Configuration;
1659+
import com.mx.client.auth.*;
1660+
import com.mx.client.models.*;
1661+
import com.mx.client.mx_platform_api.MxPlatformApi;
1662+
1663+
public class Example {
1664+
public static void main(String[] args) {
1665+
ApiClient defaultClient = Configuration.getDefaultApiClient();
1666+
defaultClient.setBasePath("https://api.mx.com");
1667+
1668+
// Configure HTTP basic authorization: basicAuth
1669+
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
1670+
basicAuth.setUsername("YOUR USERNAME");
1671+
basicAuth.setPassword("YOUR PASSWORD");
1672+
1673+
MxPlatformApi apiInstance = new MxPlatformApi(defaultClient);
1674+
String taxDocumentGuid = "TAX-987dfds1b-e582-15b6-60c0-358f12466b4b"; // String | The unique id for a `tax_document`.
1675+
String memberGuid = "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"; // String | The unique id for a `member`.
1676+
String userGuid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54"; // String | The unique id for a `user`.
1677+
try {
1678+
File result = apiInstance.downloadTaxDocument(taxDocumentGuid, memberGuid, userGuid);
1679+
System.out.println(result);
1680+
} catch (ApiException e) {
1681+
System.err.println("Exception when calling MxPlatformApi#downloadTaxDocument");
1682+
System.err.println("Status code: " + e.getCode());
1683+
System.err.println("Reason: " + e.getResponseBody());
1684+
System.err.println("Response headers: " + e.getResponseHeaders());
1685+
e.printStackTrace();
1686+
}
1687+
}
1688+
}
1689+
```
1690+
1691+
### Parameters
1692+
1693+
Name | Type | Description | Notes
1694+
------------- | ------------- | ------------- | -------------
1695+
**taxDocumentGuid** | **String**| The unique id for a &#x60;tax_document&#x60;. |
1696+
**memberGuid** | **String**| The unique id for a &#x60;member&#x60;. |
1697+
**userGuid** | **String**| The unique id for a &#x60;user&#x60;. |
1698+
1699+
### Return type
1700+
1701+
[**File**](File.md)
1702+
1703+
### Authorization
1704+
1705+
[basicAuth](../README.md#basicAuth)
1706+
1707+
### HTTP request headers
1708+
1709+
- **Content-Type**: Not defined
1710+
- **Accept**: application/vnd.mx.api.v1+pdf
1711+
1712+
### HTTP response details
1713+
| Status code | Description | Response headers |
1714+
|-------------|-------------|------------------|
1715+
**200** | OK | - |
1716+
16411717
<a name="enhanceTransactions"></a>
16421718
# **enhanceTransactions**
16431719
> EnhanceTransactionsResponseBody enhanceTransactions(enhanceTransactionsRequestBody)
@@ -1846,6 +1922,76 @@ Name | Type | Description | Notes
18461922
|-------------|-------------|------------------|
18471923
**202** | Accepted | - |
18481924

1925+
<a name="fetchTaxDocuments"></a>
1926+
# **fetchTaxDocuments**
1927+
> MemberResponseBody fetchTaxDocuments(memberGuid, userGuid)
1928+
1929+
Fetch Tax Documents
1930+
1931+
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.
1932+
1933+
### Example
1934+
```java
1935+
// Import classes:
1936+
import com.mx.client.ApiClient;
1937+
import com.mx.client.ApiException;
1938+
import com.mx.client.Configuration;
1939+
import com.mx.client.auth.*;
1940+
import com.mx.client.models.*;
1941+
import com.mx.client.mx_platform_api.MxPlatformApi;
1942+
1943+
public class Example {
1944+
public static void main(String[] args) {
1945+
ApiClient defaultClient = Configuration.getDefaultApiClient();
1946+
defaultClient.setBasePath("https://api.mx.com");
1947+
1948+
// Configure HTTP basic authorization: basicAuth
1949+
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
1950+
basicAuth.setUsername("YOUR USERNAME");
1951+
basicAuth.setPassword("YOUR PASSWORD");
1952+
1953+
MxPlatformApi apiInstance = new MxPlatformApi(defaultClient);
1954+
String memberGuid = "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"; // String | The unique id for a `member`.
1955+
String userGuid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54"; // String | The unique id for a `user`.
1956+
try {
1957+
MemberResponseBody result = apiInstance.fetchTaxDocuments(memberGuid, userGuid);
1958+
System.out.println(result);
1959+
} catch (ApiException e) {
1960+
System.err.println("Exception when calling MxPlatformApi#fetchTaxDocuments");
1961+
System.err.println("Status code: " + e.getCode());
1962+
System.err.println("Reason: " + e.getResponseBody());
1963+
System.err.println("Response headers: " + e.getResponseHeaders());
1964+
e.printStackTrace();
1965+
}
1966+
}
1967+
}
1968+
```
1969+
1970+
### Parameters
1971+
1972+
Name | Type | Description | Notes
1973+
------------- | ------------- | ------------- | -------------
1974+
**memberGuid** | **String**| The unique id for a &#x60;member&#x60;. |
1975+
**userGuid** | **String**| The unique id for a &#x60;user&#x60;. |
1976+
1977+
### Return type
1978+
1979+
[**MemberResponseBody**](MemberResponseBody.md)
1980+
1981+
### Authorization
1982+
1983+
[basicAuth](../README.md#basicAuth)
1984+
1985+
### HTTP request headers
1986+
1987+
- **Content-Type**: Not defined
1988+
- **Accept**: application/vnd.mx.api.v1+json
1989+
1990+
### HTTP response details
1991+
| Status code | Description | Response headers |
1992+
|-------------|-------------|------------------|
1993+
**202** | Accepted | - |
1994+
18491995
<a name="identifyMember"></a>
18501996
# **identifyMember**
18511997
> MemberResponseBody identifyMember(memberGuid, userGuid)
@@ -3682,6 +3828,80 @@ Name | Type | Description | Notes
36823828
|-------------|-------------|------------------|
36833829
**200** | OK | - |
36843830

3831+
<a name="listTaxDocuments"></a>
3832+
# **listTaxDocuments**
3833+
> TaxDocumentsResponseBody listTaxDocuments(memberGuid, userGuid, page, recordsPerPage)
3834+
3835+
List Tax Documents
3836+
3837+
Use this endpoint to get a paginated list of tax documents.
3838+
3839+
### Example
3840+
```java
3841+
// Import classes:
3842+
import com.mx.client.ApiClient;
3843+
import com.mx.client.ApiException;
3844+
import com.mx.client.Configuration;
3845+
import com.mx.client.auth.*;
3846+
import com.mx.client.models.*;
3847+
import com.mx.client.mx_platform_api.MxPlatformApi;
3848+
3849+
public class Example {
3850+
public static void main(String[] args) {
3851+
ApiClient defaultClient = Configuration.getDefaultApiClient();
3852+
defaultClient.setBasePath("https://api.mx.com");
3853+
3854+
// Configure HTTP basic authorization: basicAuth
3855+
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
3856+
basicAuth.setUsername("YOUR USERNAME");
3857+
basicAuth.setPassword("YOUR PASSWORD");
3858+
3859+
MxPlatformApi apiInstance = new MxPlatformApi(defaultClient);
3860+
String memberGuid = "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"; // String | The unique id for a `member`.
3861+
String userGuid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54"; // String | The unique id for a `user`.
3862+
Integer page = 1; // Integer | Specify current page.
3863+
Integer recordsPerPage = 10; // Integer | Specify records per page.
3864+
try {
3865+
TaxDocumentsResponseBody result = apiInstance.listTaxDocuments(memberGuid, userGuid, page, recordsPerPage);
3866+
System.out.println(result);
3867+
} catch (ApiException e) {
3868+
System.err.println("Exception when calling MxPlatformApi#listTaxDocuments");
3869+
System.err.println("Status code: " + e.getCode());
3870+
System.err.println("Reason: " + e.getResponseBody());
3871+
System.err.println("Response headers: " + e.getResponseHeaders());
3872+
e.printStackTrace();
3873+
}
3874+
}
3875+
}
3876+
```
3877+
3878+
### Parameters
3879+
3880+
Name | Type | Description | Notes
3881+
------------- | ------------- | ------------- | -------------
3882+
**memberGuid** | **String**| The unique id for a &#x60;member&#x60;. |
3883+
**userGuid** | **String**| The unique id for a &#x60;user&#x60;. |
3884+
**page** | **Integer**| Specify current page. | [optional]
3885+
**recordsPerPage** | **Integer**| Specify records per page. | [optional]
3886+
3887+
### Return type
3888+
3889+
[**TaxDocumentsResponseBody**](TaxDocumentsResponseBody.md)
3890+
3891+
### Authorization
3892+
3893+
[basicAuth](../README.md#basicAuth)
3894+
3895+
### HTTP request headers
3896+
3897+
- **Content-Type**: Not defined
3898+
- **Accept**: application/vnd.mx.api.v1+json
3899+
3900+
### HTTP response details
3901+
| Status code | Description | Response headers |
3902+
|-------------|-------------|------------------|
3903+
**200** | OK | - |
3904+
36853905
<a name="listTransactionRules"></a>
36863906
# **listTransactionRules**
36873907
> TransactionRulesResponseBody listTransactionRules(userGuid, page, recordsPerPage)
@@ -5336,6 +5556,78 @@ Name | Type | Description | Notes
53365556
|-------------|-------------|------------------|
53375557
**200** | OK | - |
53385558

5559+
<a name="readTaxDocument"></a>
5560+
# **readTaxDocument**
5561+
> TaxDocumentResponseBody readTaxDocument(taxDocumentGuid, memberGuid, userGuid)
5562+
5563+
Read a Tax Document
5564+
5565+
Use this endpoint to read the attributes of the specified tax document.
5566+
5567+
### Example
5568+
```java
5569+
// Import classes:
5570+
import com.mx.client.ApiClient;
5571+
import com.mx.client.ApiException;
5572+
import com.mx.client.Configuration;
5573+
import com.mx.client.auth.*;
5574+
import com.mx.client.models.*;
5575+
import com.mx.client.mx_platform_api.MxPlatformApi;
5576+
5577+
public class Example {
5578+
public static void main(String[] args) {
5579+
ApiClient defaultClient = Configuration.getDefaultApiClient();
5580+
defaultClient.setBasePath("https://api.mx.com");
5581+
5582+
// Configure HTTP basic authorization: basicAuth
5583+
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
5584+
basicAuth.setUsername("YOUR USERNAME");
5585+
basicAuth.setPassword("YOUR PASSWORD");
5586+
5587+
MxPlatformApi apiInstance = new MxPlatformApi(defaultClient);
5588+
String taxDocumentGuid = "TAX-987dfds1b-e582-15b6-60c0-358f12466b4b"; // String | The unique id for a `tax_document`.
5589+
String memberGuid = "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"; // String | The unique id for a `member`.
5590+
String userGuid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54"; // String | The unique id for a `user`.
5591+
try {
5592+
TaxDocumentResponseBody result = apiInstance.readTaxDocument(taxDocumentGuid, memberGuid, userGuid);
5593+
System.out.println(result);
5594+
} catch (ApiException e) {
5595+
System.err.println("Exception when calling MxPlatformApi#readTaxDocument");
5596+
System.err.println("Status code: " + e.getCode());
5597+
System.err.println("Reason: " + e.getResponseBody());
5598+
System.err.println("Response headers: " + e.getResponseHeaders());
5599+
e.printStackTrace();
5600+
}
5601+
}
5602+
}
5603+
```
5604+
5605+
### Parameters
5606+
5607+
Name | Type | Description | Notes
5608+
------------- | ------------- | ------------- | -------------
5609+
**taxDocumentGuid** | **String**| The unique id for a &#x60;tax_document&#x60;. |
5610+
**memberGuid** | **String**| The unique id for a &#x60;member&#x60;. |
5611+
**userGuid** | **String**| The unique id for a &#x60;user&#x60;. |
5612+
5613+
### Return type
5614+
5615+
[**TaxDocumentResponseBody**](TaxDocumentResponseBody.md)
5616+
5617+
### Authorization
5618+
5619+
[basicAuth](../README.md#basicAuth)
5620+
5621+
### HTTP request headers
5622+
5623+
- **Content-Type**: Not defined
5624+
- **Accept**: application/vnd.mx.api.v1+json
5625+
5626+
### HTTP response details
5627+
| Status code | Description | Response headers |
5628+
|-------------|-------------|------------------|
5629+
**200** | OK | - |
5630+
53395631
<a name="readTransaction"></a>
53405632
# **readTransaction**
53415633
> TransactionResponseBody readTransaction(transactionGuid, userGuid)

0 commit comments

Comments
 (0)