diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 6752111..224a80b 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -81,6 +81,7 @@ docs/PaymentProcessorAuthorizationCodeResponse.md docs/PaymentProcessorAuthorizationCodeResponseBody.md docs/SpendingPlanAccountResponse.md docs/SpendingPlanAccountsResponse.md +docs/SpendingPlanApi.md docs/SpendingPlanIterationItemCreateRequestBody.md docs/SpendingPlanIterationItemResponse.md docs/SpendingPlanIterationItemsResponseBody.md @@ -134,6 +135,7 @@ docs/WidgetResponseBody.md mx_platform_python/__init__.py mx_platform_python/api/__init__.py mx_platform_python/api/mx_platform_api.py +mx_platform_python/api/spending_plan_api.py mx_platform_python/api_client.py mx_platform_python/api_response.py mx_platform_python/configuration.py @@ -358,6 +360,7 @@ test/test_payment_processor_authorization_code_response.py test/test_payment_processor_authorization_code_response_body.py test/test_spending_plan_account_response.py test/test_spending_plan_accounts_response.py +test/test_spending_plan_api.py test/test_spending_plan_iteration_item_create_request_body.py test/test_spending_plan_iteration_item_response.py test/test_spending_plan_iteration_items_response_body.py diff --git a/docs/MxPlatformApi.md b/docs/MxPlatformApi.md index ad93ab9..de9e788 100644 --- a/docs/MxPlatformApi.md +++ b/docs/MxPlatformApi.md @@ -12,8 +12,6 @@ Method | HTTP request | Description [**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | Create managed transaction [**create_manual_account**](MxPlatformApi.md#create_manual_account) | **POST** /users/{user_guid}/accounts | Create manual account [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member -[**create_spending_plan**](MxPlatformApi.md#create_spending_plan) | **POST** /users/{user_guid}/spending_plans | Create spending plan -[**create_spending_plan_iteration_item**](MxPlatformApi.md#create_spending_plan_iteration_item) | **POST** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | Create spending plan iteration item [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging [**create_transaction_rule**](MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule @@ -24,9 +22,6 @@ Method | HTTP request | Description [**delete_managed_transaction**](MxPlatformApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Delete managed transaction [**delete_manual_account**](MxPlatformApi.md#delete_manual_account) | **DELETE** /users/{user_guid}/accounts/{account_guid} | Delete manual account [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member -[**delete_spending_plan**](MxPlatformApi.md#delete_spending_plan) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid} | Delete spending plan -[**delete_spending_plan_account**](MxPlatformApi.md#delete_spending_plan_account) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Delete spending plan account -[**delete_spending_plan_iteration_item**](MxPlatformApi.md#delete_spending_plan_iteration_item) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Delete spending plan iteration item [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule @@ -60,10 +55,6 @@ Method | HTTP request | Description [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members [**list_merchants**](MxPlatformApi.md#list_merchants) | **GET** /merchants | List merchants -[**list_spending_plan_accounts**](MxPlatformApi.md#list_spending_plan_accounts) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts | List spending plan accounts -[**list_spending_plan_iteration_items**](MxPlatformApi.md#list_spending_plan_iteration_items) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | List spending plan iteration items -[**list_spending_plan_iterations**](MxPlatformApi.md#list_spending_plan_iterations) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations | List spending plan iterations -[**list_spending_plans**](MxPlatformApi.md#list_spending_plans) | **GET** /users/{user_guid}/spending_plans | List spending plans [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags @@ -88,10 +79,6 @@ Method | HTTP request | Description [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant [**read_merchant_location**](MxPlatformApi.md#read_merchant_location) | **GET** /merchant_locations/{merchant_location_guid} | Read merchant location -[**read_spending_plan_account**](MxPlatformApi.md#read_spending_plan_account) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Read spending plan account -[**read_spending_plan_iteration**](MxPlatformApi.md#read_spending_plan_iteration) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} | Read a spending plan iteration -[**read_spending_plan_iteration_item**](MxPlatformApi.md#read_spending_plan_iteration_item) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Read a spending plan iteration item -[**read_spending_plan_user**](MxPlatformApi.md#read_spending_plan_user) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid} | Read a spending plan for a user [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging @@ -110,7 +97,6 @@ Method | HTTP request | Description [**update_managed_member**](MxPlatformApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member [**update_managed_transaction**](MxPlatformApi.md#update_managed_transaction) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Update managed transaction [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member -[**update_spending_plan_iteration_item**](MxPlatformApi.md#update_spending_plan_iteration_item) | **PUT** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Update a spending plan iteration item [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging [**update_transaction**](MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction @@ -771,167 +757,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_spending_plan** -> SpendingPlanResponse create_spending_plan(user_guid) - -Create spending plan - -This endpoint creates a new `spending_plan` for the user. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.spending_plan_response import SpendingPlanResponse -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - - try: - # Create spending plan - api_response = api_instance.create_spending_plan(user_guid) - print("The response of MxPlatformApi->create_spending_plan:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->create_spending_plan: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique id for a `user`. | - -### Return type - -[**SpendingPlanResponse**](SpendingPlanResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_spending_plan_iteration_item** -> SpendingPlanIterationItemResponse create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body) - -Create spending plan iteration item - -This endpoint creates a new `spending_plan_iteration_item`. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.spending_plan_iteration_item_create_request_body import SpendingPlanIterationItemCreateRequestBody -from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_iteration_item_create_request_body = mx_platform_python.SpendingPlanIterationItemCreateRequestBody() # SpendingPlanIterationItemCreateRequestBody | Iteration item to be created with required parameters (planned_amount) - - try: - # Create spending plan iteration item - api_response = api_instance.create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body) - print("The response of MxPlatformApi->create_spending_plan_iteration_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->create_spending_plan_iteration_item: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md)| Iteration item to be created with required parameters (planned_amount) | - -### Return type - -[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **create_tag** > TagResponseBody create_tag(user_guid, tag_create_request_body) @@ -1722,12 +1547,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_spending_plan** -> delete_spending_plan(user_guid, spending_plan_guid) +# **delete_tag** +> delete_tag(tag_guid, user_guid) -Delete spending plan +Delete tag -Use this endpoint to delete a user's `spending_plan`. +Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. ### Example @@ -1760,14 +1585,14 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique ID for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # str | The unique id for a `tag`. + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Delete spending plan - api_instance.delete_spending_plan(user_guid, spending_plan_guid) + # Delete tag + api_instance.delete_tag(tag_guid, user_guid) except Exception as e: - print("Exception when calling MxPlatformApi->delete_spending_plan: %s\n" % e) + print("Exception when calling MxPlatformApi->delete_tag: %s\n" % e) ``` @@ -1776,8 +1601,8 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique ID for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **tag_guid** | **str**| The unique id for a `tag`. | + **user_guid** | **str**| The unique id for a `user`. | ### Return type @@ -1799,12 +1624,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_spending_plan_account** -> delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid) +# **delete_tagging** +> delete_tagging(tagging_guid, user_guid) -Delete spending plan account +Delete tagging -Use this endpoint to delete a `spending_plan_account`. +Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. ### Example @@ -1837,15 +1662,14 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique ID for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # str | The unique ID for the specified account. + tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # str | The unique id for a `tagging`. + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Delete spending plan account - api_instance.delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid) + # Delete tagging + api_instance.delete_tagging(tagging_guid, user_guid) except Exception as e: - print("Exception when calling MxPlatformApi->delete_spending_plan_account: %s\n" % e) + print("Exception when calling MxPlatformApi->delete_tagging: %s\n" % e) ``` @@ -1854,9 +1678,8 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique ID for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **spending_plan_account_guid** | **str**| The unique ID for the specified account. | + **tagging_guid** | **str**| The unique id for a `tagging`. | + **user_guid** | **str**| The unique id for a `user`. | ### Return type @@ -1878,12 +1701,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_spending_plan_iteration_item** -> delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid) +# **delete_transaction_rule** +> delete_transaction_rule(transaction_rule_guid, user_guid) -Delete spending plan iteration item +Delete transaction rule -Use this endpoint to delete a spending plan `iteration_item`. +Use this endpoint to permanently delete a transaction rule based on its unique GUID. ### Example @@ -1916,15 +1739,14 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique ID for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # str | The unique ID for the `iteration_item`. + transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # str | The unique id for a `transaction_rule`. + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Delete spending plan iteration item - api_instance.delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid) + # Delete transaction rule + api_instance.delete_transaction_rule(transaction_rule_guid, user_guid) except Exception as e: - print("Exception when calling MxPlatformApi->delete_spending_plan_iteration_item: %s\n" % e) + print("Exception when calling MxPlatformApi->delete_transaction_rule: %s\n" % e) ``` @@ -1933,9 +1755,8 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique ID for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **iteration_item_guid** | **str**| The unique ID for the `iteration_item`. | + **transaction_rule_guid** | **str**| The unique id for a `transaction_rule`. | + **user_guid** | **str**| The unique id for a `user`. | ### Return type @@ -1957,12 +1778,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_tag** -> delete_tag(tag_guid, user_guid) +# **delete_user** +> delete_user(user_guid) -Delete tag +Delete user -Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. +Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. ### Example @@ -1995,14 +1816,13 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # str | The unique id for a `tag`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Delete tag - api_instance.delete_tag(tag_guid, user_guid) + # Delete user + api_instance.delete_user(user_guid) except Exception as e: - print("Exception when calling MxPlatformApi->delete_tag: %s\n" % e) + print("Exception when calling MxPlatformApi->delete_user: %s\n" % e) ``` @@ -2011,7 +1831,6 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tag_guid** | **str**| The unique id for a `tag`. | **user_guid** | **str**| The unique id for a `user`. | ### Return type @@ -2034,12 +1853,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_tagging** -> delete_tagging(tagging_guid, user_guid) +# **deprecated_request_payment_processor_authorization_code** +> PaymentProcessorAuthorizationCodeResponseBody deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body) -Delete tagging +(Deprecated) Request an authorization code. -Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. +(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. ### Example @@ -2048,6 +1867,8 @@ Use this endpoint to delete a tagging according to its unique GUID. If successfu import time import os import mx_platform_python +from mx_platform_python.models.payment_processor_authorization_code_request_body import PaymentProcessorAuthorizationCodeRequestBody +from mx_platform_python.models.payment_processor_authorization_code_response_body import PaymentProcessorAuthorizationCodeResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -2072,14 +1893,15 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # str | The unique id for a `tagging`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + payment_processor_authorization_code_request_body = mx_platform_python.PaymentProcessorAuthorizationCodeRequestBody() # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code. try: - # Delete tagging - api_instance.delete_tagging(tagging_guid, user_guid) + # (Deprecated) Request an authorization code. + api_response = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body) + print("The response of MxPlatformApi->deprecated_request_payment_processor_authorization_code:\n") + pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->delete_tagging: %s\n" % e) + print("Exception when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: %s\n" % e) ``` @@ -2088,12 +1910,11 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tagging_guid** | **str**| The unique id for a `tagging`. | - **user_guid** | **str**| The unique id for a `user`. | + **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md)| The scope for the authorization code. | ### Return type -void (empty response body) +[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md) ### Authorization @@ -2101,22 +1922,22 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json + - **Accept**: application/vnd.mx.api.v1+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No Content | - | +**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_transaction_rule** -> delete_transaction_rule(transaction_rule_guid, user_guid) +# **download_statement_pdf** +> bytearray download_statement_pdf(member_guid, statement_guid, user_guid) -Delete transaction rule +Download statement pdf -Use this endpoint to permanently delete a transaction rule based on its unique GUID. +Use this endpoint to download a specified statement PDF. ### Example @@ -2149,14 +1970,17 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # str | The unique id for a `transaction_rule`. + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. + statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for a `statement`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Delete transaction rule - api_instance.delete_transaction_rule(transaction_rule_guid, user_guid) + # Download statement pdf + api_response = api_instance.download_statement_pdf(member_guid, statement_guid, user_guid) + print("The response of MxPlatformApi->download_statement_pdf:\n") + pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->delete_transaction_rule: %s\n" % e) + print("Exception when calling MxPlatformApi->download_statement_pdf: %s\n" % e) ``` @@ -2165,12 +1989,13 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **transaction_rule_guid** | **str**| The unique id for a `transaction_rule`. | + **member_guid** | **str**| The unique id for a `member`. | + **statement_guid** | **str**| The unique id for a `statement`. | **user_guid** | **str**| The unique id for a `user`. | ### Return type -void (empty response body) +**bytearray** ### Authorization @@ -2179,21 +2004,21 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/vnd.mx.api.v1+pdf ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No Content | - | +**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_user** -> delete_user(user_guid) +# **download_tax_document** +> bytearray download_tax_document(tax_document_guid, member_guid, user_guid) -Delete user +Download a Tax Document PDF -Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. +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. ### Example @@ -2226,243 +2051,8 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - - try: - # Delete user - api_instance.delete_user(user_guid) - except Exception as e: - print("Exception when calling MxPlatformApi->delete_user: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique id for a `user`. | - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | No Content | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **deprecated_request_payment_processor_authorization_code** -> PaymentProcessorAuthorizationCodeResponseBody deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body) - -(Deprecated) Request an authorization code. - -(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. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.payment_processor_authorization_code_request_body import PaymentProcessorAuthorizationCodeRequestBody -from mx_platform_python.models.payment_processor_authorization_code_response_body import PaymentProcessorAuthorizationCodeResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - payment_processor_authorization_code_request_body = mx_platform_python.PaymentProcessorAuthorizationCodeRequestBody() # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code. - - try: - # (Deprecated) Request an authorization code. - api_response = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body) - print("The response of MxPlatformApi->deprecated_request_payment_processor_authorization_code:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md)| The scope for the authorization code. | - -### Return type - -[**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **download_statement_pdf** -> bytearray download_statement_pdf(member_guid, statement_guid, user_guid) - -Download statement pdf - -Use this endpoint to download a specified statement PDF. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. - statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for a `statement`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - - try: - # Download statement pdf - api_response = api_instance.download_statement_pdf(member_guid, statement_guid, user_guid) - print("The response of MxPlatformApi->download_statement_pdf:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->download_statement_pdf: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **member_guid** | **str**| The unique id for a `member`. | - **statement_guid** | **str**| The unique id for a `statement`. | - **user_guid** | **str**| The unique id for a `user`. | - -### Return type - -**bytearray** - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+pdf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **download_tax_document** -> bytearray download_tax_document(tax_document_guid, member_guid, user_guid) - -Download a Tax Document PDF - -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. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - tax_document_guid = 'TAX-987dfds1b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `tax_document`. - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. + tax_document_guid = 'TAX-987dfds1b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `tax_document`. + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: @@ -4661,12 +4251,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_spending_plan_accounts** -> SpendingPlanAccountsResponse list_spending_plan_accounts(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) +# **list_statements_by_member** +> StatementsResponseBody list_statements_by_member(member_guid, user_guid, page=page, records_per_page=records_per_page) -List spending plan accounts +List statements by member -Use this endpoint to list all the spending plan accounts associated with the spending plan. +Use this endpoint to get an array of available statements. ### Example @@ -4675,7 +4265,7 @@ Use this endpoint to list all the spending plan accounts associated with the spe import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_accounts_response import SpendingPlanAccountsResponse +from mx_platform_python.models.statements_response_body import StatementsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -4700,18 +4290,18 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) try: - # List spending plan accounts - api_response = api_instance.list_spending_plan_accounts(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_spending_plan_accounts:\n") + # List statements by member + api_response = api_instance.list_statements_by_member(member_guid, user_guid, page=page, records_per_page=records_per_page) + print("The response of MxPlatformApi->list_statements_by_member:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_spending_plan_accounts: %s\n" % e) + print("Exception when calling MxPlatformApi->list_statements_by_member: %s\n" % e) ``` @@ -4720,14 +4310,14 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**SpendingPlanAccountsResponse**](SpendingPlanAccountsResponse.md) +[**StatementsResponseBody**](StatementsResponseBody.md) ### Authorization @@ -4745,12 +4335,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_spending_plan_iteration_items** -> SpendingPlanIterationItemsResponseBody list_spending_plan_iteration_items(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) +# **list_taggings** +> TaggingsResponseBody list_taggings(user_guid, page=page, records_per_page=records_per_page) -List spending plan iteration items +List taggings -Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. +Use this endpoint to retrieve a list of all the taggings associated with a specific user. ### Example @@ -4759,7 +4349,7 @@ Use this endpoint to list all the spending plan `iteration_items` associated wit import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_iteration_items_response_body import SpendingPlanIterationItemsResponseBody +from mx_platform_python.models.taggings_response_body import TaggingsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -4785,17 +4375,16 @@ with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) try: - # List spending plan iteration items - api_response = api_instance.list_spending_plan_iteration_items(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_spending_plan_iteration_items:\n") + # List taggings + api_response = api_instance.list_taggings(user_guid, page=page, records_per_page=records_per_page) + print("The response of MxPlatformApi->list_taggings:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_spending_plan_iteration_items: %s\n" % e) + print("Exception when calling MxPlatformApi->list_taggings: %s\n" % e) ``` @@ -4805,13 +4394,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**SpendingPlanIterationItemsResponseBody**](SpendingPlanIterationItemsResponseBody.md) +[**TaggingsResponseBody**](TaggingsResponseBody.md) ### Authorization @@ -4829,12 +4417,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_spending_plan_iterations** -> SpendingPlanIterationsResponse list_spending_plan_iterations(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) +# **list_tags** +> TagsResponseBody list_tags(user_guid, page=page, records_per_page=records_per_page) -List spending plan iterations +List tags -Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. +Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. ### Example @@ -4843,7 +4431,7 @@ Use this endpoint to list all the spending plan `iterations` associated with the import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_iterations_response import SpendingPlanIterationsResponse +from mx_platform_python.models.tags_response_body import TagsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -4869,17 +4457,16 @@ with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) try: - # List spending plan iterations - api_response = api_instance.list_spending_plan_iterations(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_spending_plan_iterations:\n") + # List tags + api_response = api_instance.list_tags(user_guid, page=page, records_per_page=records_per_page) + print("The response of MxPlatformApi->list_tags:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_spending_plan_iterations: %s\n" % e) + print("Exception when calling MxPlatformApi->list_tags: %s\n" % e) ``` @@ -4889,13 +4476,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**SpendingPlanIterationsResponse**](SpendingPlanIterationsResponse.md) +[**TagsResponseBody**](TagsResponseBody.md) ### Authorization @@ -4913,12 +4499,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_spending_plans** -> SpendingPlansResponseBody list_spending_plans(user_guid, page=page, records_per_page=records_per_page) +# **list_tax_documents** +> TaxDocumentsResponseBody list_tax_documents(member_guid, user_guid, page=page, records_per_page=records_per_page) -List spending plans +List Tax Documents -Use this endpoint to list all the spending plans associated with the user. +Use this endpoint to get a paginated list of tax documents. ### Example @@ -4927,7 +4513,7 @@ Use this endpoint to list all the spending plans associated with the user. import time import os import mx_platform_python -from mx_platform_python.models.spending_plans_response_body import SpendingPlansResponseBody +from mx_platform_python.models.tax_documents_response_body import TaxDocumentsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -4952,17 +4538,18 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) try: - # List spending plans - api_response = api_instance.list_spending_plans(user_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_spending_plans:\n") + # List Tax Documents + api_response = api_instance.list_tax_documents(member_guid, user_guid, page=page, records_per_page=records_per_page) + print("The response of MxPlatformApi->list_tax_documents:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_spending_plans: %s\n" % e) + print("Exception when calling MxPlatformApi->list_tax_documents: %s\n" % e) ``` @@ -4971,13 +4558,14 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**SpendingPlansResponseBody**](SpendingPlansResponseBody.md) +[**TaxDocumentsResponseBody**](TaxDocumentsResponseBody.md) ### Authorization @@ -4995,12 +4583,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_statements_by_member** -> StatementsResponseBody list_statements_by_member(member_guid, user_guid, page=page, records_per_page=records_per_page) +# **list_transaction_rules** +> TransactionRulesResponseBody list_transaction_rules(user_guid, page=page, records_per_page=records_per_page) -List statements by member +List transaction rules -Use this endpoint to get an array of available statements. +Use this endpoint to read the attributes of all existing transaction rules belonging to the user. ### Example @@ -5009,7 +4597,7 @@ Use this endpoint to get an array of available statements. import time import os import mx_platform_python -from mx_platform_python.models.statements_response_body import StatementsResponseBody +from mx_platform_python.models.transaction_rules_response_body import TransactionRulesResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5034,18 +4622,17 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) try: - # List statements by member - api_response = api_instance.list_statements_by_member(member_guid, user_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_statements_by_member:\n") + # List transaction rules + api_response = api_instance.list_transaction_rules(user_guid, page=page, records_per_page=records_per_page) + print("The response of MxPlatformApi->list_transaction_rules:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_statements_by_member: %s\n" % e) + print("Exception when calling MxPlatformApi->list_transaction_rules: %s\n" % e) ``` @@ -5054,14 +4641,13 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**StatementsResponseBody**](StatementsResponseBody.md) +[**TransactionRulesResponseBody**](TransactionRulesResponseBody.md) ### Authorization @@ -5079,12 +4665,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_taggings** -> TaggingsResponseBody list_taggings(user_guid, page=page, records_per_page=records_per_page) +# **list_transactions** +> TransactionsResponseBody list_transactions(user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) -List taggings +List transactions -Use this endpoint to retrieve a list of all the taggings associated with a specific user. +Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. ### Example @@ -5093,7 +4679,7 @@ Use this endpoint to retrieve a list of all the taggings associated with a speci import time import os import mx_platform_python -from mx_platform_python.models.taggings_response_body import TaggingsResponseBody +from mx_platform_python.models.transactions_response_body import TransactionsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5119,16 +4705,18 @@ with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + from_date = '2015-09-20' # str | Filter transactions from this date. (optional) page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) + to_date = '2019-10-20' # str | Filter transactions to this date. (optional) try: - # List taggings - api_response = api_instance.list_taggings(user_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_taggings:\n") + # List transactions + api_response = api_instance.list_transactions(user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) + print("The response of MxPlatformApi->list_transactions:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_taggings: %s\n" % e) + print("Exception when calling MxPlatformApi->list_transactions: %s\n" % e) ``` @@ -5138,12 +4726,14 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_guid** | **str**| The unique id for a `user`. | + **from_date** | **str**| Filter transactions from this date. | [optional] **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] + **to_date** | **str**| Filter transactions to this date. | [optional] ### Return type -[**TaggingsResponseBody**](TaggingsResponseBody.md) +[**TransactionsResponseBody**](TransactionsResponseBody.md) ### Authorization @@ -5161,12 +4751,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_tags** -> TagsResponseBody list_tags(user_guid, page=page, records_per_page=records_per_page) +# **list_transactions_by_account** +> TransactionsResponseBody list_transactions_by_account(account_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) -List tags +List transactions by account -Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. +This endpoint returns a list of the last 90 days of transactions associated with the specified account. ### Example @@ -5175,7 +4765,7 @@ Use this endpoint to list all tags associated with the specified `user`. Each us import time import os import mx_platform_python -from mx_platform_python.models.tags_response_body import TagsResponseBody +from mx_platform_python.models.transactions_response_body import TransactionsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5200,17 +4790,20 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + from_date = '2015-09-20' # str | Filter transactions from this date. (optional) page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) + to_date = '2019-10-20' # str | Filter transactions to this date. (optional) try: - # List tags - api_response = api_instance.list_tags(user_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_tags:\n") + # List transactions by account + api_response = api_instance.list_transactions_by_account(account_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) + print("The response of MxPlatformApi->list_transactions_by_account:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_tags: %s\n" % e) + print("Exception when calling MxPlatformApi->list_transactions_by_account: %s\n" % e) ``` @@ -5219,13 +4812,16 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **account_guid** | **str**| The unique id for an `account`. | **user_guid** | **str**| The unique id for a `user`. | + **from_date** | **str**| Filter transactions from this date. | [optional] **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] + **to_date** | **str**| Filter transactions to this date. | [optional] ### Return type -[**TagsResponseBody**](TagsResponseBody.md) +[**TransactionsResponseBody**](TransactionsResponseBody.md) ### Authorization @@ -5243,12 +4839,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_tax_documents** -> TaxDocumentsResponseBody list_tax_documents(member_guid, user_guid, page=page, records_per_page=records_per_page) +# **list_transactions_by_member** +> TransactionsResponseBody list_transactions_by_member(member_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) -List Tax Documents +List transactions by member -Use this endpoint to get a paginated list of tax documents. +Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. ### Example @@ -5257,7 +4853,7 @@ Use this endpoint to get a paginated list of tax documents. import time import os import mx_platform_python -from mx_platform_python.models.tax_documents_response_body import TaxDocumentsResponseBody +from mx_platform_python.models.transactions_response_body import TransactionsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5284,16 +4880,18 @@ with mx_platform_python.ApiClient(configuration) as api_client: api_instance = mx_platform_python.MxPlatformApi(api_client) member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + from_date = '2015-09-20' # str | Filter transactions from this date. (optional) page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) + to_date = '2019-10-20' # str | Filter transactions to this date. (optional) try: - # List Tax Documents - api_response = api_instance.list_tax_documents(member_guid, user_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_tax_documents:\n") + # List transactions by member + api_response = api_instance.list_transactions_by_member(member_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) + print("The response of MxPlatformApi->list_transactions_by_member:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_tax_documents: %s\n" % e) + print("Exception when calling MxPlatformApi->list_transactions_by_member: %s\n" % e) ``` @@ -5304,12 +4902,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | + **from_date** | **str**| Filter transactions from this date. | [optional] **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] + **to_date** | **str**| Filter transactions to this date. | [optional] ### Return type -[**TaxDocumentsResponseBody**](TaxDocumentsResponseBody.md) +[**TransactionsResponseBody**](TransactionsResponseBody.md) ### Authorization @@ -5327,12 +4927,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_transaction_rules** -> TransactionRulesResponseBody list_transaction_rules(user_guid, page=page, records_per_page=records_per_page) +# **list_transactions_by_tag** +> TransactionsResponseBody list_transactions_by_tag(tag_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) -List transaction rules +List transactions by tag -Use this endpoint to read the attributes of all existing transaction rules belonging to the user. +Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. ### Example @@ -5341,7 +4941,7 @@ Use this endpoint to read the attributes of all existing transaction rules belon import time import os import mx_platform_python -from mx_platform_python.models.transaction_rules_response_body import TransactionRulesResponseBody +from mx_platform_python.models.transactions_response_body import TransactionsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5366,17 +4966,20 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # str | The unique id for a `tag`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + from_date = '2015-09-20' # str | Filter transactions from this date. (optional) page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) + to_date = '2019-10-20' # str | Filter transactions to this date. (optional) try: - # List transaction rules - api_response = api_instance.list_transaction_rules(user_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_transaction_rules:\n") + # List transactions by tag + api_response = api_instance.list_transactions_by_tag(tag_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) + print("The response of MxPlatformApi->list_transactions_by_tag:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_transaction_rules: %s\n" % e) + print("Exception when calling MxPlatformApi->list_transactions_by_tag: %s\n" % e) ``` @@ -5385,13 +4988,16 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tag_guid** | **str**| The unique id for a `tag`. | **user_guid** | **str**| The unique id for a `user`. | + **from_date** | **str**| Filter transactions from this date. | [optional] **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] + **to_date** | **str**| Filter transactions to this date. | [optional] ### Return type -[**TransactionRulesResponseBody**](TransactionRulesResponseBody.md) +[**TransactionsResponseBody**](TransactionsResponseBody.md) ### Authorization @@ -5409,12 +5015,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_transactions** -> TransactionsResponseBody list_transactions(user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) +# **list_user_accounts** +> AccountsResponseBody list_user_accounts(user_guid, member_is_managed_by_user=member_is_managed_by_user, page=page, is_manual=is_manual, records_per_page=records_per_page) -List transactions +List accounts -Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. +This endpoint returns a list of all the accounts associated with the specified `user`. ### Example @@ -5423,7 +5029,7 @@ Requests to this endpoint return a list of transactions associated with the spec import time import os import mx_platform_python -from mx_platform_python.models.transactions_response_body import TransactionsResponseBody +from mx_platform_python.models.accounts_response_body import AccountsResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5449,18 +5055,18 @@ with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - from_date = '2015-09-20' # str | Filter transactions from this date. (optional) + member_is_managed_by_user = true # bool | List only accounts whose member is managed by the user. (optional) page = 1 # int | Specify current page. (optional) + is_manual = true # bool | List only accounts that were manually created. (optional) records_per_page = 10 # int | Specify records per page. (optional) - to_date = '2019-10-20' # str | Filter transactions to this date. (optional) try: - # List transactions - api_response = api_instance.list_transactions(user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) - print("The response of MxPlatformApi->list_transactions:\n") + # List accounts + api_response = api_instance.list_user_accounts(user_guid, member_is_managed_by_user=member_is_managed_by_user, page=page, is_manual=is_manual, records_per_page=records_per_page) + print("The response of MxPlatformApi->list_user_accounts:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_transactions: %s\n" % e) + print("Exception when calling MxPlatformApi->list_user_accounts: %s\n" % e) ``` @@ -5470,14 +5076,14 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_guid** | **str**| The unique id for a `user`. | - **from_date** | **str**| Filter transactions from this date. | [optional] + **member_is_managed_by_user** | **bool**| List only accounts whose member is managed by the user. | [optional] **page** | **int**| Specify current page. | [optional] + **is_manual** | **bool**| List only accounts that were manually created. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] - **to_date** | **str**| Filter transactions to this date. | [optional] ### Return type -[**TransactionsResponseBody**](TransactionsResponseBody.md) +[**AccountsResponseBody**](AccountsResponseBody.md) ### Authorization @@ -5495,12 +5101,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_transactions_by_account** -> TransactionsResponseBody list_transactions_by_account(account_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) +# **list_users** +> UsersResponseBody list_users(page=page, records_per_page=records_per_page, id=id, email=email, is_disabled=is_disabled) -List transactions by account +List users -This endpoint returns a list of the last 90 days of transactions associated with the specified account. +Use this endpoint to list every user you've created in the MX Platform API. ### Example @@ -5509,7 +5115,7 @@ This endpoint returns a list of the last 90 days of transactions associated with import time import os import mx_platform_python -from mx_platform_python.models.transactions_response_body import TransactionsResponseBody +from mx_platform_python.models.users_response_body import UsersResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5534,20 +5140,19 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - from_date = '2015-09-20' # str | Filter transactions from this date. (optional) page = 1 # int | Specify current page. (optional) records_per_page = 10 # int | Specify records per page. (optional) - to_date = '2019-10-20' # str | Filter transactions to this date. (optional) + id = 'u-12324-abdc' # str | The user `id` to search for. (optional) + email = 'example@example.com' # str | The user `email` to search for. (optional) + is_disabled = true # bool | Search for users that are diabled. (optional) try: - # List transactions by account - api_response = api_instance.list_transactions_by_account(account_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) - print("The response of MxPlatformApi->list_transactions_by_account:\n") + # List users + api_response = api_instance.list_users(page=page, records_per_page=records_per_page, id=id, email=email, is_disabled=is_disabled) + print("The response of MxPlatformApi->list_users:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_transactions_by_account: %s\n" % e) + print("Exception when calling MxPlatformApi->list_users: %s\n" % e) ``` @@ -5556,16 +5161,15 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_guid** | **str**| The unique id for an `account`. | - **user_guid** | **str**| The unique id for a `user`. | - **from_date** | **str**| Filter transactions from this date. | [optional] **page** | **int**| Specify current page. | [optional] **records_per_page** | **int**| Specify records per page. | [optional] - **to_date** | **str**| Filter transactions to this date. | [optional] + **id** | **str**| The user `id` to search for. | [optional] + **email** | **str**| The user `email` to search for. | [optional] + **is_disabled** | **bool**| Search for users that are diabled. | [optional] ### Return type -[**TransactionsResponseBody**](TransactionsResponseBody.md) +[**UsersResponseBody**](UsersResponseBody.md) ### Authorization @@ -5583,12 +5187,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_transactions_by_member** -> TransactionsResponseBody list_transactions_by_member(member_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) +# **read_account** +> AccountResponseBody read_account(account_guid, user_guid) -List transactions by member +Read account -Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. +This endpoint returns the specified `account` resource. ### Example @@ -5597,7 +5201,7 @@ Requests to this endpoint return a list of transactions associated with the spec import time import os import mx_platform_python -from mx_platform_python.models.transactions_response_body import TransactionsResponseBody +from mx_platform_python.models.account_response_body import AccountResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5622,20 +5226,16 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. + account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - from_date = '2015-09-20' # str | Filter transactions from this date. (optional) - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) - to_date = '2019-10-20' # str | Filter transactions to this date. (optional) try: - # List transactions by member - api_response = api_instance.list_transactions_by_member(member_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) - print("The response of MxPlatformApi->list_transactions_by_member:\n") + # Read account + api_response = api_instance.read_account(account_guid, user_guid) + print("The response of MxPlatformApi->read_account:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->list_transactions_by_member: %s\n" % e) + print("Exception when calling MxPlatformApi->read_account: %s\n" % e) ``` @@ -5644,16 +5244,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **member_guid** | **str**| The unique id for a `member`. | + **account_guid** | **str**| The unique id for an `account`. | **user_guid** | **str**| The unique id for a `user`. | - **from_date** | **str**| Filter transactions from this date. | [optional] - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] - **to_date** | **str**| Filter transactions to this date. | [optional] ### Return type -[**TransactionsResponseBody**](TransactionsResponseBody.md) +[**AccountResponseBody**](AccountResponseBody.md) ### Authorization @@ -5671,12 +5267,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_transactions_by_tag** -> TransactionsResponseBody list_transactions_by_tag(tag_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) +# **read_account_by_member** +> AccountResponseBody read_account_by_member(account_guid, member_guid, user_guid) -List transactions by tag +Read account by member -Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. +This endpoint allows you to read the attributes of an `account` resource. ### Example @@ -5685,7 +5281,7 @@ Use this endpoint to get a list of all transactions associated with a particular import time import os import mx_platform_python -from mx_platform_python.models.transactions_response_body import TransactionsResponseBody +from mx_platform_python.models.account_response_body import AccountResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -5710,596 +5306,17 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # str | The unique id for a `tag`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - from_date = '2015-09-20' # str | Filter transactions from this date. (optional) - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) - to_date = '2019-10-20' # str | Filter transactions to this date. (optional) - - try: - # List transactions by tag - api_response = api_instance.list_transactions_by_tag(tag_guid, user_guid, from_date=from_date, page=page, records_per_page=records_per_page, to_date=to_date) - print("The response of MxPlatformApi->list_transactions_by_tag:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->list_transactions_by_tag: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tag_guid** | **str**| The unique id for a `tag`. | - **user_guid** | **str**| The unique id for a `user`. | - **from_date** | **str**| Filter transactions from this date. | [optional] - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] - **to_date** | **str**| Filter transactions to this date. | [optional] - -### Return type - -[**TransactionsResponseBody**](TransactionsResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_user_accounts** -> AccountsResponseBody list_user_accounts(user_guid, member_is_managed_by_user=member_is_managed_by_user, page=page, is_manual=is_manual, records_per_page=records_per_page) - -List accounts - -This endpoint returns a list of all the accounts associated with the specified `user`. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.accounts_response_body import AccountsResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - member_is_managed_by_user = true # bool | List only accounts whose member is managed by the user. (optional) - page = 1 # int | Specify current page. (optional) - is_manual = true # bool | List only accounts that were manually created. (optional) - records_per_page = 10 # int | Specify records per page. (optional) - - try: - # List accounts - api_response = api_instance.list_user_accounts(user_guid, member_is_managed_by_user=member_is_managed_by_user, page=page, is_manual=is_manual, records_per_page=records_per_page) - print("The response of MxPlatformApi->list_user_accounts:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->list_user_accounts: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique id for a `user`. | - **member_is_managed_by_user** | **bool**| List only accounts whose member is managed by the user. | [optional] - **page** | **int**| Specify current page. | [optional] - **is_manual** | **bool**| List only accounts that were manually created. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] - -### Return type - -[**AccountsResponseBody**](AccountsResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_users** -> UsersResponseBody list_users(page=page, records_per_page=records_per_page, id=id, email=email, is_disabled=is_disabled) - -List users - -Use this endpoint to list every user you've created in the MX Platform API. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.users_response_body import UsersResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) - id = 'u-12324-abdc' # str | The user `id` to search for. (optional) - email = 'example@example.com' # str | The user `email` to search for. (optional) - is_disabled = true # bool | Search for users that are diabled. (optional) - - try: - # List users - api_response = api_instance.list_users(page=page, records_per_page=records_per_page, id=id, email=email, is_disabled=is_disabled) - print("The response of MxPlatformApi->list_users:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->list_users: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] - **id** | **str**| The user `id` to search for. | [optional] - **email** | **str**| The user `email` to search for. | [optional] - **is_disabled** | **bool**| Search for users that are diabled. | [optional] - -### Return type - -[**UsersResponseBody**](UsersResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_account** -> AccountResponseBody read_account(account_guid, user_guid) - -Read account - -This endpoint returns the specified `account` resource. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.account_response_body import AccountResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - - try: - # Read account - api_response = api_instance.read_account(account_guid, user_guid) - print("The response of MxPlatformApi->read_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->read_account: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_guid** | **str**| The unique id for an `account`. | - **user_guid** | **str**| The unique id for a `user`. | - -### Return type - -[**AccountResponseBody**](AccountResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_account_by_member** -> AccountResponseBody read_account_by_member(account_guid, member_guid, user_guid) - -Read account by member - -This endpoint allows you to read the attributes of an `account` resource. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.account_response_body import AccountResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - - try: - # Read account by member - api_response = api_instance.read_account_by_member(account_guid, member_guid, user_guid) - print("The response of MxPlatformApi->read_account_by_member:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->read_account_by_member: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_guid** | **str**| The unique id for an `account`. | - **member_guid** | **str**| The unique id for a `member`. | - **user_guid** | **str**| The unique id for a `user`. | - -### Return type - -[**AccountResponseBody**](AccountResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_category** -> CategoryResponseBody read_category(category_guid, user_guid) - -Read a custom category - -Use this endpoint to read the attributes of either a default category or a custom category. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.category_response_body import CategoryResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # str | The unique id for a `category`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - - try: - # Read a custom category - api_response = api_instance.read_category(category_guid, user_guid) - print("The response of MxPlatformApi->read_category:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->read_category: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **category_guid** | **str**| The unique id for a `category`. | - **user_guid** | **str**| The unique id for a `user`. | - -### Return type - -[**CategoryResponseBody**](CategoryResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_default_category** -> CategoryResponseBody read_default_category(category_guid) - -Read a default category - -Use this endpoint to read the attributes of a default category. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.category_response_body import CategoryResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # str | The unique id for a `category`. - - try: - # Read a default category - api_response = api_instance.read_default_category(category_guid) - print("The response of MxPlatformApi->read_default_category:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->read_default_category: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **category_guid** | **str**| The unique id for a `category`. | - -### Return type - -[**CategoryResponseBody**](CategoryResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_holding** -> HoldingResponseBody read_holding(holding_guid, user_guid) - -Read holding - -Use this endpoint to read the attributes of a specific `holding`. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.holding_response_body import HoldingResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - holding_guid = 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2' # str | The unique id for a `holding`. + account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Read holding - api_response = api_instance.read_holding(holding_guid, user_guid) - print("The response of MxPlatformApi->read_holding:\n") + # Read account by member + api_response = api_instance.read_account_by_member(account_guid, member_guid, user_guid) + print("The response of MxPlatformApi->read_account_by_member:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_holding: %s\n" % e) + print("Exception when calling MxPlatformApi->read_account_by_member: %s\n" % e) ``` @@ -6308,90 +5325,13 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **holding_guid** | **str**| The unique id for a `holding`. | + **account_guid** | **str**| The unique id for an `account`. | + **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | ### Return type -[**HoldingResponseBody**](HoldingResponseBody.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_institution** -> InstitutionResponseBody read_institution(institution_code) - -Read institution - -This endpoint returns information about the institution specified by `institution_code`. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.institution_response_body import InstitutionResponseBody -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - institution_code = 'chase' # str | The institution_code of the institution. - - try: - # Read institution - api_response = api_instance.read_institution(institution_code) - print("The response of MxPlatformApi->read_institution:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->read_institution: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **institution_code** | **str**| The institution_code of the institution. | - -### Return type - -[**InstitutionResponseBody**](InstitutionResponseBody.md) +[**AccountResponseBody**](AccountResponseBody.md) ### Authorization @@ -6409,12 +5349,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_managed_account** -> AccountResponseBody read_managed_account(account_guid, member_guid, user_guid) +# **read_category** +> CategoryResponseBody read_category(category_guid, user_guid) -Read managed account +Read a custom category -Use this endpoint to read the attributes of a partner-managed account according to its unique guid. +Use this endpoint to read the attributes of either a default category or a custom category. ### Example @@ -6423,7 +5363,7 @@ Use this endpoint to read the attributes of a partner-managed account according import time import os import mx_platform_python -from mx_platform_python.models.account_response_body import AccountResponseBody +from mx_platform_python.models.category_response_body import CategoryResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6448,17 +5388,16 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. + category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # str | The unique id for a `category`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Read managed account - api_response = api_instance.read_managed_account(account_guid, member_guid, user_guid) - print("The response of MxPlatformApi->read_managed_account:\n") + # Read a custom category + api_response = api_instance.read_category(category_guid, user_guid) + print("The response of MxPlatformApi->read_category:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_managed_account: %s\n" % e) + print("Exception when calling MxPlatformApi->read_category: %s\n" % e) ``` @@ -6467,13 +5406,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_guid** | **str**| The unique id for an `account`. | - **member_guid** | **str**| The unique id for a `member`. | + **category_guid** | **str**| The unique id for a `category`. | **user_guid** | **str**| The unique id for a `user`. | ### Return type -[**AccountResponseBody**](AccountResponseBody.md) +[**CategoryResponseBody**](CategoryResponseBody.md) ### Authorization @@ -6491,12 +5429,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_managed_member** -> MemberResponseBody read_managed_member(member_guid, user_guid) +# **read_default_category** +> CategoryResponseBody read_default_category(category_guid) -Read managed member +Read a default category -This endpoint returns the attributes of the specified partner-managed `member`. +Use this endpoint to read the attributes of a default category. ### Example @@ -6505,7 +5443,7 @@ This endpoint returns the attributes of the specified partner-managed `member`. import time import os import mx_platform_python -from mx_platform_python.models.member_response_body import MemberResponseBody +from mx_platform_python.models.category_response_body import CategoryResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6530,16 +5468,15 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # str | The unique id for a `category`. try: - # Read managed member - api_response = api_instance.read_managed_member(member_guid, user_guid) - print("The response of MxPlatformApi->read_managed_member:\n") + # Read a default category + api_response = api_instance.read_default_category(category_guid) + print("The response of MxPlatformApi->read_default_category:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_managed_member: %s\n" % e) + print("Exception when calling MxPlatformApi->read_default_category: %s\n" % e) ``` @@ -6548,12 +5485,11 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **member_guid** | **str**| The unique id for a `member`. | - **user_guid** | **str**| The unique id for a `user`. | + **category_guid** | **str**| The unique id for a `category`. | ### Return type -[**MemberResponseBody**](MemberResponseBody.md) +[**CategoryResponseBody**](CategoryResponseBody.md) ### Authorization @@ -6571,12 +5507,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_managed_transaction** -> TransactionResponseBody read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid) +# **read_holding** +> HoldingResponseBody read_holding(holding_guid, user_guid) -Read managed transaction +Read holding -Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. +Use this endpoint to read the attributes of a specific `holding`. ### Example @@ -6585,7 +5521,7 @@ Requests to this endpoint will return the attributes of the specified partner-ma import time import os import mx_platform_python -from mx_platform_python.models.transaction_response_body import TransactionResponseBody +from mx_platform_python.models.holding_response_body import HoldingResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6609,19 +5545,17 @@ configuration = mx_platform_python.Configuration( # Enter a context with an instance of the API client with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. - transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # str | The unique id for a `transaction`. + api_instance = mx_platform_python.MxPlatformApi(api_client) + holding_guid = 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2' # str | The unique id for a `holding`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Read managed transaction - api_response = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid) - print("The response of MxPlatformApi->read_managed_transaction:\n") + # Read holding + api_response = api_instance.read_holding(holding_guid, user_guid) + print("The response of MxPlatformApi->read_holding:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_managed_transaction: %s\n" % e) + print("Exception when calling MxPlatformApi->read_holding: %s\n" % e) ``` @@ -6630,14 +5564,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_guid** | **str**| The unique id for an `account`. | - **member_guid** | **str**| The unique id for a `member`. | - **transaction_guid** | **str**| The unique id for a `transaction`. | + **holding_guid** | **str**| The unique id for a `holding`. | **user_guid** | **str**| The unique id for a `user`. | ### Return type -[**TransactionResponseBody**](TransactionResponseBody.md) +[**HoldingResponseBody**](HoldingResponseBody.md) ### Authorization @@ -6655,12 +5587,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_member** -> MemberResponseBody read_member(member_guid, user_guid) +# **read_institution** +> InstitutionResponseBody read_institution(institution_code) -Read member +Read institution -Use this endpoint to read the attributes of a specific member. +This endpoint returns information about the institution specified by `institution_code`. ### Example @@ -6669,7 +5601,7 @@ Use this endpoint to read the attributes of a specific member. import time import os import mx_platform_python -from mx_platform_python.models.member_response_body import MemberResponseBody +from mx_platform_python.models.institution_response_body import InstitutionResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6694,16 +5626,15 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + institution_code = 'chase' # str | The institution_code of the institution. try: - # Read member - api_response = api_instance.read_member(member_guid, user_guid) - print("The response of MxPlatformApi->read_member:\n") + # Read institution + api_response = api_instance.read_institution(institution_code) + print("The response of MxPlatformApi->read_institution:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_member: %s\n" % e) + print("Exception when calling MxPlatformApi->read_institution: %s\n" % e) ``` @@ -6712,12 +5643,11 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **member_guid** | **str**| The unique id for a `member`. | - **user_guid** | **str**| The unique id for a `user`. | + **institution_code** | **str**| The institution_code of the institution. | ### Return type -[**MemberResponseBody**](MemberResponseBody.md) +[**InstitutionResponseBody**](InstitutionResponseBody.md) ### Authorization @@ -6735,12 +5665,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_member_status** -> MemberStatusResponseBody read_member_status(member_guid, user_guid) +# **read_managed_account** +> AccountResponseBody read_managed_account(account_guid, member_guid, user_guid) -Read member status +Read managed account -This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. +Use this endpoint to read the attributes of a partner-managed account according to its unique guid. ### Example @@ -6749,7 +5679,7 @@ This endpoint provides the status of the members most recent aggregation event. import time import os import mx_platform_python -from mx_platform_python.models.member_status_response_body import MemberStatusResponseBody +from mx_platform_python.models.account_response_body import AccountResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6774,16 +5704,17 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Read member status - api_response = api_instance.read_member_status(member_guid, user_guid) - print("The response of MxPlatformApi->read_member_status:\n") + # Read managed account + api_response = api_instance.read_managed_account(account_guid, member_guid, user_guid) + print("The response of MxPlatformApi->read_managed_account:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_member_status: %s\n" % e) + print("Exception when calling MxPlatformApi->read_managed_account: %s\n" % e) ``` @@ -6792,12 +5723,13 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **account_guid** | **str**| The unique id for an `account`. | **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | ### Return type -[**MemberStatusResponseBody**](MemberStatusResponseBody.md) +[**AccountResponseBody**](AccountResponseBody.md) ### Authorization @@ -6815,12 +5747,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_merchant** -> MerchantResponseBody read_merchant(merchant_guid) +# **read_managed_member** +> MemberResponseBody read_managed_member(member_guid, user_guid) -Read merchant +Read managed member -Returns information about a particular merchant, such as a logo, name, and website. +This endpoint returns the attributes of the specified partner-managed `member`. ### Example @@ -6829,7 +5761,7 @@ Returns information about a particular merchant, such as a logo, name, and websi import time import os import mx_platform_python -from mx_platform_python.models.merchant_response_body import MerchantResponseBody +from mx_platform_python.models.member_response_body import MemberResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6854,15 +5786,16 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - merchant_guid = 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b' # str | The unique id for a `merchant`. + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Read merchant - api_response = api_instance.read_merchant(merchant_guid) - print("The response of MxPlatformApi->read_merchant:\n") + # Read managed member + api_response = api_instance.read_managed_member(member_guid, user_guid) + print("The response of MxPlatformApi->read_managed_member:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_merchant: %s\n" % e) + print("Exception when calling MxPlatformApi->read_managed_member: %s\n" % e) ``` @@ -6871,11 +5804,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **merchant_guid** | **str**| The unique id for a `merchant`. | + **member_guid** | **str**| The unique id for a `member`. | + **user_guid** | **str**| The unique id for a `user`. | ### Return type -[**MerchantResponseBody**](MerchantResponseBody.md) +[**MemberResponseBody**](MemberResponseBody.md) ### Authorization @@ -6893,12 +5827,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_merchant_location** -> MerchantLocationResponseBody read_merchant_location(merchant_location_guid) +# **read_managed_transaction** +> TransactionResponseBody read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid) -Read merchant location +Read managed transaction -This endpoint returns the specified merchant_location resource. +Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. ### Example @@ -6907,7 +5841,7 @@ This endpoint returns the specified merchant_location resource. import time import os import mx_platform_python -from mx_platform_python.models.merchant_location_response_body import MerchantLocationResponseBody +from mx_platform_python.models.transaction_response_body import TransactionResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -6932,15 +5866,18 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - merchant_location_guid = 'MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621' # str | The unique id for a `merchant_location`. + account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # str | The unique id for an `account`. + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. + transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # str | The unique id for a `transaction`. + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. try: - # Read merchant location - api_response = api_instance.read_merchant_location(merchant_location_guid) - print("The response of MxPlatformApi->read_merchant_location:\n") + # Read managed transaction + api_response = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid) + print("The response of MxPlatformApi->read_managed_transaction:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_merchant_location: %s\n" % e) + print("Exception when calling MxPlatformApi->read_managed_transaction: %s\n" % e) ``` @@ -6949,11 +5886,14 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **merchant_location_guid** | **str**| The unique id for a `merchant_location`. | + **account_guid** | **str**| The unique id for an `account`. | + **member_guid** | **str**| The unique id for a `member`. | + **transaction_guid** | **str**| The unique id for a `transaction`. | + **user_guid** | **str**| The unique id for a `user`. | ### Return type -[**MerchantLocationResponseBody**](MerchantLocationResponseBody.md) +[**TransactionResponseBody**](TransactionResponseBody.md) ### Authorization @@ -6971,12 +5911,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_spending_plan_account** -> SpendingPlanAccountResponse read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, page=page, records_per_page=records_per_page) +# **read_member** +> MemberResponseBody read_member(member_guid, user_guid) -Read spending plan account +Read member -Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. +Use this endpoint to read the attributes of a specific member. ### Example @@ -6985,7 +5925,7 @@ Use this endpoint to read the attributes of a specific spending plan account acc import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_account_response import SpendingPlanAccountResponse +from mx_platform_python.models.member_response_body import MemberResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -7010,19 +5950,16 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # str | The unique ID for the specified account. - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) try: - # Read spending plan account - api_response = api_instance.read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->read_spending_plan_account:\n") + # Read member + api_response = api_instance.read_member(member_guid, user_guid) + print("The response of MxPlatformApi->read_member:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_spending_plan_account: %s\n" % e) + print("Exception when calling MxPlatformApi->read_member: %s\n" % e) ``` @@ -7031,15 +5968,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **spending_plan_account_guid** | **str**| The unique ID for the specified account. | - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**SpendingPlanAccountResponse**](SpendingPlanAccountResponse.md) +[**MemberResponseBody**](MemberResponseBody.md) ### Authorization @@ -7057,12 +5991,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_spending_plan_iteration** -> SpendingPlanIterationResponse read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, page=page, records_per_page=records_per_page) +# **read_member_status** +> MemberStatusResponseBody read_member_status(member_guid, user_guid) -Read a spending plan iteration +Read member status -Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. +This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. ### Example @@ -7071,7 +6005,7 @@ Use this endpoint to read the attributes of a specific spending plan `iteration` import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_iteration_response import SpendingPlanIterationResponse +from mx_platform_python.models.member_status_response_body import MemberStatusResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -7096,19 +6030,16 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) + member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # str | The unique id for a `member`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - iteration_number = 1 # int | The current iteration number for the spending plan `iteration``. - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) try: - # Read a spending plan iteration - api_response = api_instance.read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->read_spending_plan_iteration:\n") + # Read member status + api_response = api_instance.read_member_status(member_guid, user_guid) + print("The response of MxPlatformApi->read_member_status:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_spending_plan_iteration: %s\n" % e) + print("Exception when calling MxPlatformApi->read_member_status: %s\n" % e) ``` @@ -7117,15 +6048,12 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **member_guid** | **str**| The unique id for a `member`. | **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **iteration_number** | **int**| The current iteration number for the spending plan `iteration``. | - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] ### Return type -[**SpendingPlanIterationResponse**](SpendingPlanIterationResponse.md) +[**MemberStatusResponseBody**](MemberStatusResponseBody.md) ### Authorization @@ -7143,12 +6071,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_spending_plan_iteration_item** -> SpendingPlanIterationItemResponse read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, page=page, records_per_page=records_per_page) +# **read_merchant** +> MerchantResponseBody read_merchant(merchant_guid) -Read a spending plan iteration item +Read merchant -Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. +Returns information about a particular merchant, such as a logo, name, and website. ### Example @@ -7157,7 +6085,7 @@ Use this endpoint to read the attributes of a specific spending plan `iteration_ import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse +from mx_platform_python.models.merchant_response_body import MerchantResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -7182,19 +6110,15 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # str | The unique ID for the `iteration_item`. - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) + merchant_guid = 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b' # str | The unique id for a `merchant`. try: - # Read a spending plan iteration item - api_response = api_instance.read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->read_spending_plan_iteration_item:\n") + # Read merchant + api_response = api_instance.read_merchant(merchant_guid) + print("The response of MxPlatformApi->read_merchant:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_spending_plan_iteration_item: %s\n" % e) + print("Exception when calling MxPlatformApi->read_merchant: %s\n" % e) ``` @@ -7203,15 +6127,11 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **iteration_item_guid** | **str**| The unique ID for the `iteration_item`. | - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] + **merchant_guid** | **str**| The unique id for a `merchant`. | ### Return type -[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md) +[**MerchantResponseBody**](MerchantResponseBody.md) ### Authorization @@ -7229,12 +6149,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **read_spending_plan_user** -> SpendingPlanResponse read_spending_plan_user(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) +# **read_merchant_location** +> MerchantLocationResponseBody read_merchant_location(merchant_location_guid) -Read a spending plan for a user +Read merchant location -Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. +This endpoint returns the specified merchant_location resource. ### Example @@ -7243,7 +6163,7 @@ Use this endpoint to read the attributes of a specific spending plan according t import time import os import mx_platform_python -from mx_platform_python.models.spending_plan_response import SpendingPlanResponse +from mx_platform_python.models.merchant_location_response_body import MerchantLocationResponseBody from mx_platform_python.rest import ApiException from pprint import pprint @@ -7268,18 +6188,15 @@ configuration = mx_platform_python.Configuration( with mx_platform_python.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - page = 1 # int | Specify current page. (optional) - records_per_page = 10 # int | Specify records per page. (optional) + merchant_location_guid = 'MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621' # str | The unique id for a `merchant_location`. try: - # Read a spending plan for a user - api_response = api_instance.read_spending_plan_user(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) - print("The response of MxPlatformApi->read_spending_plan_user:\n") + # Read merchant location + api_response = api_instance.read_merchant_location(merchant_location_guid) + print("The response of MxPlatformApi->read_merchant_location:\n") pprint(api_response) except Exception as e: - print("Exception when calling MxPlatformApi->read_spending_plan_user: %s\n" % e) + print("Exception when calling MxPlatformApi->read_merchant_location: %s\n" % e) ``` @@ -7288,14 +6205,11 @@ with mx_platform_python.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **page** | **int**| Specify current page. | [optional] - **records_per_page** | **int**| Specify records per page. | [optional] + **merchant_location_guid** | **str**| The unique id for a `merchant_location`. | ### Return type -[**SpendingPlanResponse**](SpendingPlanResponse.md) +[**MerchantLocationResponseBody**](MerchantLocationResponseBody.md) ### Authorization @@ -8797,91 +7711,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_spending_plan_iteration_item** -> SpendingPlanIterationItemResponse update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body) - -Update a spending plan iteration item - -Use this endpoint to update an existing `spending_plan_iteration_item`. - -### Example - -* Basic Authentication (basicAuth): -```python -import time -import os -import mx_platform_python -from mx_platform_python.models.spending_plan_iteration_item_create_request_body import SpendingPlanIterationItemCreateRequestBody -from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse -from mx_platform_python.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://api.mx.com -# See configuration.py for a list of all supported configuration parameters. -configuration = mx_platform_python.Configuration( - host = "https://api.mx.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = mx_platform_python.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with mx_platform_python.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mx_platform_python.MxPlatformApi(api_client) - user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. - spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. - iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # str | The unique ID for the `iteration_item`. - spending_plan_iteration_item_create_request_body = mx_platform_python.SpendingPlanIterationItemCreateRequestBody() # SpendingPlanIterationItemCreateRequestBody | Iteration item object to be updated with required parameter (iteration_item_guid) - - try: - # Update a spending plan iteration item - api_response = api_instance.update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body) - print("The response of MxPlatformApi->update_spending_plan_iteration_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MxPlatformApi->update_spending_plan_iteration_item: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_guid** | **str**| The unique id for a `user`. | - **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | - **iteration_item_guid** | **str**| The unique ID for the `iteration_item`. | - **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md)| Iteration item object to be updated with required parameter (iteration_item_guid) | - -### Return type - -[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/vnd.mx.api.v1+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **update_tag** > TagResponseBody update_tag(tag_guid, user_guid, tag_update_request_body) diff --git a/docs/SpendingPlanApi.md b/docs/SpendingPlanApi.md new file mode 100644 index 0000000..0bc1d74 --- /dev/null +++ b/docs/SpendingPlanApi.md @@ -0,0 +1,1179 @@ +# mx_platform_python.SpendingPlanApi + +All URIs are relative to *https://api.mx.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_spending_plan**](SpendingPlanApi.md#create_spending_plan) | **POST** /users/{user_guid}/spending_plans | Create spending plan +[**create_spending_plan_iteration_item**](SpendingPlanApi.md#create_spending_plan_iteration_item) | **POST** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | Create spending plan iteration item +[**delete_spending_plan**](SpendingPlanApi.md#delete_spending_plan) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid} | Delete spending plan +[**delete_spending_plan_account**](SpendingPlanApi.md#delete_spending_plan_account) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Delete spending plan account +[**delete_spending_plan_iteration_item**](SpendingPlanApi.md#delete_spending_plan_iteration_item) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Delete spending plan iteration item +[**list_spending_plan_accounts**](SpendingPlanApi.md#list_spending_plan_accounts) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts | List spending plan accounts +[**list_spending_plan_iteration_items**](SpendingPlanApi.md#list_spending_plan_iteration_items) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | List spending plan iteration items +[**list_spending_plan_iterations**](SpendingPlanApi.md#list_spending_plan_iterations) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations | List spending plan iterations +[**list_spending_plans**](SpendingPlanApi.md#list_spending_plans) | **GET** /users/{user_guid}/spending_plans | List spending plans +[**read_spending_plan_account**](SpendingPlanApi.md#read_spending_plan_account) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Read spending plan account +[**read_spending_plan_iteration**](SpendingPlanApi.md#read_spending_plan_iteration) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} | Read a spending plan iteration +[**read_spending_plan_iteration_item**](SpendingPlanApi.md#read_spending_plan_iteration_item) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Read a spending plan iteration item +[**read_spending_plan_user**](SpendingPlanApi.md#read_spending_plan_user) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid} | Read a spending plan for a user +[**update_spending_plan_iteration_item**](SpendingPlanApi.md#update_spending_plan_iteration_item) | **PUT** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Update a spending plan iteration item + + +# **create_spending_plan** +> SpendingPlanResponse create_spending_plan(user_guid) + +Create spending plan + +This endpoint creates a new `spending_plan` for the user. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_response import SpendingPlanResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + + try: + # Create spending plan + api_response = api_instance.create_spending_plan(user_guid) + print("The response of SpendingPlanApi->create_spending_plan:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->create_spending_plan: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + +### Return type + +[**SpendingPlanResponse**](SpendingPlanResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_spending_plan_iteration_item** +> SpendingPlanIterationItemResponse create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body) + +Create spending plan iteration item + +This endpoint creates a new `spending_plan_iteration_item`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_iteration_item_create_request_body import SpendingPlanIterationItemCreateRequestBody +from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_iteration_item_create_request_body = mx_platform_python.SpendingPlanIterationItemCreateRequestBody() # SpendingPlanIterationItemCreateRequestBody | Iteration item to be created with required parameters (planned_amount) + + try: + # Create spending plan iteration item + api_response = api_instance.create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body) + print("The response of SpendingPlanApi->create_spending_plan_iteration_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->create_spending_plan_iteration_item: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md)| Iteration item to be created with required parameters (planned_amount) | + +### Return type + +[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_spending_plan** +> delete_spending_plan(user_guid, spending_plan_guid) + +Delete spending plan + +Use this endpoint to delete a user's `spending_plan`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique ID for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + + try: + # Delete spending plan + api_instance.delete_spending_plan(user_guid, spending_plan_guid) + except Exception as e: + print("Exception when calling SpendingPlanApi->delete_spending_plan: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique ID for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_spending_plan_account** +> delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid) + +Delete spending plan account + +Use this endpoint to delete a `spending_plan_account`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique ID for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # str | The unique ID for the specified account. + + try: + # Delete spending plan account + api_instance.delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid) + except Exception as e: + print("Exception when calling SpendingPlanApi->delete_spending_plan_account: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique ID for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **spending_plan_account_guid** | **str**| The unique ID for the specified account. | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_spending_plan_iteration_item** +> delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid) + +Delete spending plan iteration item + +Use this endpoint to delete a spending plan `iteration_item`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique ID for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # str | The unique ID for the `iteration_item`. + + try: + # Delete spending plan iteration item + api_instance.delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid) + except Exception as e: + print("Exception when calling SpendingPlanApi->delete_spending_plan_iteration_item: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique ID for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **iteration_item_guid** | **str**| The unique ID for the `iteration_item`. | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_spending_plan_accounts** +> SpendingPlanAccountsResponse list_spending_plan_accounts(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + +List spending plan accounts + +Use this endpoint to list all the spending plan accounts associated with the spending plan. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_accounts_response import SpendingPlanAccountsResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # List spending plan accounts + api_response = api_instance.list_spending_plan_accounts(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->list_spending_plan_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->list_spending_plan_accounts: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanAccountsResponse**](SpendingPlanAccountsResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_spending_plan_iteration_items** +> SpendingPlanIterationItemsResponseBody list_spending_plan_iteration_items(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + +List spending plan iteration items + +Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_iteration_items_response_body import SpendingPlanIterationItemsResponseBody +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # List spending plan iteration items + api_response = api_instance.list_spending_plan_iteration_items(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->list_spending_plan_iteration_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->list_spending_plan_iteration_items: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanIterationItemsResponseBody**](SpendingPlanIterationItemsResponseBody.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_spending_plan_iterations** +> SpendingPlanIterationsResponse list_spending_plan_iterations(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + +List spending plan iterations + +Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_iterations_response import SpendingPlanIterationsResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # List spending plan iterations + api_response = api_instance.list_spending_plan_iterations(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->list_spending_plan_iterations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->list_spending_plan_iterations: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanIterationsResponse**](SpendingPlanIterationsResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_spending_plans** +> SpendingPlansResponseBody list_spending_plans(user_guid, page=page, records_per_page=records_per_page) + +List spending plans + +Use this endpoint to list all the spending plans associated with the user. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plans_response_body import SpendingPlansResponseBody +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # List spending plans + api_response = api_instance.list_spending_plans(user_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->list_spending_plans:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->list_spending_plans: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlansResponseBody**](SpendingPlansResponseBody.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read_spending_plan_account** +> SpendingPlanAccountResponse read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, page=page, records_per_page=records_per_page) + +Read spending plan account + +Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_account_response import SpendingPlanAccountResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # str | The unique ID for the specified account. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # Read spending plan account + api_response = api_instance.read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->read_spending_plan_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->read_spending_plan_account: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **spending_plan_account_guid** | **str**| The unique ID for the specified account. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanAccountResponse**](SpendingPlanAccountResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read_spending_plan_iteration** +> SpendingPlanIterationResponse read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, page=page, records_per_page=records_per_page) + +Read a spending plan iteration + +Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_iteration_response import SpendingPlanIterationResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + iteration_number = 1 # int | The current iteration number for the spending plan `iteration``. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # Read a spending plan iteration + api_response = api_instance.read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->read_spending_plan_iteration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->read_spending_plan_iteration: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **iteration_number** | **int**| The current iteration number for the spending plan `iteration``. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanIterationResponse**](SpendingPlanIterationResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read_spending_plan_iteration_item** +> SpendingPlanIterationItemResponse read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, page=page, records_per_page=records_per_page) + +Read a spending plan iteration item + +Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # str | The unique ID for the `iteration_item`. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # Read a spending plan iteration item + api_response = api_instance.read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->read_spending_plan_iteration_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->read_spending_plan_iteration_item: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **iteration_item_guid** | **str**| The unique ID for the `iteration_item`. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read_spending_plan_user** +> SpendingPlanResponse read_spending_plan_user(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + +Read a spending plan for a user + +Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_response import SpendingPlanResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + page = 1 # int | Specify current page. (optional) + records_per_page = 10 # int | Specify records per page. (optional) + + try: + # Read a spending plan for a user + api_response = api_instance.read_spending_plan_user(user_guid, spending_plan_guid, page=page, records_per_page=records_per_page) + print("The response of SpendingPlanApi->read_spending_plan_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->read_spending_plan_user: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **page** | **int**| Specify current page. | [optional] + **records_per_page** | **int**| Specify records per page. | [optional] + +### Return type + +[**SpendingPlanResponse**](SpendingPlanResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_spending_plan_iteration_item** +> SpendingPlanIterationItemResponse update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body) + +Update a spending plan iteration item + +Use this endpoint to update an existing `spending_plan_iteration_item`. + +### Example + +* Basic Authentication (basicAuth): +```python +import time +import os +import mx_platform_python +from mx_platform_python.models.spending_plan_iteration_item_create_request_body import SpendingPlanIterationItemCreateRequestBody +from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse +from mx_platform_python.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.mx.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mx_platform_python.Configuration( + host = "https://api.mx.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basicAuth +configuration = mx_platform_python.Configuration( + username = os.environ["USERNAME"], + password = os.environ["PASSWORD"] +) + +# Enter a context with an instance of the API client +with mx_platform_python.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = mx_platform_python.SpendingPlanApi(api_client) + user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # str | The unique id for a `user`. + spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # str | The unique ID for the `spending_plan`. + iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # str | The unique ID for the `iteration_item`. + spending_plan_iteration_item_create_request_body = mx_platform_python.SpendingPlanIterationItemCreateRequestBody() # SpendingPlanIterationItemCreateRequestBody | Iteration item object to be updated with required parameter (iteration_item_guid) + + try: + # Update a spending plan iteration item + api_response = api_instance.update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body) + print("The response of SpendingPlanApi->update_spending_plan_iteration_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SpendingPlanApi->update_spending_plan_iteration_item: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_guid** | **str**| The unique id for a `user`. | + **spending_plan_guid** | **str**| The unique ID for the `spending_plan`. | + **iteration_item_guid** | **str**| The unique ID for the `iteration_item`. | + **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md)| Iteration item object to be updated with required parameter (iteration_item_guid) | + +### Return type + +[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/vnd.mx.api.v1+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mx_platform_python/__init__.py b/mx_platform_python/__init__.py index 1249ca8..086227c 100644 --- a/mx_platform_python/__init__.py +++ b/mx_platform_python/__init__.py @@ -14,10 +14,11 @@ """ # noqa: E501 -__version__ = "0.19.0" +__version__ = "0.20.0" # import apis into sdk package from mx_platform_python.api.mx_platform_api import MxPlatformApi +from mx_platform_python.api.spending_plan_api import SpendingPlanApi # import ApiClient from mx_platform_python.api_response import ApiResponse diff --git a/mx_platform_python/api/__init__.py b/mx_platform_python/api/__init__.py index 02d6e4a..0d9d115 100644 --- a/mx_platform_python/api/__init__.py +++ b/mx_platform_python/api/__init__.py @@ -2,4 +2,5 @@ # import apis into api package from mx_platform_python.api.mx_platform_api import MxPlatformApi +from mx_platform_python.api.spending_plan_api import SpendingPlanApi diff --git a/mx_platform_python/api/mx_platform_api.py b/mx_platform_python/api/mx_platform_api.py index 7736f2e..59528c2 100644 --- a/mx_platform_python/api/mx_platform_api.py +++ b/mx_platform_python/api/mx_platform_api.py @@ -63,15 +63,6 @@ from mx_platform_python.models.o_auth_window_response_body import OAuthWindowResponseBody from mx_platform_python.models.payment_processor_authorization_code_request_body import PaymentProcessorAuthorizationCodeRequestBody from mx_platform_python.models.payment_processor_authorization_code_response_body import PaymentProcessorAuthorizationCodeResponseBody -from mx_platform_python.models.spending_plan_account_response import SpendingPlanAccountResponse -from mx_platform_python.models.spending_plan_accounts_response import SpendingPlanAccountsResponse -from mx_platform_python.models.spending_plan_iteration_item_create_request_body import SpendingPlanIterationItemCreateRequestBody -from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse -from mx_platform_python.models.spending_plan_iteration_items_response_body import SpendingPlanIterationItemsResponseBody -from mx_platform_python.models.spending_plan_iteration_response import SpendingPlanIterationResponse -from mx_platform_python.models.spending_plan_iterations_response import SpendingPlanIterationsResponse -from mx_platform_python.models.spending_plan_response import SpendingPlanResponse -from mx_platform_python.models.spending_plans_response_body import SpendingPlansResponseBody from mx_platform_python.models.statement_response_body import StatementResponseBody from mx_platform_python.models.statements_response_body import StatementsResponseBody from mx_platform_python.models.tag_create_request_body import TagCreateRequestBody @@ -1369,18 +1360,20 @@ def create_member_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. _request_auth=_params.get('_request_auth')) @validate_arguments - def create_spending_plan(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> SpendingPlanResponse: # noqa: E501 - """Create spending plan # noqa: E501 + def create_tag(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tag_create_request_body : Annotated[TagCreateRequestBody, Field(..., description="Tag object to be created with required parameters (tag_guid)")], **kwargs) -> TagResponseBody: # noqa: E501 + """Create tag # noqa: E501 - This endpoint creates a new `spending_plan` for the user. # noqa: E501 + Use this endpoint to create a new custom tag. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_spending_plan(user_guid, async_req=True) + >>> thread = api.create_tag(user_guid, tag_create_request_body, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param tag_create_request_body: Tag object to be created with required parameters (tag_guid) (required) + :type tag_create_request_body: TagCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -1390,27 +1383,29 @@ def create_spending_plan(self, user_guid : Annotated[StrictStr, Field(..., descr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanResponse + :rtype: TagResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the create_spending_plan_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the create_tag_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.create_spending_plan_with_http_info(user_guid, **kwargs) # noqa: E501 + return self.create_tag_with_http_info(user_guid, tag_create_request_body, **kwargs) # noqa: E501 @validate_arguments - def create_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Create spending plan # noqa: E501 + def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tag_create_request_body : Annotated[TagCreateRequestBody, Field(..., description="Tag object to be created with required parameters (tag_guid)")], **kwargs) -> ApiResponse: # noqa: E501 + """Create tag # noqa: E501 - This endpoint creates a new `spending_plan` for the user. # noqa: E501 + Use this endpoint to create a new custom tag. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_spending_plan_with_http_info(user_guid, async_req=True) + >>> thread = api.create_tag_with_http_info(user_guid, tag_create_request_body, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param tag_create_request_body: Tag object to be created with required parameters (tag_guid) (required) + :type tag_create_request_body: TagCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1433,13 +1428,14 @@ def create_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TagResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid' + 'user_guid', + 'tag_create_request_body' ] _all_params.extend( [ @@ -1458,7 +1454,7 @@ def create_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method create_spending_plan" % _key + " to method create_tag" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1480,19 +1476,29 @@ def create_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F _files = {} # process the body parameter _body_params = None + if _params['tag_create_request_body'] is not None: + _body_params = _params['tag_create_request_body'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/vnd.mx.api.v1+json']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanResponse", + '200': "TagResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans', 'POST', + '/users/{user_guid}/tags', 'POST', _path_params, _query_params, _header_params, @@ -1509,22 +1515,20 @@ def create_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F _request_auth=_params.get('_request_auth')) @validate_arguments - def create_spending_plan_iteration_item(self, spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item to be created with required parameters (planned_amount)")], **kwargs) -> SpendingPlanIterationItemResponse: # noqa: E501 - """Create spending plan iteration item # noqa: E501 + def create_tagging(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tagging_create_request_body : Annotated[TaggingCreateRequestBody, Field(..., description="Tagging object to be created with required parameters (tag_guid and transaction_guid)")], **kwargs) -> TaggingResponseBody: # noqa: E501 + """Create tagging # noqa: E501 - This endpoint creates a new `spending_plan_iteration_item`. # noqa: E501 + Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, async_req=True) + >>> thread = api.create_tagging(user_guid, tagging_create_request_body, async_req=True) >>> result = thread.get() - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_iteration_item_create_request_body: Iteration item to be created with required parameters (planned_amount) (required) - :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody + :param tagging_create_request_body: Tagging object to be created with required parameters (tag_guid and transaction_guid) (required) + :type tagging_create_request_body: TaggingCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -1534,31 +1538,29 @@ def create_spending_plan_iteration_item(self, spending_plan_guid : Annotated[Str :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanIterationItemResponse + :rtype: TaggingResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the create_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the create_tagging_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, **kwargs) # noqa: E501 + return self.create_tagging_with_http_info(user_guid, tagging_create_request_body, **kwargs) # noqa: E501 @validate_arguments - def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item to be created with required parameters (planned_amount)")], **kwargs) -> ApiResponse: # noqa: E501 - """Create spending plan iteration item # noqa: E501 + def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tagging_create_request_body : Annotated[TaggingCreateRequestBody, Field(..., description="Tagging object to be created with required parameters (tag_guid and transaction_guid)")], **kwargs) -> ApiResponse: # noqa: E501 + """Create tagging # noqa: E501 - This endpoint creates a new `spending_plan_iteration_item`. # noqa: E501 + Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, async_req=True) + >>> thread = api.create_tagging_with_http_info(user_guid, tagging_create_request_body, async_req=True) >>> result = thread.get() - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_iteration_item_create_request_body: Iteration item to be created with required parameters (planned_amount) (required) - :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody + :param tagging_create_request_body: Tagging object to be created with required parameters (tag_guid and transaction_guid) (required) + :type tagging_create_request_body: TaggingCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1581,15 +1583,14 @@ def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanIterationItemResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TaggingResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'spending_plan_guid', 'user_guid', - 'spending_plan_iteration_item_create_request_body' + 'tagging_create_request_body' ] _all_params.extend( [ @@ -1608,7 +1609,7 @@ def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method create_spending_plan_iteration_item" % _key + " to method create_tagging" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1617,9 +1618,6 @@ def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid # process the path parameters _path_params = {} - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -1633,8 +1631,8 @@ def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid _files = {} # process the body parameter _body_params = None - if _params['spending_plan_iteration_item_create_request_body'] is not None: - _body_params = _params['spending_plan_iteration_item_create_request_body'] + if _params['tagging_create_request_body'] is not None: + _body_params = _params['tagging_create_request_body'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( @@ -1651,11 +1649,11 @@ def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanIterationItemResponse", + '200': "TaggingResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items', 'POST', + '/users/{user_guid}/taggings', 'POST', _path_params, _query_params, _header_params, @@ -1672,20 +1670,20 @@ def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid _request_auth=_params.get('_request_auth')) @validate_arguments - def create_tag(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tag_create_request_body : Annotated[TagCreateRequestBody, Field(..., description="Tag object to be created with required parameters (tag_guid)")], **kwargs) -> TagResponseBody: # noqa: E501 - """Create tag # noqa: E501 + def create_transaction_rule(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], transaction_rule_create_request_body : Annotated[TransactionRuleCreateRequestBody, Field(..., description="TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)")], **kwargs) -> TransactionRuleResponseBody: # noqa: E501 + """Create transaction rule # noqa: E501 - Use this endpoint to create a new custom tag. # noqa: E501 + Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_tag(user_guid, tag_create_request_body, async_req=True) + >>> thread = api.create_transaction_rule(user_guid, transaction_rule_create_request_body, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param tag_create_request_body: Tag object to be created with required parameters (tag_guid) (required) - :type tag_create_request_body: TagCreateRequestBody + :param transaction_rule_create_request_body: TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description) (required) + :type transaction_rule_create_request_body: TransactionRuleCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -1695,29 +1693,29 @@ def create_tag(self, user_guid : Annotated[StrictStr, Field(..., description="Th :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TagResponseBody + :rtype: TransactionRuleResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the create_tag_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the create_transaction_rule_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.create_tag_with_http_info(user_guid, tag_create_request_body, **kwargs) # noqa: E501 + return self.create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, **kwargs) # noqa: E501 @validate_arguments - def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tag_create_request_body : Annotated[TagCreateRequestBody, Field(..., description="Tag object to be created with required parameters (tag_guid)")], **kwargs) -> ApiResponse: # noqa: E501 - """Create tag # noqa: E501 + def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], transaction_rule_create_request_body : Annotated[TransactionRuleCreateRequestBody, Field(..., description="TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)")], **kwargs) -> ApiResponse: # noqa: E501 + """Create transaction rule # noqa: E501 - Use this endpoint to create a new custom tag. # noqa: E501 + Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_tag_with_http_info(user_guid, tag_create_request_body, async_req=True) + >>> thread = api.create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param tag_create_request_body: Tag object to be created with required parameters (tag_guid) (required) - :type tag_create_request_body: TagCreateRequestBody + :param transaction_rule_create_request_body: TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description) (required) + :type transaction_rule_create_request_body: TransactionRuleCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1740,14 +1738,14 @@ def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(TagResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionRuleResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ 'user_guid', - 'tag_create_request_body' + 'transaction_rule_create_request_body' ] _all_params.extend( [ @@ -1766,7 +1764,7 @@ def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method create_tag" % _key + " to method create_transaction_rule" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1788,8 +1786,8 @@ def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., _files = {} # process the body parameter _body_params = None - if _params['tag_create_request_body'] is not None: - _body_params = _params['tag_create_request_body'] + if _params['transaction_rule_create_request_body'] is not None: + _body_params = _params['transaction_rule_create_request_body'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( @@ -1806,11 +1804,11 @@ def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "TagResponseBody", + '200': "TransactionRuleResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/tags', 'POST', + '/users/{user_guid}/transaction_rules', 'POST', _path_params, _query_params, _header_params, @@ -1827,20 +1825,18 @@ def create_tag_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., _request_auth=_params.get('_request_auth')) @validate_arguments - def create_tagging(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tagging_create_request_body : Annotated[TaggingCreateRequestBody, Field(..., description="Tagging object to be created with required parameters (tag_guid and transaction_guid)")], **kwargs) -> TaggingResponseBody: # noqa: E501 - """Create tagging # noqa: E501 + def create_user(self, user_create_request_body : Annotated[UserCreateRequestBody, Field(..., description="User object to be created. (None of these parameters are required, but the user object cannot be empty)")], **kwargs) -> UserResponseBody: # noqa: E501 + """Create user # noqa: E501 - Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. # noqa: E501 + Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_tagging(user_guid, tagging_create_request_body, async_req=True) + >>> thread = api.create_user(user_create_request_body, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param tagging_create_request_body: Tagging object to be created with required parameters (tag_guid and transaction_guid) (required) - :type tagging_create_request_body: TaggingCreateRequestBody + :param user_create_request_body: User object to be created. (None of these parameters are required, but the user object cannot be empty) (required) + :type user_create_request_body: UserCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -1850,29 +1846,27 @@ def create_tagging(self, user_guid : Annotated[StrictStr, Field(..., description :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TaggingResponseBody + :rtype: UserResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the create_tagging_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the create_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.create_tagging_with_http_info(user_guid, tagging_create_request_body, **kwargs) # noqa: E501 + return self.create_user_with_http_info(user_create_request_body, **kwargs) # noqa: E501 @validate_arguments - def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tagging_create_request_body : Annotated[TaggingCreateRequestBody, Field(..., description="Tagging object to be created with required parameters (tag_guid and transaction_guid)")], **kwargs) -> ApiResponse: # noqa: E501 - """Create tagging # noqa: E501 + def create_user_with_http_info(self, user_create_request_body : Annotated[UserCreateRequestBody, Field(..., description="User object to be created. (None of these parameters are required, but the user object cannot be empty)")], **kwargs) -> ApiResponse: # noqa: E501 + """Create user # noqa: E501 - Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. # noqa: E501 + Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_tagging_with_http_info(user_guid, tagging_create_request_body, async_req=True) + >>> thread = api.create_user_with_http_info(user_create_request_body, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param tagging_create_request_body: Tagging object to be created with required parameters (tag_guid and transaction_guid) (required) - :type tagging_create_request_body: TaggingCreateRequestBody + :param user_create_request_body: User object to be created. (None of these parameters are required, but the user object cannot be empty) (required) + :type user_create_request_body: UserCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1895,14 +1889,13 @@ def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(TaggingResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(UserResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', - 'tagging_create_request_body' + 'user_create_request_body' ] _all_params.extend( [ @@ -1921,7 +1914,7 @@ def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(. if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method create_tagging" % _key + " to method create_user" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1930,9 +1923,6 @@ def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(. # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] @@ -1943,8 +1933,8 @@ def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(. _files = {} # process the body parameter _body_params = None - if _params['tagging_create_request_body'] is not None: - _body_params = _params['tagging_create_request_body'] + if _params['user_create_request_body'] is not None: + _body_params = _params['user_create_request_body'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( @@ -1961,11 +1951,11 @@ def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(. _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "TaggingResponseBody", + '200': "UserResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/taggings', 'POST', + '/users', 'POST', _path_params, _query_params, _header_params, @@ -1982,20 +1972,20 @@ def create_tagging_with_http_info(self, user_guid : Annotated[StrictStr, Field(. _request_auth=_params.get('_request_auth')) @validate_arguments - def create_transaction_rule(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], transaction_rule_create_request_body : Annotated[TransactionRuleCreateRequestBody, Field(..., description="TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)")], **kwargs) -> TransactionRuleResponseBody: # noqa: E501 - """Create transaction rule # noqa: E501 + def delete_category(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete category # noqa: E501 - Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. # noqa: E501 + Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_transaction_rule(user_guid, transaction_rule_create_request_body, async_req=True) + >>> thread = api.delete_category(category_guid, user_guid, async_req=True) >>> result = thread.get() + :param category_guid: The unique id for a `category`. (required) + :type category_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param transaction_rule_create_request_body: TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description) (required) - :type transaction_rule_create_request_body: TransactionRuleCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -2005,29 +1995,29 @@ def create_transaction_rule(self, user_guid : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TransactionRuleResponseBody + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the create_transaction_rule_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_category_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, **kwargs) # noqa: E501 + return self.delete_category_with_http_info(category_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], transaction_rule_create_request_body : Annotated[TransactionRuleCreateRequestBody, Field(..., description="TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)")], **kwargs) -> ApiResponse: # noqa: E501 - """Create transaction rule # noqa: E501 + def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete category # noqa: E501 - Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. # noqa: E501 + Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body, async_req=True) + >>> thread = api.delete_category_with_http_info(category_guid, user_guid, async_req=True) >>> result = thread.get() + :param category_guid: The unique id for a `category`. (required) + :type category_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param transaction_rule_create_request_body: TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description) (required) - :type transaction_rule_create_request_body: TransactionRuleCreateRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -2050,14 +2040,14 @@ def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(TransactionRuleResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ - 'user_guid', - 'transaction_rule_create_request_body' + 'category_guid', + 'user_guid' ] _all_params.extend( [ @@ -2076,7 +2066,7 @@ def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method create_transaction_rule" % _key + " to method delete_category" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2085,6 +2075,9 @@ def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr # process the path parameters _path_params = {} + if _params['category_guid']: + _path_params['category_guid'] = _params['category_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -2098,29 +2091,13 @@ def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr _files = {} # process the body parameter _body_params = None - if _params['transaction_rule_create_request_body'] is not None: - _body_params = _params['transaction_rule_create_request_body'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 - _response_types_map = { - '200': "TransactionRuleResponseBody", - } + _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/transaction_rules', 'POST', + '/users/{user_guid}/categories/{category_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -2137,18 +2114,22 @@ def create_transaction_rule_with_http_info(self, user_guid : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def create_user(self, user_create_request_body : Annotated[UserCreateRequestBody, Field(..., description="User object to be created. (None of these parameters are required, but the user object cannot be empty)")], **kwargs) -> UserResponseBody: # noqa: E501 - """Create user # noqa: E501 + def delete_managed_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete managed account # noqa: E501 - Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled. # noqa: E501 + Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_user(user_create_request_body, async_req=True) + >>> thread = api.delete_managed_account(account_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() - :param user_create_request_body: User object to be created. (None of these parameters are required, but the user object cannot be empty) (required) - :type user_create_request_body: UserCreateRequestBody + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -2158,27 +2139,31 @@ def create_user(self, user_create_request_body : Annotated[UserCreateRequestBody :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: UserResponseBody + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the create_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_managed_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.create_user_with_http_info(user_create_request_body, **kwargs) # noqa: E501 + return self.delete_managed_account_with_http_info(account_guid, member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def create_user_with_http_info(self, user_create_request_body : Annotated[UserCreateRequestBody, Field(..., description="User object to be created. (None of these parameters are required, but the user object cannot be empty)")], **kwargs) -> ApiResponse: # noqa: E501 - """Create user # noqa: E501 + def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete managed account # noqa: E501 - Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled. # noqa: E501 + Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_user_with_http_info(user_create_request_body, async_req=True) + >>> thread = api.delete_managed_account_with_http_info(account_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() - :param user_create_request_body: User object to be created. (None of these parameters are required, but the user object cannot be empty) (required) - :type user_create_request_body: UserCreateRequestBody + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -2201,13 +2186,15 @@ def create_user_with_http_info(self, user_create_request_body : Annotated[UserCr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(UserResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ - 'user_create_request_body' + 'account_guid', + 'member_guid', + 'user_guid' ] _all_params.extend( [ @@ -2226,7 +2213,7 @@ def create_user_with_http_info(self, user_create_request_body : Annotated[UserCr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method create_user" % _key + " to method delete_managed_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2235,6 +2222,15 @@ def create_user_with_http_info(self, user_create_request_body : Annotated[UserCr # process the path parameters _path_params = {} + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] @@ -2245,29 +2241,13 @@ def create_user_with_http_info(self, user_create_request_body : Annotated[UserCr _files = {} # process the body parameter _body_params = None - if _params['user_create_request_body'] is not None: - _body_params = _params['user_create_request_body'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 - _response_types_map = { - '200': "UserResponseBody", - } + _response_types_map = {} return self.api_client.call_api( - '/users', 'POST', + '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -2284,18 +2264,18 @@ def create_user_with_http_info(self, user_create_request_body : Annotated[UserCr _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_category(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete category # noqa: E501 + def delete_managed_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete managed member # noqa: E501 - Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 + Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_category(category_guid, user_guid, async_req=True) + >>> thread = api.delete_managed_member(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param category_guid: The unique id for a `category`. (required) - :type category_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2311,23 +2291,23 @@ def delete_category(self, category_guid : Annotated[StrictStr, Field(..., descri """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_category_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_managed_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_category_with_http_info(category_guid, user_guid, **kwargs) # noqa: E501 + return self.delete_managed_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete category # noqa: E501 + def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete managed member # noqa: E501 - Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 + Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_category_with_http_info(category_guid, user_guid, async_req=True) + >>> thread = api.delete_managed_member_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param category_guid: The unique id for a `category`. (required) - :type category_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2358,7 +2338,7 @@ def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Fi _params = locals() _all_params = [ - 'category_guid', + 'member_guid', 'user_guid' ] _all_params.extend( @@ -2378,7 +2358,7 @@ def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Fi if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_category" % _key + " to method delete_managed_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2387,8 +2367,8 @@ def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Fi # process the path parameters _path_params = {} - if _params['category_guid']: - _path_params['category_guid'] = _params['category_guid'] + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -2409,7 +2389,7 @@ def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Fi _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/categories/{category_guid}', 'DELETE', + '/users/{user_guid}/managed_members/{member_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -2426,20 +2406,22 @@ def delete_category_with_http_info(self, category_guid : Annotated[StrictStr, Fi _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_managed_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete managed account # noqa: E501 + def delete_managed_transaction(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete managed transaction # noqa: E501 - Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`. # noqa: E501 + Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_managed_account(account_guid, member_guid, user_guid, async_req=True) + >>> thread = api.delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, async_req=True) >>> result = thread.get() :param account_guid: The unique id for an `account`. (required) :type account_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str + :param transaction_guid: The unique id for a `transaction`. (required) + :type transaction_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2455,25 +2437,27 @@ def delete_managed_account(self, account_guid : Annotated[StrictStr, Field(..., """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_managed_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_managed_transaction_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_managed_account_with_http_info(account_guid, member_guid, user_guid, **kwargs) # noqa: E501 + return self.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete managed account # noqa: E501 + def delete_managed_transaction_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete managed transaction # noqa: E501 - Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`. # noqa: E501 + Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_managed_account_with_http_info(account_guid, member_guid, user_guid, async_req=True) + >>> thread = api.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, async_req=True) >>> result = thread.get() :param account_guid: The unique id for an `account`. (required) :type account_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str + :param transaction_guid: The unique id for a `transaction`. (required) + :type transaction_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2506,6 +2490,7 @@ def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictS _all_params = [ 'account_guid', 'member_guid', + 'transaction_guid', 'user_guid' ] _all_params.extend( @@ -2525,7 +2510,7 @@ def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictS if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_managed_account" % _key + " to method delete_managed_transaction" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2540,6 +2525,9 @@ def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictS if _params['member_guid']: _path_params['member_guid'] = _params['member_guid'] + if _params['transaction_guid']: + _path_params['transaction_guid'] = _params['transaction_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -2559,7 +2547,7 @@ def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictS _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}', 'DELETE', + '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -2576,18 +2564,18 @@ def delete_managed_account_with_http_info(self, account_guid : Annotated[StrictS _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_managed_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete managed member # noqa: E501 + def delete_manual_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete manual account # noqa: E501 - Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 + This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_managed_member(member_guid, user_guid, async_req=True) + >>> thread = api.delete_manual_account(account_guid, user_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2603,23 +2591,23 @@ def delete_managed_member(self, member_guid : Annotated[StrictStr, Field(..., de """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_managed_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_manual_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_managed_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.delete_manual_account_with_http_info(account_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete managed member # noqa: E501 + def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete manual account # noqa: E501 - Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 + This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_managed_member_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.delete_manual_account_with_http_info(account_guid, user_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2650,7 +2638,7 @@ def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr _params = locals() _all_params = [ - 'member_guid', + 'account_guid', 'user_guid' ] _all_params.extend( @@ -2670,7 +2658,7 @@ def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_managed_member" % _key + " to method delete_manual_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2679,8 +2667,8 @@ def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -2701,7 +2689,7 @@ def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}', 'DELETE', + '/users/{user_guid}/accounts/{account_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -2718,22 +2706,18 @@ def delete_managed_member_with_http_info(self, member_guid : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_managed_transaction(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete managed transaction # noqa: E501 + def delete_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete member # noqa: E501 - Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 + Accessing this endpoint will permanently delete a member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, async_req=True) + >>> thread = api.delete_member(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param transaction_guid: The unique id for a `transaction`. (required) - :type transaction_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2749,27 +2733,23 @@ def delete_managed_transaction(self, account_guid : Annotated[StrictStr, Field(. """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_managed_transaction_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, **kwargs) # noqa: E501 + return self.delete_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_managed_transaction_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete managed transaction # noqa: E501 + def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete member # noqa: E501 - Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource. # noqa: E501 + Accessing this endpoint will permanently delete a member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, async_req=True) + >>> thread = api.delete_member_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param transaction_guid: The unique id for a `transaction`. (required) - :type transaction_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2800,9 +2780,7 @@ def delete_managed_transaction_with_http_info(self, account_guid : Annotated[Str _params = locals() _all_params = [ - 'account_guid', 'member_guid', - 'transaction_guid', 'user_guid' ] _all_params.extend( @@ -2822,7 +2800,7 @@ def delete_managed_transaction_with_http_info(self, account_guid : Annotated[Str if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_managed_transaction" % _key + " to method delete_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2831,15 +2809,9 @@ def delete_managed_transaction_with_http_info(self, account_guid : Annotated[Str # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - if _params['member_guid']: _path_params['member_guid'] = _params['member_guid'] - if _params['transaction_guid']: - _path_params['transaction_guid'] = _params['transaction_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -2859,7 +2831,7 @@ def delete_managed_transaction_with_http_info(self, account_guid : Annotated[Str _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}', 'DELETE', + '/users/{user_guid}/members/{member_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -2876,18 +2848,18 @@ def delete_managed_transaction_with_http_info(self, account_guid : Annotated[Str _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_manual_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete manual account # noqa: E501 + def delete_tag(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete tag # noqa: E501 - This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 + Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_manual_account(account_guid, user_guid, async_req=True) + >>> thread = api.delete_tag(tag_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str + :param tag_guid: The unique id for a `tag`. (required) + :type tag_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2903,23 +2875,23 @@ def delete_manual_account(self, account_guid : Annotated[StrictStr, Field(..., d """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_manual_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_tag_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_manual_account_with_http_info(account_guid, user_guid, **kwargs) # noqa: E501 + return self.delete_tag_with_http_info(tag_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete manual account # noqa: E501 + def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete tag # noqa: E501 - This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. # noqa: E501 + Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_manual_account_with_http_info(account_guid, user_guid, async_req=True) + >>> thread = api.delete_tag_with_http_info(tag_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str + :param tag_guid: The unique id for a `tag`. (required) + :type tag_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -2950,7 +2922,7 @@ def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictSt _params = locals() _all_params = [ - 'account_guid', + 'tag_guid', 'user_guid' ] _all_params.extend( @@ -2970,7 +2942,7 @@ def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictSt if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_manual_account" % _key + " to method delete_tag" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2979,8 +2951,8 @@ def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictSt # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] + if _params['tag_guid']: + _path_params['tag_guid'] = _params['tag_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -3001,7 +2973,7 @@ def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictSt _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/accounts/{account_guid}', 'DELETE', + '/users/{user_guid}/tags/{tag_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -3018,18 +2990,18 @@ def delete_manual_account_with_http_info(self, account_guid : Annotated[StrictSt _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete member # noqa: E501 + def delete_tagging(self, tagging_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tagging`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete tagging # noqa: E501 - Accessing this endpoint will permanently delete a member. # noqa: E501 + Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_member(member_guid, user_guid, async_req=True) + >>> thread = api.delete_tagging(tagging_guid, user_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param tagging_guid: The unique id for a `tagging`. (required) + :type tagging_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -3045,23 +3017,23 @@ def delete_member(self, member_guid : Annotated[StrictStr, Field(..., descriptio """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_tagging_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.delete_tagging_with_http_info(tagging_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete member # noqa: E501 + def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tagging`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete tagging # noqa: E501 - Accessing this endpoint will permanently delete a member. # noqa: E501 + Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_member_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.delete_tagging_with_http_info(tagging_guid, user_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param tagging_guid: The unique id for a `tagging`. (required) + :type tagging_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -3092,7 +3064,7 @@ def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field( _params = locals() _all_params = [ - 'member_guid', + 'tagging_guid', 'user_guid' ] _all_params.extend( @@ -3112,7 +3084,7 @@ def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field( if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_member" % _key + " to method delete_tagging" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3121,8 +3093,8 @@ def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field( # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] + if _params['tagging_guid']: + _path_params['tagging_guid'] = _params['tagging_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -3143,7 +3115,7 @@ def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field( _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}', 'DELETE', + '/users/{user_guid}/taggings/{tagging_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -3160,20 +3132,20 @@ def delete_member_with_http_info(self, member_guid : Annotated[StrictStr, Field( _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_spending_plan(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], **kwargs) -> None: # noqa: E501 - """Delete spending plan # noqa: E501 - - Use this endpoint to delete a user's `spending_plan`. # noqa: E501 + def delete_transaction_rule(self, transaction_rule_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction_rule`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete transaction rule # noqa: E501 + + Use this endpoint to permanently delete a transaction rule based on its unique GUID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_spending_plan(user_guid, spending_plan_guid, async_req=True) + >>> thread = api.delete_transaction_rule(transaction_rule_guid, user_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique ID for a `user`. (required) + :param transaction_rule_guid: The unique id for a `transaction_rule`. (required) + :type transaction_rule_guid: str + :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -3187,25 +3159,25 @@ def delete_spending_plan(self, user_guid : Annotated[StrictStr, Field(..., descr """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_spending_plan_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_transaction_rule_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_spending_plan_with_http_info(user_guid, spending_plan_guid, **kwargs) # noqa: E501 + return self.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete spending plan # noqa: E501 + def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction_rule`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete transaction rule # noqa: E501 - Use this endpoint to delete a user's `spending_plan`. # noqa: E501 + Use this endpoint to permanently delete a transaction rule based on its unique GUID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_spending_plan_with_http_info(user_guid, spending_plan_guid, async_req=True) + >>> thread = api.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique ID for a `user`. (required) + :param transaction_rule_guid: The unique id for a `transaction_rule`. (required) + :type transaction_rule_guid: str + :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -3234,8 +3206,8 @@ def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid' + 'transaction_rule_guid', + 'user_guid' ] _all_params.extend( [ @@ -3254,7 +3226,7 @@ def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_spending_plan" % _key + " to method delete_transaction_rule" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3263,12 +3235,12 @@ def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F # process the path parameters _path_params = {} + if _params['transaction_rule_guid']: + _path_params['transaction_rule_guid'] = _params['transaction_rule_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - # process the query parameters _query_params = [] @@ -3285,7 +3257,7 @@ def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}', 'DELETE', + '/users/{user_guid}/transaction_rules/{transaction_rule_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -3302,22 +3274,18 @@ def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, F _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_spending_plan_account(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], **kwargs) -> None: # noqa: E501 - """Delete spending plan account # noqa: E501 + def delete_user(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 + """Delete user # noqa: E501 - Use this endpoint to delete a `spending_plan_account`. # noqa: E501 + Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, async_req=True) + >>> thread = api.delete_user(user_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique ID for a `user`. (required) + :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param spending_plan_account_guid: The unique ID for the specified account. (required) - :type spending_plan_account_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -3331,27 +3299,23 @@ def delete_spending_plan_account(self, user_guid : Annotated[StrictStr, Field(.. """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_spending_plan_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the delete_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, **kwargs) # noqa: E501 + return self.delete_user_with_http_info(user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete spending plan account # noqa: E501 + def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete user # noqa: E501 - Use this endpoint to delete a `spending_plan_account`. # noqa: E501 + Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, async_req=True) + >>> thread = api.delete_user_with_http_info(user_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique ID for a `user`. (required) + :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param spending_plan_account_guid: The unique ID for the specified account. (required) - :type spending_plan_account_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -3380,9 +3344,7 @@ def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[Stri _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'spending_plan_account_guid' + 'user_guid' ] _all_params.extend( [ @@ -3401,7 +3363,7 @@ def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[Stri if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_spending_plan_account" % _key + " to method delete_user" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3413,12 +3375,6 @@ def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[Stri if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - - if _params['spending_plan_account_guid']: - _path_params['spending_plan_account_guid'] = _params['spending_plan_account_guid'] - # process the query parameters _query_params = [] @@ -3435,7 +3391,7 @@ def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[Stri _response_types_map = {} return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}', 'DELETE', + '/users/{user_guid}', 'DELETE', _path_params, _query_params, _header_params, @@ -3452,22 +3408,18 @@ def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[Stri _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], **kwargs) -> None: # noqa: E501 - """Delete spending plan iteration item # noqa: E501 + def deprecated_request_payment_processor_authorization_code(self, payment_processor_authorization_code_request_body : Annotated[PaymentProcessorAuthorizationCodeRequestBody, Field(..., description="The scope for the authorization code.")], **kwargs) -> PaymentProcessorAuthorizationCodeResponseBody: # noqa: E501 + """(Deprecated) Request an authorization code. # noqa: E501 - Use this endpoint to delete a spending plan `iteration_item`. # noqa: E501 + (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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, async_req=True) + >>> thread = api.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body, async_req=True) >>> result = thread.get() - :param user_guid: The unique ID for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_item_guid: The unique ID for the `iteration_item`. (required) - :type iteration_item_guid: str + :param payment_processor_authorization_code_request_body: The scope for the authorization code. (required) + :type payment_processor_authorization_code_request_body: PaymentProcessorAuthorizationCodeRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -3477,31 +3429,27 @@ def delete_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: PaymentProcessorAuthorizationCodeResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the deprecated_request_payment_processor_authorization_code_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, **kwargs) # noqa: E501 + return self.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, **kwargs) # noqa: E501 @validate_arguments - def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete spending plan iteration item # noqa: E501 + def deprecated_request_payment_processor_authorization_code_with_http_info(self, payment_processor_authorization_code_request_body : Annotated[PaymentProcessorAuthorizationCodeRequestBody, Field(..., description="The scope for the authorization code.")], **kwargs) -> ApiResponse: # noqa: E501 + """(Deprecated) Request an authorization code. # noqa: E501 - Use this endpoint to delete a spending plan `iteration_item`. # noqa: E501 + (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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, async_req=True) + >>> thread = api.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, async_req=True) >>> result = thread.get() - :param user_guid: The unique ID for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_item_guid: The unique ID for the `iteration_item`. (required) - :type iteration_item_guid: str + :param payment_processor_authorization_code_request_body: The scope for the authorization code. (required) + :type payment_processor_authorization_code_request_body: PaymentProcessorAuthorizationCodeRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -3524,15 +3472,13 @@ def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotat :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(PaymentProcessorAuthorizationCodeResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'iteration_item_guid' + 'payment_processor_authorization_code_request_body' ] _all_params.extend( [ @@ -3551,7 +3497,7 @@ def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotat if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_spending_plan_iteration_item" % _key + " to method deprecated_request_payment_processor_authorization_code" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3560,15 +3506,6 @@ def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotat # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - - if _params['iteration_item_guid']: - _path_params['iteration_item_guid'] = _params['iteration_item_guid'] - # process the query parameters _query_params = [] @@ -3579,13 +3516,29 @@ def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotat _files = {} # process the body parameter _body_params = None + if _params['payment_processor_authorization_code_request_body'] is not None: + _body_params = _params['payment_processor_authorization_code_request_body'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "PaymentProcessorAuthorizationCodeResponseBody", + } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}', 'DELETE', + '/payment_processor_authorization_code', 'POST', _path_params, _query_params, _header_params, @@ -3602,18 +3555,20 @@ def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotat _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_tag(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete tag # noqa: E501 + def download_statement_pdf(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], statement_guid : Annotated[StrictStr, Field(..., description="The unique id for a `statement`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> bytearray: # noqa: E501 + """Download statement pdf # noqa: E501 - Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. # noqa: E501 + Use this endpoint to download a specified statement PDF. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_tag(tag_guid, user_guid, async_req=True) + >>> thread = api.download_statement_pdf(member_guid, statement_guid, user_guid, async_req=True) >>> result = thread.get() - :param tag_guid: The unique id for a `tag`. (required) - :type tag_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param statement_guid: The unique id for a `statement`. (required) + :type statement_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -3625,27 +3580,29 @@ def delete_tag(self, tag_guid : Annotated[StrictStr, Field(..., description="The :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: bytearray """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_tag_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the download_statement_pdf_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_tag_with_http_info(tag_guid, user_guid, **kwargs) # noqa: E501 + return self.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete tag # noqa: E501 + def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], statement_guid : Annotated[StrictStr, Field(..., description="The unique id for a `statement`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Download statement pdf # noqa: E501 - Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. # noqa: E501 + Use this endpoint to download a specified statement PDF. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_tag_with_http_info(tag_guid, user_guid, async_req=True) + >>> thread = api.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, async_req=True) >>> result = thread.get() - :param tag_guid: The unique id for a `tag`. (required) - :type tag_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param statement_guid: The unique id for a `statement`. (required) + :type statement_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -3670,13 +3627,14 @@ def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., d :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(bytearray, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'tag_guid', + 'member_guid', + 'statement_guid', 'user_guid' ] _all_params.extend( @@ -3696,7 +3654,7 @@ def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., d if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_tag" % _key + " to method download_statement_pdf" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3705,8 +3663,11 @@ def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., d # process the path parameters _path_params = {} - if _params['tag_guid']: - _path_params['tag_guid'] = _params['tag_guid'] + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['statement_guid']: + _path_params['statement_guid'] = _params['statement_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -3721,13 +3682,19 @@ def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., d _files = {} # process the body parameter _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+pdf']) # noqa: E501 + # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "bytearray", + } return self.api_client.call_api( - '/users/{user_guid}/tags/{tag_guid}', 'DELETE', + '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf', 'GET', _path_params, _query_params, _header_params, @@ -3744,18 +3711,20 @@ def delete_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., d _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_tagging(self, tagging_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tagging`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete tagging # noqa: E501 + def download_tax_document(self, tax_document_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tax_document`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> bytearray: # noqa: E501 + """Download a Tax Document PDF # noqa: E501 - Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. # noqa: E501 + 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_tagging(tagging_guid, user_guid, async_req=True) + >>> thread = api.download_tax_document(tax_document_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() - :param tagging_guid: The unique id for a `tagging`. (required) - :type tagging_guid: str + :param tax_document_guid: The unique id for a `tax_document`. (required) + :type tax_document_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -3767,27 +3736,29 @@ def delete_tagging(self, tagging_guid : Annotated[StrictStr, Field(..., descript :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: bytearray """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_tagging_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the download_tax_document_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_tagging_with_http_info(tagging_guid, user_guid, **kwargs) # noqa: E501 + return self.download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tagging`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete tagging # noqa: E501 + def download_tax_document_with_http_info(self, tax_document_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tax_document`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Download a Tax Document PDF # noqa: E501 - Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. # noqa: E501 + 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_tagging_with_http_info(tagging_guid, user_guid, async_req=True) + >>> thread = api.download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() - :param tagging_guid: The unique id for a `tagging`. (required) - :type tagging_guid: str + :param tax_document_guid: The unique id for a `tax_document`. (required) + :type tax_document_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -3812,13 +3783,14 @@ def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Fiel :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(bytearray, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'tagging_guid', + 'tax_document_guid', + 'member_guid', 'user_guid' ] _all_params.extend( @@ -3838,7 +3810,7 @@ def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Fiel if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_tagging" % _key + " to method download_tax_document" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3847,8 +3819,11 @@ def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Fiel # process the path parameters _path_params = {} - if _params['tagging_guid']: - _path_params['tagging_guid'] = _params['tagging_guid'] + if _params['tax_document_guid']: + _path_params['tax_document_guid'] = _params['tax_document_guid'] + + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -3863,13 +3838,19 @@ def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Fiel _files = {} # process the body parameter _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+pdf']) # noqa: E501 + # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "bytearray", + } return self.api_client.call_api( - '/users/{user_guid}/taggings/{tagging_guid}', 'DELETE', + '/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf', 'GET', _path_params, _query_params, _header_params, @@ -3886,20 +3867,18 @@ def delete_tagging_with_http_info(self, tagging_guid : Annotated[StrictStr, Fiel _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_transaction_rule(self, transaction_rule_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction_rule`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete transaction rule # noqa: E501 + def enhance_transactions(self, enhance_transactions_request_body : Annotated[EnhanceTransactionsRequestBody, Field(..., description="Transaction object to be enhanced")], **kwargs) -> EnhanceTransactionsResponseBody: # noqa: E501 + """Enhance transactions # noqa: E501 - Use this endpoint to permanently delete a transaction rule based on its unique GUID. # noqa: E501 + Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_transaction_rule(transaction_rule_guid, user_guid, async_req=True) + >>> thread = api.enhance_transactions(enhance_transactions_request_body, async_req=True) >>> result = thread.get() - :param transaction_rule_guid: The unique id for a `transaction_rule`. (required) - :type transaction_rule_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param enhance_transactions_request_body: Transaction object to be enhanced (required) + :type enhance_transactions_request_body: EnhanceTransactionsRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -3909,29 +3888,27 @@ def delete_transaction_rule(self, transaction_rule_guid : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: EnhanceTransactionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_transaction_rule_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the enhance_transactions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, **kwargs) # noqa: E501 + return self.enhance_transactions_with_http_info(enhance_transactions_request_body, **kwargs) # noqa: E501 @validate_arguments - def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction_rule`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete transaction rule # noqa: E501 + def enhance_transactions_with_http_info(self, enhance_transactions_request_body : Annotated[EnhanceTransactionsRequestBody, Field(..., description="Transaction object to be enhanced")], **kwargs) -> ApiResponse: # noqa: E501 + """Enhance transactions # noqa: E501 - Use this endpoint to permanently delete a transaction rule based on its unique GUID. # noqa: E501 + Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid, async_req=True) + >>> thread = api.enhance_transactions_with_http_info(enhance_transactions_request_body, async_req=True) >>> result = thread.get() - :param transaction_rule_guid: The unique id for a `transaction_rule`. (required) - :type transaction_rule_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param enhance_transactions_request_body: Transaction object to be enhanced (required) + :type enhance_transactions_request_body: EnhanceTransactionsRequestBody :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -3954,14 +3931,13 @@ def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotat :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(EnhanceTransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'transaction_rule_guid', - 'user_guid' + 'enhance_transactions_request_body' ] _all_params.extend( [ @@ -3980,7 +3956,7 @@ def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotat if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_transaction_rule" % _key + " to method enhance_transactions" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3989,12 +3965,6 @@ def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotat # process the path parameters _path_params = {} - if _params['transaction_rule_guid']: - _path_params['transaction_rule_guid'] = _params['transaction_rule_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] @@ -4005,13 +3975,29 @@ def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotat _files = {} # process the body parameter _body_params = None - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 + if _params['enhance_transactions_request_body'] is not None: + _body_params = _params['enhance_transactions_request_body'] - _response_types_map = {} + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "EnhanceTransactionsResponseBody", + } return self.api_client.call_api( - '/users/{user_guid}/transaction_rules/{transaction_rule_guid}', 'DELETE', + '/transactions/enhance', 'POST', _path_params, _query_params, _header_params, @@ -4028,17 +4014,19 @@ def delete_transaction_rule_with_http_info(self, transaction_rule_guid : Annotat _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_user(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> None: # noqa: E501 - """Delete user # noqa: E501 + def extend_history(self, member_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 + """Extend history # noqa: E501 - Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. # noqa: E501 + Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_user(user_guid, async_req=True) + >>> thread = api.extend_history(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) + :param member_guid: The unique identifier for a `member`. (required) + :type member_guid: str + :param user_guid: The unique identifier for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -4049,26 +4037,28 @@ def delete_user(self, user_guid : Annotated[StrictStr, Field(..., description="T :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: MemberResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the delete_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the extend_history_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.delete_user_with_http_info(user_guid, **kwargs) # noqa: E501 + return self.extend_history_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete user # noqa: E501 + def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Extend history # noqa: E501 - Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. # noqa: E501 + Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_user_with_http_info(user_guid, async_req=True) + >>> thread = api.extend_history_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) + :param member_guid: The unique identifier for a `member`. (required) + :type member_guid: str + :param user_guid: The unique identifier for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -4092,12 +4082,13 @@ def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'member_guid', 'user_guid' ] _all_params.extend( @@ -4117,7 +4108,7 @@ def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method delete_user" % _key + " to method extend_history" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4126,6 +4117,9 @@ def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -4139,13 +4133,19 @@ def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., _files = {} # process the body parameter _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '202': "MemberResponseBody", + } return self.api_client.call_api( - '/users/{user_guid}', 'DELETE', + '/users/{user_guid}/members/{member_guid}/extend_history', 'POST', _path_params, _query_params, _header_params, @@ -4162,18 +4162,20 @@ def delete_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., _request_auth=_params.get('_request_auth')) @validate_arguments - def deprecated_request_payment_processor_authorization_code(self, payment_processor_authorization_code_request_body : Annotated[PaymentProcessorAuthorizationCodeRequestBody, Field(..., description="The scope for the authorization code.")], **kwargs) -> PaymentProcessorAuthorizationCodeResponseBody: # noqa: E501 - """(Deprecated) Request an authorization code. # noqa: E501 + def fetch_statements(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 + """Fetch statements # noqa: E501 - (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. # noqa: E501 + Use this endpoint to fetch the statements associated with a particular member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body, async_req=True) + >>> thread = api.fetch_statements(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param payment_processor_authorization_code_request_body: The scope for the authorization code. (required) - :type payment_processor_authorization_code_request_body: PaymentProcessorAuthorizationCodeRequestBody + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -4183,27 +4185,29 @@ def deprecated_request_payment_processor_authorization_code(self, payment_proces :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: PaymentProcessorAuthorizationCodeResponseBody + :rtype: MemberResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the deprecated_request_payment_processor_authorization_code_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the fetch_statements_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, **kwargs) # noqa: E501 + return self.fetch_statements_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def deprecated_request_payment_processor_authorization_code_with_http_info(self, payment_processor_authorization_code_request_body : Annotated[PaymentProcessorAuthorizationCodeRequestBody, Field(..., description="The scope for the authorization code.")], **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Request an authorization code. # noqa: E501 + def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Fetch statements # noqa: E501 - (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. # noqa: E501 + Use this endpoint to fetch the statements associated with a particular member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, async_req=True) + >>> thread = api.fetch_statements_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param payment_processor_authorization_code_request_body: The scope for the authorization code. (required) - :type payment_processor_authorization_code_request_body: PaymentProcessorAuthorizationCodeRequestBody + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -4226,13 +4230,14 @@ def deprecated_request_payment_processor_authorization_code_with_http_info(self, :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(PaymentProcessorAuthorizationCodeResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'payment_processor_authorization_code_request_body' + 'member_guid', + 'user_guid' ] _all_params.extend( [ @@ -4251,7 +4256,7 @@ def deprecated_request_payment_processor_authorization_code_with_http_info(self, if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method deprecated_request_payment_processor_authorization_code" % _key + " to method fetch_statements" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4260,6 +4265,12 @@ def deprecated_request_payment_processor_authorization_code_with_http_info(self, # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] @@ -4270,29 +4281,19 @@ def deprecated_request_payment_processor_authorization_code_with_http_info(self, _files = {} # process the body parameter _body_params = None - if _params['payment_processor_authorization_code_request_body'] is not None: - _body_params = _params['payment_processor_authorization_code_request_body'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/vnd.mx.api.v1+json']) # noqa: E501 - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "PaymentProcessorAuthorizationCodeResponseBody", + '202': "MemberResponseBody", } return self.api_client.call_api( - '/payment_processor_authorization_code', 'POST', + '/users/{user_guid}/members/{member_guid}/fetch_statements', 'POST', _path_params, _query_params, _header_params, @@ -4309,20 +4310,18 @@ def deprecated_request_payment_processor_authorization_code_with_http_info(self, _request_auth=_params.get('_request_auth')) @validate_arguments - def download_statement_pdf(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], statement_guid : Annotated[StrictStr, Field(..., description="The unique id for a `statement`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> bytearray: # noqa: E501 - """Download statement pdf # noqa: E501 + def fetch_tax_documents(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 + """Fetch Tax Documents # noqa: E501 - Use this endpoint to download a specified statement PDF. # noqa: E501 + 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.download_statement_pdf(member_guid, statement_guid, user_guid, async_req=True) + >>> thread = api.fetch_tax_documents(member_guid, user_guid, async_req=True) >>> result = thread.get() :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param statement_guid: The unique id for a `statement`. (required) - :type statement_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -4334,29 +4333,27 @@ def download_statement_pdf(self, member_guid : Annotated[StrictStr, Field(..., d :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: bytearray + :rtype: MemberResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the download_statement_pdf_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the fetch_tax_documents_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, **kwargs) # noqa: E501 + return self.fetch_tax_documents_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], statement_guid : Annotated[StrictStr, Field(..., description="The unique id for a `statement`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Download statement pdf # noqa: E501 + def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Fetch Tax Documents # noqa: E501 - Use this endpoint to download a specified statement PDF. # noqa: E501 + 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid, async_req=True) + >>> thread = api.fetch_tax_documents_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param statement_guid: The unique id for a `statement`. (required) - :type statement_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -4381,14 +4378,13 @@ def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictSt :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(bytearray, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ 'member_guid', - 'statement_guid', 'user_guid' ] _all_params.extend( @@ -4408,7 +4404,7 @@ def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictSt if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method download_statement_pdf" % _key + " to method fetch_tax_documents" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4420,9 +4416,6 @@ def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictSt if _params['member_guid']: _path_params['member_guid'] = _params['member_guid'] - if _params['statement_guid']: - _path_params['statement_guid'] = _params['statement_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -4438,17 +4431,17 @@ def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictSt _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+pdf']) # noqa: E501 + ['application/vnd.mx.api.v1+json']) # noqa: E501 # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "bytearray", + '202': "MemberResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf', 'GET', + '/users/{user_guid}/members/{member_guid}/fetch_tax_documents', 'POST', _path_params, _query_params, _header_params, @@ -4465,18 +4458,16 @@ def download_statement_pdf_with_http_info(self, member_guid : Annotated[StrictSt _request_auth=_params.get('_request_auth')) @validate_arguments - def download_tax_document(self, tax_document_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tax_document`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> bytearray: # noqa: E501 - """Download a Tax Document PDF # noqa: E501 + def identify_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 + """Identify member # noqa: E501 - 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. # noqa: E501 + The identify endpoint begins an identification process for an already-existing member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.download_tax_document(tax_document_guid, member_guid, user_guid, async_req=True) + >>> thread = api.identify_member(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param tax_document_guid: The unique id for a `tax_document`. (required) - :type tax_document_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str :param user_guid: The unique id for a `user`. (required) @@ -4490,27 +4481,25 @@ def download_tax_document(self, tax_document_guid : Annotated[StrictStr, Field(. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: bytearray + :rtype: MemberResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the download_tax_document_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the identify_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, **kwargs) # noqa: E501 + return self.identify_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def download_tax_document_with_http_info(self, tax_document_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tax_document`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Download a Tax Document PDF # noqa: E501 + def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Identify member # noqa: E501 - 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. # noqa: E501 + The identify endpoint begins an identification process for an already-existing member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.download_tax_document_with_http_info(tax_document_guid, member_guid, user_guid, async_req=True) + >>> thread = api.identify_member_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param tax_document_guid: The unique id for a `tax_document`. (required) - :type tax_document_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str :param user_guid: The unique id for a `user`. (required) @@ -4537,13 +4526,12 @@ def download_tax_document_with_http_info(self, tax_document_guid : Annotated[Str :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(bytearray, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'tax_document_guid', 'member_guid', 'user_guid' ] @@ -4564,7 +4552,7 @@ def download_tax_document_with_http_info(self, tax_document_guid : Annotated[Str if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method download_tax_document" % _key + " to method identify_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4573,9 +4561,6 @@ def download_tax_document_with_http_info(self, tax_document_guid : Annotated[Str # process the path parameters _path_params = {} - if _params['tax_document_guid']: - _path_params['tax_document_guid'] = _params['tax_document_guid'] - if _params['member_guid']: _path_params['member_guid'] = _params['member_guid'] @@ -4594,17 +4579,17 @@ def download_tax_document_with_http_info(self, tax_document_guid : Annotated[Str _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+pdf']) # noqa: E501 + ['application/vnd.mx.api.v1+json']) # noqa: E501 # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "bytearray", + '202': "MemberResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf', 'GET', + '/users/{user_guid}/members/{member_guid}/identify', 'POST', _path_params, _query_params, _header_params, @@ -4621,18 +4606,24 @@ def download_tax_document_with_http_info(self, tax_document_guid : Annotated[Str _request_auth=_params.get('_request_auth')) @validate_arguments - def enhance_transactions(self, enhance_transactions_request_body : Annotated[EnhanceTransactionsRequestBody, Field(..., description="Transaction object to be enhanced")], **kwargs) -> EnhanceTransactionsResponseBody: # noqa: E501 - """Enhance transactions # noqa: E501 + def list_account_numbers_by_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountNumbersResponseBody: # noqa: E501 + """List account numbers by account # noqa: E501 - Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. # noqa: E501 + This endpoint returns a list of account numbers associated with the specified `account`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.enhance_transactions(enhance_transactions_request_body, async_req=True) + >>> thread = api.list_account_numbers_by_account(account_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param enhance_transactions_request_body: Transaction object to be enhanced (required) - :type enhance_transactions_request_body: EnhanceTransactionsRequestBody + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -4642,27 +4633,33 @@ def enhance_transactions(self, enhance_transactions_request_body : Annotated[Enh :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: EnhanceTransactionsResponseBody + :rtype: AccountNumbersResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the enhance_transactions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_account_numbers_by_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.enhance_transactions_with_http_info(enhance_transactions_request_body, **kwargs) # noqa: E501 + return self.list_account_numbers_by_account_with_http_info(account_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def enhance_transactions_with_http_info(self, enhance_transactions_request_body : Annotated[EnhanceTransactionsRequestBody, Field(..., description="Transaction object to be enhanced")], **kwargs) -> ApiResponse: # noqa: E501 - """Enhance transactions # noqa: E501 + def list_account_numbers_by_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List account numbers by account # noqa: E501 - Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. # noqa: E501 + This endpoint returns a list of account numbers associated with the specified `account`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.enhance_transactions_with_http_info(enhance_transactions_request_body, async_req=True) + >>> thread = api.list_account_numbers_by_account_with_http_info(account_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param enhance_transactions_request_body: Transaction object to be enhanced (required) - :type enhance_transactions_request_body: EnhanceTransactionsRequestBody + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -4685,13 +4682,16 @@ def enhance_transactions_with_http_info(self, enhance_transactions_request_body :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(EnhanceTransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountNumbersResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'enhance_transactions_request_body' + 'account_guid', + 'user_guid', + 'page', + 'records_per_page' ] _all_params.extend( [ @@ -4710,7 +4710,7 @@ def enhance_transactions_with_http_info(self, enhance_transactions_request_body if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method enhance_transactions" % _key + " to method list_account_numbers_by_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4719,9 +4719,21 @@ def enhance_transactions_with_http_info(self, enhance_transactions_request_body # process the path parameters _path_params = {} + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -4729,29 +4741,19 @@ def enhance_transactions_with_http_info(self, enhance_transactions_request_body _files = {} # process the body parameter _body_params = None - if _params['enhance_transactions_request_body'] is not None: - _body_params = _params['enhance_transactions_request_body'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/vnd.mx.api.v1+json']) # noqa: E501 - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - # authentication setting _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "EnhanceTransactionsResponseBody", + '200': "AccountNumbersResponseBody", } return self.api_client.call_api( - '/transactions/enhance', 'POST', + '/users/{user_guid}/accounts/{account_guid}/account_numbers', 'GET', _path_params, _query_params, _header_params, @@ -4768,20 +4770,24 @@ def enhance_transactions_with_http_info(self, enhance_transactions_request_body _request_auth=_params.get('_request_auth')) @validate_arguments - def extend_history(self, member_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 - """Extend history # noqa: E501 + def list_account_numbers_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountNumbersResponseBody: # noqa: E501 + """List account numbers by member # noqa: E501 - Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication. # noqa: E501 + This endpoint returns a list of account numbers associated with the specified `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.extend_history(member_guid, user_guid, async_req=True) + >>> thread = api.list_account_numbers_by_member(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique identifier for a `member`. (required) + :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param user_guid: The unique identifier for a `user`. (required) + :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -4791,29 +4797,33 @@ def extend_history(self, member_guid : Annotated[StrictStr, Field(..., descripti :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberResponseBody + :rtype: AccountNumbersResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the extend_history_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_account_numbers_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.extend_history_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.list_account_numbers_by_member_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique identifier for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Extend history # noqa: E501 + def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List account numbers by member # noqa: E501 - Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication. # noqa: E501 + This endpoint returns a list of account numbers associated with the specified `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.extend_history_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.list_account_numbers_by_member_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique identifier for a `member`. (required) + :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param user_guid: The unique identifier for a `user`. (required) + :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -4836,14 +4846,16 @@ def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountNumbersResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ 'member_guid', - 'user_guid' + 'user_guid', + 'page', + 'records_per_page' ] _all_params.extend( [ @@ -4862,7 +4874,7 @@ def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method extend_history" % _key + " to method list_account_numbers_by_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4880,6 +4892,12 @@ def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -4895,11 +4913,11 @@ def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '202': "MemberResponseBody", + '200': "AccountNumbersResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/extend_history', 'POST', + '/users/{user_guid}/members/{member_guid}/account_numbers', 'GET', _path_params, _query_params, _header_params, @@ -4916,20 +4934,24 @@ def extend_history_with_http_info(self, member_guid : Annotated[StrictStr, Field _request_auth=_params.get('_request_auth')) @validate_arguments - def fetch_statements(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 - """Fetch statements # noqa: E501 + def list_account_owners_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountOwnersResponseBody: # noqa: E501 + """List account owners by member # noqa: E501 - Use this endpoint to fetch the statements associated with a particular member. # noqa: E501 + This endpoint returns an array with information about every account associated with a particular member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fetch_statements(member_guid, user_guid, async_req=True) + >>> thread = api.list_account_owners_by_member(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() :param member_guid: The unique id for a `member`. (required) :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -4939,29 +4961,33 @@ def fetch_statements(self, member_guid : Annotated[StrictStr, Field(..., descrip :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberResponseBody + :rtype: AccountOwnersResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the fetch_statements_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_account_owners_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.fetch_statements_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.list_account_owners_by_member_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Fetch statements # noqa: E501 + def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List account owners by member # noqa: E501 - Use this endpoint to fetch the statements associated with a particular member. # noqa: E501 + This endpoint returns an array with information about every account associated with a particular member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fetch_statements_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.list_account_owners_by_member_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() :param member_guid: The unique id for a `member`. (required) :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -4984,14 +5010,16 @@ def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Fie :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountOwnersResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ 'member_guid', - 'user_guid' + 'user_guid', + 'page', + 'records_per_page' ] _all_params.extend( [ @@ -5010,7 +5038,7 @@ def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Fie if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method fetch_statements" % _key + " to method list_account_owners_by_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5028,6 +5056,12 @@ def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Fie # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -5043,11 +5077,11 @@ def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Fie _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '202': "MemberResponseBody", + '200': "AccountOwnersResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/fetch_statements', 'POST', + '/users/{user_guid}/members/{member_guid}/account_owners', 'GET', _path_params, _query_params, _header_params, @@ -5064,20 +5098,22 @@ def fetch_statements_with_http_info(self, member_guid : Annotated[StrictStr, Fie _request_auth=_params.get('_request_auth')) @validate_arguments - def fetch_tax_documents(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 - """Fetch Tax Documents # noqa: E501 + def list_categories(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CategoriesResponseBody: # noqa: E501 + """List categories # noqa: E501 - 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. # noqa: E501 + Use this endpoint to list all categories associated with a `user`, including both default and custom categories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fetch_tax_documents(member_guid, user_guid, async_req=True) + >>> thread = api.list_categories(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -5087,29 +5123,31 @@ def fetch_tax_documents(self, member_guid : Annotated[StrictStr, Field(..., desc :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberResponseBody + :rtype: CategoriesResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the fetch_tax_documents_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_categories_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.fetch_tax_documents_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.list_categories_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Fetch Tax Documents # noqa: E501 + def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List categories # noqa: E501 - 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. # noqa: E501 + Use this endpoint to list all categories associated with a `user`, including both default and custom categories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fetch_tax_documents_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.list_categories_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -5132,14 +5170,15 @@ def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CategoriesResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', - 'user_guid' + 'user_guid', + 'page', + 'records_per_page' ] _all_params.extend( [ @@ -5158,7 +5197,7 @@ def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method fetch_tax_documents" % _key + " to method list_categories" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5167,15 +5206,18 @@ def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -5191,11 +5233,11 @@ def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '202': "MemberResponseBody", + '200': "CategoriesResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/fetch_tax_documents', 'POST', + '/users/{user_guid}/categories', 'GET', _path_params, _query_params, _header_params, @@ -5212,20 +5254,20 @@ def fetch_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, _request_auth=_params.get('_request_auth')) @validate_arguments - def identify_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 - """Identify member # noqa: E501 + def list_default_categories(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CategoriesResponseBody: # noqa: E501 + """List default categories # noqa: E501 - The identify endpoint begins an identification process for an already-existing member. # noqa: E501 + Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.identify_member(member_guid, user_guid, async_req=True) + >>> thread = api.list_default_categories(page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -5235,29 +5277,29 @@ def identify_member(self, member_guid : Annotated[StrictStr, Field(..., descript :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberResponseBody + :rtype: CategoriesResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the identify_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_default_categories_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.identify_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.list_default_categories_with_http_info(page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Identify member # noqa: E501 + def list_default_categories_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List default categories # noqa: E501 - The identify endpoint begins an identification process for an already-existing member. # noqa: E501 + Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.identify_member_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.list_default_categories_with_http_info(page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -5280,14 +5322,14 @@ def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Fiel :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CategoriesResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', - 'user_guid' + 'page', + 'records_per_page' ] _all_params.extend( [ @@ -5306,7 +5348,7 @@ def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Fiel if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method identify_member" % _key + " to method list_default_categories" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5315,15 +5357,15 @@ def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Fiel # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -5339,11 +5381,11 @@ def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Fiel _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '202': "MemberResponseBody", + '200': "CategoriesResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/identify', 'POST', + '/categories/default', 'GET', _path_params, _query_params, _header_params, @@ -5360,18 +5402,16 @@ def identify_member_with_http_info(self, member_guid : Annotated[StrictStr, Fiel _request_auth=_params.get('_request_auth')) @validate_arguments - def list_account_numbers_by_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountNumbersResponseBody: # noqa: E501 - """List account numbers by account # noqa: E501 + def list_default_categories_by_user(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CategoriesResponseBody: # noqa: E501 + """List default categories by user # noqa: E501 - This endpoint returns a list of account numbers associated with the specified `account`. # noqa: E501 + Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_account_numbers_by_account(account_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_default_categories_by_user(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -5387,27 +5427,25 @@ def list_account_numbers_by_account(self, account_guid : Annotated[StrictStr, Fi :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: AccountNumbersResponseBody + :rtype: CategoriesResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_account_numbers_by_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_default_categories_by_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_account_numbers_by_account_with_http_info(account_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_default_categories_by_user_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_account_numbers_by_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List account numbers by account # noqa: E501 + def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List default categories by user # noqa: E501 - This endpoint returns a list of account numbers associated with the specified `account`. # noqa: E501 + Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_account_numbers_by_account_with_http_info(account_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_default_categories_by_user_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -5436,13 +5474,12 @@ def list_account_numbers_by_account_with_http_info(self, account_guid : Annotate :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(AccountNumbersResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CategoriesResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'account_guid', 'user_guid', 'page', 'records_per_page' @@ -5464,7 +5501,7 @@ def list_account_numbers_by_account_with_http_info(self, account_guid : Annotate if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_account_numbers_by_account" % _key + " to method list_default_categories_by_user" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5473,9 +5510,6 @@ def list_account_numbers_by_account_with_http_info(self, account_guid : Annotate # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -5503,11 +5537,11 @@ def list_account_numbers_by_account_with_http_info(self, account_guid : Annotate _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "AccountNumbersResponseBody", + '200': "CategoriesResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/accounts/{account_guid}/account_numbers', 'GET', + '/users/{user_guid}/categories/default', 'GET', _path_params, _query_params, _header_params, @@ -5524,20 +5558,16 @@ def list_account_numbers_by_account_with_http_info(self, account_guid : Annotate _request_auth=_params.get('_request_auth')) @validate_arguments - def list_account_numbers_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountNumbersResponseBody: # noqa: E501 - """List account numbers by member # noqa: E501 + def list_favorite_institutions(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> InstitutionsResponseBody: # noqa: E501 + """List favorite institutions # noqa: E501 - This endpoint returns a list of account numbers associated with the specified `member`. # noqa: E501 + This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_account_numbers_by_member(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_favorite_institutions(page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -5551,29 +5581,25 @@ def list_account_numbers_by_member(self, member_guid : Annotated[StrictStr, Fiel :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: AccountNumbersResponseBody + :rtype: InstitutionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_account_numbers_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_favorite_institutions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_account_numbers_by_member_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_favorite_institutions_with_http_info(page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List account numbers by member # noqa: E501 + def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List favorite institutions # noqa: E501 - This endpoint returns a list of account numbers associated with the specified `member`. # noqa: E501 + This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_account_numbers_by_member_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_favorite_institutions_with_http_info(page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -5600,14 +5626,12 @@ def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[ :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(AccountNumbersResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(InstitutionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', - 'user_guid', 'page', 'records_per_page' ] @@ -5628,7 +5652,7 @@ def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[ if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_account_numbers_by_member" % _key + " to method list_favorite_institutions" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5637,12 +5661,6 @@ def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[ # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] @@ -5667,11 +5685,11 @@ def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[ _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "AccountNumbersResponseBody", + '200': "InstitutionsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/account_numbers', 'GET', + '/institutions/favorites', 'GET', _path_params, _query_params, _header_params, @@ -5688,24 +5706,26 @@ def list_account_numbers_by_member_with_http_info(self, member_guid : Annotated[ _request_auth=_params.get('_request_auth')) @validate_arguments - def list_account_owners_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountOwnersResponseBody: # noqa: E501 - """List account owners by member # noqa: E501 + def list_holdings(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> HoldingsResponseBody: # noqa: E501 + """List holdings # noqa: E501 - This endpoint returns an array with information about every account associated with a particular member. # noqa: E501 + This endpoint returns all holdings associated with the specified `user` across all accounts and members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_account_owners_by_member(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_holdings(user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param from_date: Filter holdings from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter holdings to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -5715,33 +5735,35 @@ def list_account_owners_by_member(self, member_guid : Annotated[StrictStr, Field :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: AccountOwnersResponseBody + :rtype: HoldingsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_account_owners_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_holdings_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_account_owners_by_member_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_holdings_with_http_info(user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List account owners by member # noqa: E501 + def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List holdings # noqa: E501 - This endpoint returns an array with information about every account associated with a particular member. # noqa: E501 + This endpoint returns all holdings associated with the specified `user` across all accounts and members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_account_owners_by_member_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_holdings_with_http_info(user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param from_date: Filter holdings from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter holdings to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -5764,16 +5786,17 @@ def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[S :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(AccountOwnersResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(HoldingsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', 'user_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -5792,7 +5815,7 @@ def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[S if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_account_owners_by_member" % _key + " to method list_holdings" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5801,21 +5824,24 @@ def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[S # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -5831,11 +5857,11 @@ def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[S _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "AccountOwnersResponseBody", + '200': "HoldingsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/account_owners', 'GET', + '/users/{user_guid}/holdings', 'GET', _path_params, _query_params, _header_params, @@ -5852,22 +5878,28 @@ def list_account_owners_by_member_with_http_info(self, member_guid : Annotated[S _request_auth=_params.get('_request_auth')) @validate_arguments - def list_categories(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CategoriesResponseBody: # noqa: E501 - """List categories # noqa: E501 + def list_holdings_by_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for the `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for the `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> HoldingsResponseBody: # noqa: E501 + """List holdings by account # noqa: E501 - Use this endpoint to list all categories associated with a `user`, including both default and custom categories. # noqa: E501 + This endpoint returns all holdings associated with the specified `account`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_categories(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_holdings_by_account(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) + :param account_guid: The unique id for the `account`. (required) + :type account_guid: str + :param user_guid: The unique id for the `user`. (required) :type user_guid: str + :param from_date: Filter holdings from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter holdings to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -5877,31 +5909,37 @@ def list_categories(self, user_guid : Annotated[StrictStr, Field(..., descriptio :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: CategoriesResponseBody + :rtype: HoldingsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_categories_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_holdings_by_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_categories_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_holdings_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List categories # noqa: E501 + def list_holdings_by_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for the `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for the `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List holdings by account # noqa: E501 - Use this endpoint to list all categories associated with a `user`, including both default and custom categories. # noqa: E501 + This endpoint returns all holdings associated with the specified `account`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_categories_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_holdings_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) + :param account_guid: The unique id for the `account`. (required) + :type account_guid: str + :param user_guid: The unique id for the `user`. (required) :type user_guid: str + :param from_date: Filter holdings from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter holdings to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -5924,15 +5962,18 @@ def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field( :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(CategoriesResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(HoldingsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'account_guid', 'user_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -5951,7 +5992,7 @@ def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field( if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_categories" % _key + " to method list_holdings_by_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -5960,18 +6001,27 @@ def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field( # process the path parameters _path_params = {} + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -5987,11 +6037,11 @@ def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field( _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "CategoriesResponseBody", + '200': "HoldingsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/categories', 'GET', + '/users/{user_guid}/accounts/{account_guid}/holdings', 'GET', _path_params, _query_params, _header_params, @@ -6008,20 +6058,28 @@ def list_categories_with_http_info(self, user_guid : Annotated[StrictStr, Field( _request_auth=_params.get('_request_auth')) @validate_arguments - def list_default_categories(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CategoriesResponseBody: # noqa: E501 - """List default categories # noqa: E501 + def list_holdings_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> HoldingsResponseBody: # noqa: E501 + """List holdings by member # noqa: E501 - Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 + This endpoint returns all holdings associated with the specified `member` across all accounts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_default_categories(page, records_per_page, async_req=True) + >>> thread = api.list_holdings_by_member(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param from_date: Filter holdings from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter holdings to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -6031,29 +6089,37 @@ def list_default_categories(self, page : Annotated[Optional[StrictInt], Field(de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: CategoriesResponseBody + :rtype: HoldingsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_default_categories_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_holdings_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_default_categories_with_http_info(page, records_per_page, **kwargs) # noqa: E501 + return self.list_holdings_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_default_categories_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List default categories # noqa: E501 + def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List holdings by member # noqa: E501 - Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 + This endpoint returns all holdings associated with the specified `member` across all accounts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_default_categories_with_http_info(page, records_per_page, async_req=True) + >>> thread = api.list_holdings_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param from_date: Filter holdings from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter holdings to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -6076,14 +6142,18 @@ def list_default_categories_with_http_info(self, page : Annotated[Optional[Stric :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(CategoriesResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(HoldingsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'member_guid', + 'user_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -6102,7 +6172,7 @@ def list_default_categories_with_http_info(self, page : Annotated[Optional[Stric if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_default_categories" % _key + " to method list_holdings_by_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -6111,16 +6181,28 @@ def list_default_categories_with_http_info(self, page : Annotated[Optional[Stric # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) - # process the header parameters + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters _form_params = [] @@ -6135,11 +6217,11 @@ def list_default_categories_with_http_info(self, page : Annotated[Optional[Stric _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "CategoriesResponseBody", + '200': "HoldingsResponseBody", } return self.api_client.call_api( - '/categories/default', 'GET', + '/users/{user_guid}/members/{member_guid}/holdings', 'GET', _path_params, _query_params, _header_params, @@ -6156,18 +6238,18 @@ def list_default_categories_with_http_info(self, page : Annotated[Optional[Stric _request_auth=_params.get('_request_auth')) @validate_arguments - def list_default_categories_by_user(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CategoriesResponseBody: # noqa: E501 - """List default categories by user # noqa: E501 + def list_institution_credentials(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CredentialsResponseBody: # noqa: E501 + """List institution credentials # noqa: E501 - Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 + Use this endpoint to see which credentials will be needed to create a member for a specific institution. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_default_categories_by_user(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_institution_credentials(institution_code, page, records_per_page, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param institution_code: The institution_code of the institution. (required) + :type institution_code: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -6181,27 +6263,27 @@ def list_default_categories_by_user(self, user_guid : Annotated[StrictStr, Field :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: CategoriesResponseBody + :rtype: CredentialsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_default_categories_by_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_institution_credentials_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_default_categories_by_user_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_institution_credentials_with_http_info(institution_code, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List default categories by user # noqa: E501 + def list_institution_credentials_with_http_info(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List institution credentials # noqa: E501 - Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. # noqa: E501 + Use this endpoint to see which credentials will be needed to create a member for a specific institution. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_default_categories_by_user_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_institution_credentials_with_http_info(institution_code, page, records_per_page, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param institution_code: The institution_code of the institution. (required) + :type institution_code: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -6228,13 +6310,13 @@ def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[S :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(CategoriesResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CredentialsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', + 'institution_code', 'page', 'records_per_page' ] @@ -6255,7 +6337,7 @@ def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[S if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_default_categories_by_user" % _key + " to method list_institution_credentials" % _key ) _params[_key] = _val del _params['kwargs'] @@ -6264,8 +6346,8 @@ def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[S # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] + if _params['institution_code']: + _path_params['institution_code'] = _params['institution_code'] # process the query parameters @@ -6291,11 +6373,11 @@ def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[S _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "CategoriesResponseBody", + '200': "CredentialsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/categories/default', 'GET', + '/institutions/{institution_code}/credentials', 'GET', _path_params, _query_params, _header_params, @@ -6312,20 +6394,30 @@ def list_default_categories_by_user_with_http_info(self, user_guid : Annotated[S _request_auth=_params.get('_request_auth')) @validate_arguments - def list_favorite_institutions(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> InstitutionsResponseBody: # noqa: E501 - """List favorite institutions # noqa: E501 + def list_institutions(self, name : Annotated[Optional[StrictStr], Field(description="This will list only institutions in which the appended string appears.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, supports_account_identification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account identification.")] = None, supports_account_statement : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account statements.")] = None, supports_account_verification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account verification.")] = None, supports_transaction_history : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support extended transaction history.")] = None, **kwargs) -> InstitutionsResponseBody: # noqa: E501 + """List institutions # noqa: E501 - This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites. # noqa: E501 + This endpoint returns a list of institutions based on the specified search term or parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_favorite_institutions(page, records_per_page, async_req=True) + >>> thread = api.list_institutions(name, page, records_per_page, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, async_req=True) >>> result = thread.get() + :param name: This will list only institutions in which the appended string appears. + :type name: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param supports_account_identification: Filter only institutions which support account identification. + :type supports_account_identification: bool + :param supports_account_statement: Filter only institutions which support account statements. + :type supports_account_statement: bool + :param supports_account_verification: Filter only institutions which support account verification. + :type supports_account_verification: bool + :param supports_transaction_history: Filter only institutions which support extended transaction history. + :type supports_transaction_history: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -6339,25 +6431,35 @@ def list_favorite_institutions(self, page : Annotated[Optional[StrictInt], Field """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_favorite_institutions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_institutions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_favorite_institutions_with_http_info(page, records_per_page, **kwargs) # noqa: E501 + return self.list_institutions_with_http_info(name, page, records_per_page, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, **kwargs) # noqa: E501 @validate_arguments - def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List favorite institutions # noqa: E501 + def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], Field(description="This will list only institutions in which the appended string appears.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, supports_account_identification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account identification.")] = None, supports_account_statement : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account statements.")] = None, supports_account_verification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account verification.")] = None, supports_transaction_history : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support extended transaction history.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List institutions # noqa: E501 - This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites. # noqa: E501 + This endpoint returns a list of institutions based on the specified search term or parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_favorite_institutions_with_http_info(page, records_per_page, async_req=True) + >>> thread = api.list_institutions_with_http_info(name, page, records_per_page, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, async_req=True) >>> result = thread.get() + :param name: This will list only institutions in which the appended string appears. + :type name: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param supports_account_identification: Filter only institutions which support account identification. + :type supports_account_identification: bool + :param supports_account_statement: Filter only institutions which support account statements. + :type supports_account_statement: bool + :param supports_account_verification: Filter only institutions which support account verification. + :type supports_account_verification: bool + :param supports_transaction_history: Filter only institutions which support extended transaction history. + :type supports_transaction_history: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -6386,8 +6488,13 @@ def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[St _params = locals() _all_params = [ + 'name', 'page', - 'records_per_page' + 'records_per_page', + 'supports_account_identification', + 'supports_account_statement', + 'supports_account_verification', + 'supports_transaction_history' ] _all_params.extend( [ @@ -6406,7 +6513,7 @@ def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[St if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_favorite_institutions" % _key + " to method list_institutions" % _key ) _params[_key] = _val del _params['kwargs'] @@ -6418,12 +6525,27 @@ def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[St # process the query parameters _query_params = [] + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('supports_account_identification') is not None: # noqa: E501 + _query_params.append(('supports_account_identification', _params['supports_account_identification'])) + + if _params.get('supports_account_statement') is not None: # noqa: E501 + _query_params.append(('supports_account_statement', _params['supports_account_statement'])) + + if _params.get('supports_account_verification') is not None: # noqa: E501 + _query_params.append(('supports_account_verification', _params['supports_account_verification'])) + + if _params.get('supports_transaction_history') is not None: # noqa: E501 + _query_params.append(('supports_transaction_history', _params['supports_transaction_history'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -6443,7 +6565,7 @@ def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[St } return self.api_client.call_api( - '/institutions/favorites', 'GET', + '/institutions', 'GET', _path_params, _query_params, _header_params, @@ -6460,26 +6582,24 @@ def list_favorite_institutions_with_http_info(self, page : Annotated[Optional[St _request_auth=_params.get('_request_auth')) @validate_arguments - def list_holdings(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> HoldingsResponseBody: # noqa: E501 - """List holdings # noqa: E501 + def list_managed_accounts(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountsResponseBody: # noqa: E501 + """List managed accounts # noqa: E501 - This endpoint returns all holdings associated with the specified `user` across all accounts and members. # noqa: E501 + Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_holdings(user_guid, from_date, page, records_per_page, to_date, async_req=True) + >>> thread = api.list_managed_accounts(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param from_date: Filter holdings from this date. - :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param to_date: Filter holdings to this date. - :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -6489,35 +6609,33 @@ def list_holdings(self, user_guid : Annotated[StrictStr, Field(..., description= :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: HoldingsResponseBody + :rtype: AccountsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_holdings_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_managed_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_holdings_with_http_info(user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 + return self.list_managed_accounts_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List holdings # noqa: E501 + def list_managed_accounts_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List managed accounts # noqa: E501 - This endpoint returns all holdings associated with the specified `user` across all accounts and members. # noqa: E501 + Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_holdings_with_http_info(user_guid, from_date, page, records_per_page, to_date, async_req=True) + >>> thread = api.list_managed_accounts_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param from_date: Filter holdings from this date. - :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param to_date: Filter holdings to this date. - :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -6540,17 +6658,16 @@ def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(HoldingsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'member_guid', 'user_guid', - 'from_date', 'page', - 'records_per_page', - 'to_date' + 'records_per_page' ] _all_params.extend( [ @@ -6569,7 +6686,7 @@ def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_holdings" % _key + " to method list_managed_accounts" % _key ) _params[_key] = _val del _params['kwargs'] @@ -6578,24 +6695,21 @@ def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -6611,11 +6725,11 @@ def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "HoldingsResponseBody", + '200': "AccountsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/holdings', 'GET', + '/users/{user_guid}/managed_members/{member_guid}/accounts', 'GET', _path_params, _query_params, _header_params, @@ -6632,28 +6746,20 @@ def list_holdings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. _request_auth=_params.get('_request_auth')) @validate_arguments - def list_holdings_by_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for the `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for the `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> HoldingsResponseBody: # noqa: E501 - """List holdings by account # noqa: E501 + def list_managed_institutions(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> InstitutionsResponseBody: # noqa: E501 + """List managed institutions # noqa: E501 - This endpoint returns all holdings associated with the specified `account`. # noqa: E501 + This endpoint returns a list of institutions which can be used to create partner-managed members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_holdings_by_account(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) + >>> thread = api.list_managed_institutions(page, records_per_page, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for the `account`. (required) - :type account_guid: str - :param user_guid: The unique id for the `user`. (required) - :type user_guid: str - :param from_date: Filter holdings from this date. - :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param to_date: Filter holdings to this date. - :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -6663,37 +6769,29 @@ def list_holdings_by_account(self, account_guid : Annotated[StrictStr, Field(... :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: HoldingsResponseBody + :rtype: InstitutionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_holdings_by_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_managed_institutions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_holdings_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 + return self.list_managed_institutions_with_http_info(page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_holdings_by_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for the `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for the `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List holdings by account # noqa: E501 + def list_managed_institutions_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List managed institutions # noqa: E501 - This endpoint returns all holdings associated with the specified `account`. # noqa: E501 + This endpoint returns a list of institutions which can be used to create partner-managed members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_holdings_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) + >>> thread = api.list_managed_institutions_with_http_info(page, records_per_page, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for the `account`. (required) - :type account_guid: str - :param user_guid: The unique id for the `user`. (required) - :type user_guid: str - :param from_date: Filter holdings from this date. - :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param to_date: Filter holdings to this date. - :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -6716,18 +6814,14 @@ def list_holdings_by_account_with_http_info(self, account_guid : Annotated[Stric :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(HoldingsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(InstitutionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'account_guid', - 'user_guid', - 'from_date', 'page', - 'records_per_page', - 'to_date' + 'records_per_page' ] _all_params.extend( [ @@ -6746,7 +6840,7 @@ def list_holdings_by_account_with_http_info(self, account_guid : Annotated[Stric if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_holdings_by_account" % _key + " to method list_managed_institutions" % _key ) _params[_key] = _val del _params['kwargs'] @@ -6755,27 +6849,15 @@ def list_holdings_by_account_with_http_info(self, account_guid : Annotated[Stric # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -6791,11 +6873,11 @@ def list_holdings_by_account_with_http_info(self, account_guid : Annotated[Stric _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "HoldingsResponseBody", + '200': "InstitutionsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/accounts/{account_guid}/holdings', 'GET', + '/managed_institutions', 'GET', _path_params, _query_params, _header_params, @@ -6812,28 +6894,22 @@ def list_holdings_by_account_with_http_info(self, account_guid : Annotated[Stric _request_auth=_params.get('_request_auth')) @validate_arguments - def list_holdings_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> HoldingsResponseBody: # noqa: E501 - """List holdings by member # noqa: E501 + def list_managed_members(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> MembersResponseBody: # noqa: E501 + """List managed members # noqa: E501 - This endpoint returns all holdings associated with the specified `member` across all accounts. # noqa: E501 + This endpoint returns a list of all the partner-managed members associated with the specified `user`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_holdings_by_member(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) + >>> thread = api.list_managed_members(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param from_date: Filter holdings from this date. - :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param to_date: Filter holdings to this date. - :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -6843,37 +6919,31 @@ def list_holdings_by_member(self, member_guid : Annotated[StrictStr, Field(..., :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: HoldingsResponseBody + :rtype: MembersResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_holdings_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_managed_members_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_holdings_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 + return self.list_managed_members_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter holdings from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter holdings to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List holdings by member # noqa: E501 + def list_managed_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List managed members # noqa: E501 - This endpoint returns all holdings associated with the specified `member` across all accounts. # noqa: E501 + This endpoint returns a list of all the partner-managed members associated with the specified `user`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_holdings_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) + >>> thread = api.list_managed_members_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param from_date: Filter holdings from this date. - :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param to_date: Filter holdings to this date. - :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -6896,18 +6966,15 @@ def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictS :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(HoldingsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MembersResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', 'user_guid', - 'from_date', 'page', - 'records_per_page', - 'to_date' + 'records_per_page' ] _all_params.extend( [ @@ -6926,7 +6993,7 @@ def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictS if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_holdings_by_member" % _key + " to method list_managed_members" % _key ) _params[_key] = _val del _params['kwargs'] @@ -6935,27 +7002,18 @@ def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictS # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -6971,11 +7029,11 @@ def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictS _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "HoldingsResponseBody", + '200': "MembersResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/holdings', 'GET', + '/users/{user_guid}/managed_members', 'GET', _path_params, _query_params, _header_params, @@ -6992,18 +7050,22 @@ def list_holdings_by_member_with_http_info(self, member_guid : Annotated[StrictS _request_auth=_params.get('_request_auth')) @validate_arguments - def list_institution_credentials(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CredentialsResponseBody: # noqa: E501 - """List institution credentials # noqa: E501 + def list_managed_transactions(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 + """List managed transactions # noqa: E501 - Use this endpoint to see which credentials will be needed to create a member for a specific institution. # noqa: E501 + This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_institution_credentials(institution_code, page, records_per_page, async_req=True) + >>> thread = api.list_managed_transactions(account_guid, member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param institution_code: The institution_code of the institution. (required) - :type institution_code: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -7017,27 +7079,31 @@ def list_institution_credentials(self, institution_code : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: CredentialsResponseBody + :rtype: TransactionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_institution_credentials_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_managed_transactions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_institution_credentials_with_http_info(institution_code, page, records_per_page, **kwargs) # noqa: E501 + return self.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_institution_credentials_with_http_info(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List institution credentials # noqa: E501 + def list_managed_transactions_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List managed transactions # noqa: E501 - Use this endpoint to see which credentials will be needed to create a member for a specific institution. # noqa: E501 + This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_institution_credentials_with_http_info(institution_code, page, records_per_page, async_req=True) + >>> thread = api.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param institution_code: The institution_code of the institution. (required) - :type institution_code: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -7064,13 +7130,15 @@ def list_institution_credentials_with_http_info(self, institution_code : Annotat :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(CredentialsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'institution_code', + 'account_guid', + 'member_guid', + 'user_guid', 'page', 'records_per_page' ] @@ -7091,7 +7159,7 @@ def list_institution_credentials_with_http_info(self, institution_code : Annotat if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_institution_credentials" % _key + " to method list_managed_transactions" % _key ) _params[_key] = _val del _params['kwargs'] @@ -7100,8 +7168,14 @@ def list_institution_credentials_with_http_info(self, institution_code : Annotat # process the path parameters _path_params = {} - if _params['institution_code']: - _path_params['institution_code'] = _params['institution_code'] + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] # process the query parameters @@ -7127,11 +7201,11 @@ def list_institution_credentials_with_http_info(self, institution_code : Annotat _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "CredentialsResponseBody", + '200': "TransactionsResponseBody", } return self.api_client.call_api( - '/institutions/{institution_code}/credentials', 'GET', + '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions', 'GET', _path_params, _query_params, _header_params, @@ -7148,30 +7222,26 @@ def list_institution_credentials_with_http_info(self, institution_code : Annotat _request_auth=_params.get('_request_auth')) @validate_arguments - def list_institutions(self, name : Annotated[Optional[StrictStr], Field(description="This will list only institutions in which the appended string appears.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, supports_account_identification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account identification.")] = None, supports_account_statement : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account statements.")] = None, supports_account_verification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account verification.")] = None, supports_transaction_history : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support extended transaction history.")] = None, **kwargs) -> InstitutionsResponseBody: # noqa: E501 - """List institutions # noqa: E501 + def list_member_accounts(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountsResponseBody: # noqa: E501 + """List accounts by member # noqa: E501 - This endpoint returns a list of institutions based on the specified search term or parameter. # noqa: E501 + This endpoint returns a list of all the accounts associated with the specified `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_institutions(name, page, records_per_page, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, async_req=True) + >>> thread = api.list_member_accounts(user_guid, member_guid, member_is_managed_by_user, page, records_per_page, async_req=True) >>> result = thread.get() - :param name: This will list only institutions in which the appended string appears. - :type name: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param member_is_managed_by_user: List only accounts whose member is managed by the user. + :type member_is_managed_by_user: bool :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param supports_account_identification: Filter only institutions which support account identification. - :type supports_account_identification: bool - :param supports_account_statement: Filter only institutions which support account statements. - :type supports_account_statement: bool - :param supports_account_verification: Filter only institutions which support account verification. - :type supports_account_verification: bool - :param supports_transaction_history: Filter only institutions which support extended transaction history. - :type supports_transaction_history: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -7181,39 +7251,35 @@ def list_institutions(self, name : Annotated[Optional[StrictStr], Field(descript :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: InstitutionsResponseBody + :rtype: AccountsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_institutions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_member_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_institutions_with_http_info(name, page, records_per_page, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, **kwargs) # noqa: E501 + return self.list_member_accounts_with_http_info(user_guid, member_guid, member_is_managed_by_user, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], Field(description="This will list only institutions in which the appended string appears.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, supports_account_identification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account identification.")] = None, supports_account_statement : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account statements.")] = None, supports_account_verification : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support account verification.")] = None, supports_transaction_history : Annotated[Optional[StrictBool], Field(description="Filter only institutions which support extended transaction history.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List institutions # noqa: E501 + def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List accounts by member # noqa: E501 - This endpoint returns a list of institutions based on the specified search term or parameter. # noqa: E501 + This endpoint returns a list of all the accounts associated with the specified `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_institutions_with_http_info(name, page, records_per_page, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, async_req=True) + >>> thread = api.list_member_accounts_with_http_info(user_guid, member_guid, member_is_managed_by_user, page, records_per_page, async_req=True) >>> result = thread.get() - :param name: This will list only institutions in which the appended string appears. - :type name: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param member_is_managed_by_user: List only accounts whose member is managed by the user. + :type member_is_managed_by_user: bool :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int - :param supports_account_identification: Filter only institutions which support account identification. - :type supports_account_identification: bool - :param supports_account_statement: Filter only institutions which support account statements. - :type supports_account_statement: bool - :param supports_account_verification: Filter only institutions which support account verification. - :type supports_account_verification: bool - :param supports_transaction_history: Filter only institutions which support extended transaction history. - :type supports_transaction_history: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -7236,19 +7302,17 @@ def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(InstitutionsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'name', + 'user_guid', + 'member_guid', + 'member_is_managed_by_user', 'page', - 'records_per_page', - 'supports_account_identification', - 'supports_account_statement', - 'supports_account_verification', - 'supports_transaction_history' + 'records_per_page' ] _all_params.extend( [ @@ -7267,7 +7331,7 @@ def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_institutions" % _key + " to method list_member_accounts" % _key ) _params[_key] = _val del _params['kwargs'] @@ -7276,11 +7340,17 @@ def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], # process the path parameters _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + # process the query parameters _query_params = [] - if _params.get('name') is not None: # noqa: E501 - _query_params.append(('name', _params['name'])) + if _params.get('member_is_managed_by_user') is not None: # noqa: E501 + _query_params.append(('member_is_managed_by_user', _params['member_is_managed_by_user'])) if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) @@ -7288,18 +7358,6 @@ def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) - if _params.get('supports_account_identification') is not None: # noqa: E501 - _query_params.append(('supports_account_identification', _params['supports_account_identification'])) - - if _params.get('supports_account_statement') is not None: # noqa: E501 - _query_params.append(('supports_account_statement', _params['supports_account_statement'])) - - if _params.get('supports_account_verification') is not None: # noqa: E501 - _query_params.append(('supports_account_verification', _params['supports_account_verification'])) - - if _params.get('supports_transaction_history') is not None: # noqa: E501 - _query_params.append(('supports_transaction_history', _params['supports_transaction_history'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -7315,11 +7373,11 @@ def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "InstitutionsResponseBody", + '200': "AccountsResponseBody", } return self.api_client.call_api( - '/institutions', 'GET', + '/users/{user_guid}/members/{member_guid}/accounts', 'GET', _path_params, _query_params, _header_params, @@ -7336,14 +7394,14 @@ def list_institutions_with_http_info(self, name : Annotated[Optional[StrictStr], _request_auth=_params.get('_request_auth')) @validate_arguments - def list_managed_accounts(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountsResponseBody: # noqa: E501 - """List managed accounts # noqa: E501 + def list_member_challenges(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ChallengesResponseBody: # noqa: E501 + """List member challenges # noqa: E501 - Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member. # noqa: E501 + Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_accounts(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_member_challenges(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() :param member_guid: The unique id for a `member`. (required) @@ -7363,23 +7421,23 @@ def list_managed_accounts(self, member_guid : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: AccountsResponseBody + :rtype: ChallengesResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_managed_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_member_challenges_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_managed_accounts_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_member_challenges_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_managed_accounts_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List managed accounts # noqa: E501 + def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List member challenges # noqa: E501 - Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member. # noqa: E501 + Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_accounts_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_member_challenges_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() :param member_guid: The unique id for a `member`. (required) @@ -7412,7 +7470,7 @@ def list_managed_accounts_with_http_info(self, member_guid : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(AccountsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(ChallengesResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() @@ -7440,7 +7498,7 @@ def list_managed_accounts_with_http_info(self, member_guid : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_managed_accounts" % _key + " to method list_member_challenges" % _key ) _params[_key] = _val del _params['kwargs'] @@ -7479,11 +7537,11 @@ def list_managed_accounts_with_http_info(self, member_guid : Annotated[StrictStr _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "AccountsResponseBody", + '200': "ChallengesResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}/accounts', 'GET', + '/users/{user_guid}/members/{member_guid}/challenges', 'GET', _path_params, _query_params, _header_params, @@ -7500,16 +7558,20 @@ def list_managed_accounts_with_http_info(self, member_guid : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def list_managed_institutions(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> InstitutionsResponseBody: # noqa: E501 - """List managed institutions # noqa: E501 + def list_member_credentials(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CredentialsResponseBody: # noqa: E501 + """List member credentials # noqa: E501 - This endpoint returns a list of institutions which can be used to create partner-managed members. # noqa: E501 + This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_institutions(page, records_per_page, async_req=True) + >>> thread = api.list_member_credentials(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -7523,25 +7585,29 @@ def list_managed_institutions(self, page : Annotated[Optional[StrictInt], Field( :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: InstitutionsResponseBody + :rtype: CredentialsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_managed_institutions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_member_credentials_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_managed_institutions_with_http_info(page, records_per_page, **kwargs) # noqa: E501 + return self.list_member_credentials_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_managed_institutions_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List managed institutions # noqa: E501 + def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List member credentials # noqa: E501 - This endpoint returns a list of institutions which can be used to create partner-managed members. # noqa: E501 + This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_institutions_with_http_info(page, records_per_page, async_req=True) + >>> thread = api.list_member_credentials_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -7568,12 +7634,14 @@ def list_managed_institutions_with_http_info(self, page : Annotated[Optional[Str :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(InstitutionsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CredentialsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'member_guid', + 'user_guid', 'page', 'records_per_page' ] @@ -7594,7 +7662,7 @@ def list_managed_institutions_with_http_info(self, page : Annotated[Optional[Str if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_managed_institutions" % _key + " to method list_member_credentials" % _key ) _params[_key] = _val del _params['kwargs'] @@ -7603,6 +7671,12 @@ def list_managed_institutions_with_http_info(self, page : Annotated[Optional[Str # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] @@ -7627,11 +7701,11 @@ def list_managed_institutions_with_http_info(self, page : Annotated[Optional[Str _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "InstitutionsResponseBody", + '200': "CredentialsResponseBody", } return self.api_client.call_api( - '/managed_institutions', 'GET', + '/users/{user_guid}/members/{member_guid}/credentials', 'GET', _path_params, _query_params, _header_params, @@ -7648,14 +7722,14 @@ def list_managed_institutions_with_http_info(self, page : Annotated[Optional[Str _request_auth=_params.get('_request_auth')) @validate_arguments - def list_managed_members(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> MembersResponseBody: # noqa: E501 - """List managed members # noqa: E501 + def list_members(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> MembersResponseBody: # noqa: E501 + """List members # noqa: E501 - This endpoint returns a list of all the partner-managed members associated with the specified `user`. # noqa: E501 + This endpoint returns an array which contains information on every member associated with a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_members(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_members(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) @@ -7677,19 +7751,19 @@ def list_managed_members(self, user_guid : Annotated[StrictStr, Field(..., descr """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_managed_members_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_members_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_managed_members_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_members_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_managed_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List managed members # noqa: E501 + def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List members # noqa: E501 - This endpoint returns a list of all the partner-managed members associated with the specified `user`. # noqa: E501 + This endpoint returns an array which contains information on every member associated with a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_members_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_members_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) @@ -7747,7 +7821,7 @@ def list_managed_members_with_http_info(self, user_guid : Annotated[StrictStr, F if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_managed_members" % _key + " to method list_members" % _key ) _params[_key] = _val del _params['kwargs'] @@ -7787,7 +7861,7 @@ def list_managed_members_with_http_info(self, user_guid : Annotated[StrictStr, F } return self.api_client.call_api( - '/users/{user_guid}/managed_members', 'GET', + '/users/{user_guid}/members', 'GET', _path_params, _query_params, _header_params, @@ -7804,22 +7878,16 @@ def list_managed_members_with_http_info(self, user_guid : Annotated[StrictStr, F _request_auth=_params.get('_request_auth')) @validate_arguments - def list_managed_transactions(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 - """List managed transactions # noqa: E501 + def list_merchants(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> MerchantsResponseBody: # noqa: E501 + """List merchants # noqa: E501 - This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`. # noqa: E501 + This endpoint returns a paginated list of all the merchants in the MX system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_transactions(account_guid, member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_merchants(page, records_per_page, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -7833,31 +7901,25 @@ def list_managed_transactions(self, account_guid : Annotated[StrictStr, Field(.. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TransactionsResponseBody + :rtype: MerchantsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_managed_transactions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_merchants_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_merchants_with_http_info(page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_managed_transactions_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List managed transactions # noqa: E501 + def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List merchants # noqa: E501 - This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`. # noqa: E501 + This endpoint returns a paginated list of all the merchants in the MX system. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_merchants_with_http_info(page, records_per_page, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -7884,15 +7946,12 @@ def list_managed_transactions_with_http_info(self, account_guid : Annotated[Stri :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MerchantsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'account_guid', - 'member_guid', - 'user_guid', 'page', 'records_per_page' ] @@ -7913,7 +7972,7 @@ def list_managed_transactions_with_http_info(self, account_guid : Annotated[Stri if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_managed_transactions" % _key + " to method list_merchants" % _key ) _params[_key] = _val del _params['kwargs'] @@ -7922,15 +7981,6 @@ def list_managed_transactions_with_http_info(self, account_guid : Annotated[Stri # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] @@ -7955,11 +8005,11 @@ def list_managed_transactions_with_http_info(self, account_guid : Annotated[Stri _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "TransactionsResponseBody", + '200': "MerchantsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions', 'GET', + '/merchants', 'GET', _path_params, _query_params, _header_params, @@ -7976,22 +8026,20 @@ def list_managed_transactions_with_http_info(self, account_guid : Annotated[Stri _request_auth=_params.get('_request_auth')) @validate_arguments - def list_member_accounts(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountsResponseBody: # noqa: E501 - """List accounts by member # noqa: E501 + def list_statements_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> StatementsResponseBody: # noqa: E501 + """List statements by member # noqa: E501 - This endpoint returns a list of all the accounts associated with the specified `member`. # noqa: E501 + Use this endpoint to get an array of available statements. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_member_accounts(user_guid, member_guid, member_is_managed_by_user, page, records_per_page, async_req=True) + >>> thread = api.list_statements_by_member(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param member_is_managed_by_user: List only accounts whose member is managed by the user. - :type member_is_managed_by_user: bool + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -8005,31 +8053,29 @@ def list_member_accounts(self, user_guid : Annotated[StrictStr, Field(..., descr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: AccountsResponseBody + :rtype: StatementsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_member_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_statements_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_member_accounts_with_http_info(user_guid, member_guid, member_is_managed_by_user, page, records_per_page, **kwargs) # noqa: E501 + return self.list_statements_by_member_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List accounts by member # noqa: E501 + def list_statements_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List statements by member # noqa: E501 - This endpoint returns a list of all the accounts associated with the specified `member`. # noqa: E501 + Use this endpoint to get an array of available statements. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_member_accounts_with_http_info(user_guid, member_guid, member_is_managed_by_user, page, records_per_page, async_req=True) + >>> thread = api.list_statements_by_member_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str - :param member_is_managed_by_user: List only accounts whose member is managed by the user. - :type member_is_managed_by_user: bool + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -8056,15 +8102,14 @@ def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(AccountsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(StatementsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', 'member_guid', - 'member_is_managed_by_user', + 'user_guid', 'page', 'records_per_page' ] @@ -8085,7 +8130,7 @@ def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, F if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_member_accounts" % _key + " to method list_statements_by_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -8094,18 +8139,15 @@ def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, F # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - if _params['member_guid']: _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] - if _params.get('member_is_managed_by_user') is not None: # noqa: E501 - _query_params.append(('member_is_managed_by_user', _params['member_is_managed_by_user'])) - if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) @@ -8127,11 +8169,11 @@ def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, F _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "AccountsResponseBody", + '200': "StatementsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/accounts', 'GET', + '/users/{user_guid}/members/{member_guid}/statements', 'GET', _path_params, _query_params, _header_params, @@ -8148,18 +8190,16 @@ def list_member_accounts_with_http_info(self, user_guid : Annotated[StrictStr, F _request_auth=_params.get('_request_auth')) @validate_arguments - def list_member_challenges(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ChallengesResponseBody: # noqa: E501 - """List member challenges # noqa: E501 + def list_taggings(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TaggingsResponseBody: # noqa: E501 + """List taggings # noqa: E501 - Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials. # noqa: E501 + Use this endpoint to retrieve a list of all the taggings associated with a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_member_challenges(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_taggings(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -8175,27 +8215,25 @@ def list_member_challenges(self, member_guid : Annotated[StrictStr, Field(..., d :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: ChallengesResponseBody + :rtype: TaggingsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_member_challenges_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_taggings_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_member_challenges_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_taggings_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List member challenges # noqa: E501 + def list_taggings_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List taggings # noqa: E501 - Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials. # noqa: E501 + Use this endpoint to retrieve a list of all the taggings associated with a specific user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_member_challenges_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_taggings_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -8224,13 +8262,12 @@ def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictSt :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(ChallengesResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TaggingsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', 'user_guid', 'page', 'records_per_page' @@ -8252,7 +8289,7 @@ def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictSt if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_member_challenges" % _key + " to method list_taggings" % _key ) _params[_key] = _val del _params['kwargs'] @@ -8261,9 +8298,6 @@ def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictSt # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -8291,11 +8325,11 @@ def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictSt _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "ChallengesResponseBody", + '200': "TaggingsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/challenges', 'GET', + '/users/{user_guid}/taggings', 'GET', _path_params, _query_params, _header_params, @@ -8312,18 +8346,16 @@ def list_member_challenges_with_http_info(self, member_guid : Annotated[StrictSt _request_auth=_params.get('_request_auth')) @validate_arguments - def list_member_credentials(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> CredentialsResponseBody: # noqa: E501 - """List member credentials # noqa: E501 + def list_tags(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TagsResponseBody: # noqa: E501 + """List tags # noqa: E501 - This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. # noqa: E501 + Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_member_credentials(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_tags(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -8339,27 +8371,25 @@ def list_member_credentials(self, member_guid : Annotated[StrictStr, Field(..., :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: CredentialsResponseBody + :rtype: TagsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_member_credentials_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_tags_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_member_credentials_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_tags_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List member credentials # noqa: E501 + def list_tags_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List tags # noqa: E501 - This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. # noqa: E501 + Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_member_credentials_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_tags_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -8388,13 +8418,12 @@ def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictS :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(CredentialsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TagsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', 'user_guid', 'page', 'records_per_page' @@ -8416,7 +8445,7 @@ def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictS if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_member_credentials" % _key + " to method list_tags" % _key ) _params[_key] = _val del _params['kwargs'] @@ -8425,9 +8454,6 @@ def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictS # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -8455,11 +8481,11 @@ def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictS _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "CredentialsResponseBody", + '200': "TagsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/credentials', 'GET', + '/users/{user_guid}/tags', 'GET', _path_params, _query_params, _header_params, @@ -8476,16 +8502,18 @@ def list_member_credentials_with_http_info(self, member_guid : Annotated[StrictS _request_auth=_params.get('_request_auth')) @validate_arguments - def list_members(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> MembersResponseBody: # noqa: E501 - """List members # noqa: E501 + def list_tax_documents(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TaxDocumentsResponseBody: # noqa: E501 + """List Tax Documents # noqa: E501 - This endpoint returns an array which contains information on every member associated with a specific user. # noqa: E501 + Use this endpoint to get a paginated list of tax documents. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_members(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_tax_documents(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -8501,25 +8529,27 @@ def list_members(self, user_guid : Annotated[StrictStr, Field(..., description=" :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MembersResponseBody + :rtype: TaxDocumentsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_members_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_tax_documents_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_members_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_tax_documents_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List members # noqa: E501 + def list_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List Tax Documents # noqa: E501 - This endpoint returns an array which contains information on every member associated with a specific user. # noqa: E501 + Use this endpoint to get a paginated list of tax documents. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_members_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_tax_documents_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param page: Specify current page. @@ -8548,12 +8578,13 @@ def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(... :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MembersResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TaxDocumentsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'member_guid', 'user_guid', 'page', 'records_per_page' @@ -8575,7 +8606,7 @@ def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(... if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_members" % _key + " to method list_tax_documents" % _key ) _params[_key] = _val del _params['kwargs'] @@ -8584,6 +8615,9 @@ def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(... # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -8611,11 +8645,11 @@ def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(... _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MembersResponseBody", + '200': "TaxDocumentsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members', 'GET', + '/users/{user_guid}/members/{member_guid}/tax_documents', 'GET', _path_params, _query_params, _header_params, @@ -8632,16 +8666,18 @@ def list_members_with_http_info(self, user_guid : Annotated[StrictStr, Field(... _request_auth=_params.get('_request_auth')) @validate_arguments - def list_merchants(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> MerchantsResponseBody: # noqa: E501 - """List merchants # noqa: E501 + def list_transaction_rules(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TransactionRulesResponseBody: # noqa: E501 + """List transaction rules # noqa: E501 - This endpoint returns a paginated list of all the merchants in the MX system. # noqa: E501 + Use this endpoint to read the attributes of all existing transaction rules belonging to the user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_merchants(page, records_per_page, async_req=True) + >>> thread = api.list_transaction_rules(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -8655,25 +8691,27 @@ def list_merchants(self, page : Annotated[Optional[StrictInt], Field(description :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MerchantsResponseBody + :rtype: TransactionRulesResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_merchants_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_transaction_rules_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_merchants_with_http_info(page, records_per_page, **kwargs) # noqa: E501 + return self.list_transaction_rules_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List merchants # noqa: E501 + def list_transaction_rules_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List transaction rules # noqa: E501 - This endpoint returns a paginated list of all the merchants in the MX system. # noqa: E501 + Use this endpoint to read the attributes of all existing transaction rules belonging to the user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_merchants_with_http_info(page, records_per_page, async_req=True) + >>> thread = api.list_transaction_rules_with_http_info(user_guid, page, records_per_page, async_req=True) >>> result = thread.get() + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. @@ -8700,12 +8738,13 @@ def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Fi :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MerchantsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionRulesResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'user_guid', 'page', 'records_per_page' ] @@ -8726,7 +8765,7 @@ def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Fi if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_merchants" % _key + " to method list_transaction_rules" % _key ) _params[_key] = _val del _params['kwargs'] @@ -8735,6 +8774,9 @@ def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Fi # process the path parameters _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + # process the query parameters _query_params = [] @@ -8759,11 +8801,11 @@ def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Fi _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MerchantsResponseBody", + '200': "TransactionRulesResponseBody", } return self.api_client.call_api( - '/merchants', 'GET', + '/users/{user_guid}/transaction_rules', 'GET', _path_params, _query_params, _header_params, @@ -8780,24 +8822,26 @@ def list_merchants_with_http_info(self, page : Annotated[Optional[StrictInt], Fi _request_auth=_params.get('_request_auth')) @validate_arguments - def list_spending_plan_accounts(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanAccountsResponse: # noqa: E501 - """List spending plan accounts # noqa: E501 + def list_transactions(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 + """List transactions # noqa: E501 - Use this endpoint to list all the spending plan accounts associated with the spending plan. # noqa: E501 + Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plan_accounts(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions(user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -8807,33 +8851,35 @@ def list_spending_plan_accounts(self, user_guid : Annotated[StrictStr, Field(... :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanAccountsResponse + :rtype: TransactionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_spending_plan_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_transactions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_transactions_with_http_info(user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List spending plan accounts # noqa: E501 + def list_transactions_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List transactions # noqa: E501 - Use this endpoint to list all the spending plan accounts associated with the spending plan. # noqa: E501 + Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_with_http_info(user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -8856,16 +8902,17 @@ def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[Stric :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanAccountsResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ 'user_guid', - 'spending_plan_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -8884,7 +8931,7 @@ def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[Stric if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_spending_plan_accounts" % _key + " to method list_transactions" % _key ) _params[_key] = _val del _params['kwargs'] @@ -8896,18 +8943,21 @@ def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[Stric if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -8923,11 +8973,11 @@ def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[Stric _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanAccountsResponse", + '200': "TransactionsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts', 'GET', + '/users/{user_guid}/transactions', 'GET', _path_params, _query_params, _header_params, @@ -8944,24 +8994,28 @@ def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[Stric _request_auth=_params.get('_request_auth')) @validate_arguments - def list_spending_plan_iteration_items(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationItemsResponseBody: # noqa: E501 - """List spending plan iteration items # noqa: E501 + def list_transactions_by_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 + """List transactions by account # noqa: E501 - Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. # noqa: E501 + This endpoint returns a list of the last 90 days of transactions associated with the specified account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plan_iteration_items(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_by_account(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -8971,33 +9025,37 @@ def list_spending_plan_iteration_items(self, user_guid : Annotated[StrictStr, Fi :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanIterationItemsResponseBody + :rtype: TransactionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_spending_plan_iteration_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_transactions_by_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_transactions_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List spending plan iteration items # noqa: E501 + def list_transactions_by_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List transactions by account # noqa: E501 - Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. # noqa: E501 + This endpoint returns a list of the last 90 days of transactions associated with the specified account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -9020,16 +9078,18 @@ def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotate :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanIterationItemsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'account_guid', 'user_guid', - 'spending_plan_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -9048,7 +9108,7 @@ def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotate if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_spending_plan_iteration_items" % _key + " to method list_transactions_by_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -9057,21 +9117,27 @@ def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotate # process the path parameters _path_params = {} + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -9087,11 +9153,11 @@ def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotate _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanIterationItemsResponseBody", + '200': "TransactionsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items', 'GET', + '/users/{user_guid}/accounts/{account_guid}/transactions', 'GET', _path_params, _query_params, _header_params, @@ -9108,24 +9174,28 @@ def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotate _request_auth=_params.get('_request_auth')) @validate_arguments - def list_spending_plan_iterations(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationsResponse: # noqa: E501 - """List spending plan iterations # noqa: E501 + def list_transactions_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 + """List transactions by member # noqa: E501 - Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. # noqa: E501 + Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plan_iterations(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_by_member(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -9135,33 +9205,37 @@ def list_spending_plan_iterations(self, user_guid : Annotated[StrictStr, Field(. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanIterationsResponse + :rtype: TransactionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_spending_plan_iterations_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_transactions_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_transactions_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List spending plan iterations # noqa: E501 + def list_transactions_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List transactions by member # noqa: E501 - Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. # noqa: E501 + Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -9184,16 +9258,18 @@ def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[Str :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanIterationsResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'member_guid', 'user_guid', - 'spending_plan_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -9212,7 +9288,7 @@ def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[Str if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_spending_plan_iterations" % _key + " to method list_transactions_by_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -9221,21 +9297,27 @@ def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[Str # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -9251,11 +9333,11 @@ def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[Str _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanIterationsResponse", + '200': "TransactionsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations', 'GET', + '/users/{user_guid}/members/{member_guid}/transactions', 'GET', _path_params, _query_params, _header_params, @@ -9272,22 +9354,28 @@ def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[Str _request_auth=_params.get('_request_auth')) @validate_arguments - def list_spending_plans(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlansResponseBody: # noqa: E501 - """List spending plans # noqa: E501 + def list_transactions_by_tag(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 + """List transactions by tag # noqa: E501 - Use this endpoint to list all the spending plans associated with the user. # noqa: E501 + Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plans(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_by_tag(tag_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param tag_guid: The unique id for a `tag`. (required) + :type tag_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -9297,31 +9385,37 @@ def list_spending_plans(self, user_guid : Annotated[StrictStr, Field(..., descri :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlansResponseBody + :rtype: TransactionsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_spending_plans_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_transactions_by_tag_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_spending_plans_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_transactions_by_tag_with_http_info(tag_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 @validate_arguments - def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List spending plans # noqa: E501 + def list_transactions_by_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List transactions by tag # noqa: E501 - Use this endpoint to list all the spending plans associated with the user. # noqa: E501 + Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_spending_plans_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_transactions_by_tag_with_http_info(tag_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) >>> result = thread.get() + :param tag_guid: The unique id for a `tag`. (required) + :type tag_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param from_date: Filter transactions from this date. + :type from_date: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param to_date: Filter transactions to this date. + :type to_date: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -9344,15 +9438,18 @@ def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Fi :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlansResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'tag_guid', 'user_guid', + 'from_date', 'page', - 'records_per_page' + 'records_per_page', + 'to_date' ] _all_params.extend( [ @@ -9371,7 +9468,7 @@ def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Fi if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_spending_plans" % _key + " to method list_transactions_by_tag" % _key ) _params[_key] = _val del _params['kwargs'] @@ -9380,18 +9477,27 @@ def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Fi # process the path parameters _path_params = {} + if _params['tag_guid']: + _path_params['tag_guid'] = _params['tag_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] + if _params.get('from_date') is not None: # noqa: E501 + _query_params.append(('from_date', _params['from_date'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('to_date') is not None: # noqa: E501 + _query_params.append(('to_date', _params['to_date'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -9407,11 +9513,11 @@ def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Fi _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlansResponseBody", + '200': "TransactionsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans', 'GET', + '/users/{user_guid}/tags/{tag_guid}/transactions', 'GET', _path_params, _query_params, _header_params, @@ -9428,22 +9534,24 @@ def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Fi _request_auth=_params.get('_request_auth')) @validate_arguments - def list_statements_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> StatementsResponseBody: # noqa: E501 - """List statements by member # noqa: E501 + def list_user_accounts(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, is_manual : Annotated[Optional[StrictBool], Field(description="List only accounts that were manually created.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountsResponseBody: # noqa: E501 + """List accounts # noqa: E501 - Use this endpoint to get an array of available statements. # noqa: E501 + This endpoint returns a list of all the accounts associated with the specified `user`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_statements_by_member(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_user_accounts(user_guid, member_is_managed_by_user, page, is_manual, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param member_is_managed_by_user: List only accounts whose member is managed by the user. + :type member_is_managed_by_user: bool :param page: Specify current page. :type page: int + :param is_manual: List only accounts that were manually created. + :type is_manual: bool :param records_per_page: Specify records per page. :type records_per_page: int :param async_req: Whether to execute the request asynchronously. @@ -9455,31 +9563,33 @@ def list_statements_by_member(self, member_guid : Annotated[StrictStr, Field(... :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: StatementsResponseBody + :rtype: AccountsResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_statements_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_user_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_statements_by_member_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_user_accounts_with_http_info(user_guid, member_is_managed_by_user, page, is_manual, records_per_page, **kwargs) # noqa: E501 @validate_arguments - def list_statements_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List statements by member # noqa: E501 + def list_user_accounts_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, is_manual : Annotated[Optional[StrictBool], Field(description="List only accounts that were manually created.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List accounts # noqa: E501 - Use this endpoint to get an array of available statements. # noqa: E501 + This endpoint returns a list of all the accounts associated with the specified `user`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_statements_by_member_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_user_accounts_with_http_info(user_guid, member_is_managed_by_user, page, is_manual, records_per_page, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str + :param member_is_managed_by_user: List only accounts whose member is managed by the user. + :type member_is_managed_by_user: bool :param page: Specify current page. :type page: int + :param is_manual: List only accounts that were manually created. + :type is_manual: bool :param records_per_page: Specify records per page. :type records_per_page: int :param async_req: Whether to execute the request asynchronously. @@ -9504,15 +9614,16 @@ def list_statements_by_member_with_http_info(self, member_guid : Annotated[Stric :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(StatementsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountsResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', 'user_guid', + 'member_is_managed_by_user', 'page', + 'is_manual', 'records_per_page' ] _all_params.extend( @@ -9532,7 +9643,7 @@ def list_statements_by_member_with_http_info(self, member_guid : Annotated[Stric if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_statements_by_member" % _key + " to method list_user_accounts" % _key ) _params[_key] = _val del _params['kwargs'] @@ -9541,18 +9652,21 @@ def list_statements_by_member_with_http_info(self, member_guid : Annotated[Stric # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] # process the query parameters _query_params = [] + if _params.get('member_is_managed_by_user') is not None: # noqa: E501 + _query_params.append(('member_is_managed_by_user', _params['member_is_managed_by_user'])) + if _params.get('page') is not None: # noqa: E501 _query_params.append(('page', _params['page'])) + if _params.get('is_manual') is not None: # noqa: E501 + _query_params.append(('is_manual', _params['is_manual'])) + if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) @@ -9571,11 +9685,11 @@ def list_statements_by_member_with_http_info(self, member_guid : Annotated[Stric _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "StatementsResponseBody", + '200': "AccountsResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/statements', 'GET', + '/users/{user_guid}/accounts', 'GET', _path_params, _query_params, _header_params, @@ -9592,22 +9706,26 @@ def list_statements_by_member_with_http_info(self, member_guid : Annotated[Stric _request_auth=_params.get('_request_auth')) @validate_arguments - def list_taggings(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TaggingsResponseBody: # noqa: E501 - """List taggings # noqa: E501 - - Use this endpoint to retrieve a list of all the taggings associated with a specific user. # noqa: E501 + def list_users(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, id : Annotated[Optional[StrictStr], Field(description="The user `id` to search for.")] = None, email : Annotated[Optional[StrictStr], Field(description="The user `email` to search for.")] = None, is_disabled : Annotated[Optional[StrictBool], Field(description="Search for users that are diabled.")] = None, **kwargs) -> UsersResponseBody: # noqa: E501 + """List users # noqa: E501 + + Use this endpoint to list every user you've created in the MX Platform API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_taggings(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_users(page, records_per_page, id, email, is_disabled, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param id: The user `id` to search for. + :type id: str + :param email: The user `email` to search for. + :type email: str + :param is_disabled: Search for users that are diabled. + :type is_disabled: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -9617,31 +9735,35 @@ def list_taggings(self, user_guid : Annotated[StrictStr, Field(..., description= :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TaggingsResponseBody + :rtype: UsersResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_taggings_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the list_users_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_taggings_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.list_users_with_http_info(page, records_per_page, id, email, is_disabled, **kwargs) # noqa: E501 @validate_arguments - def list_taggings_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List taggings # noqa: E501 + def list_users_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, id : Annotated[Optional[StrictStr], Field(description="The user `id` to search for.")] = None, email : Annotated[Optional[StrictStr], Field(description="The user `email` to search for.")] = None, is_disabled : Annotated[Optional[StrictBool], Field(description="Search for users that are diabled.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List users # noqa: E501 - Use this endpoint to retrieve a list of all the taggings associated with a specific user. # noqa: E501 + Use this endpoint to list every user you've created in the MX Platform API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_taggings_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> thread = api.list_users_with_http_info(page, records_per_page, id, email, is_disabled, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str :param page: Specify current page. :type page: int :param records_per_page: Specify records per page. :type records_per_page: int + :param id: The user `id` to search for. + :type id: str + :param email: The user `email` to search for. + :type email: str + :param is_disabled: Search for users that are diabled. + :type is_disabled: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -9664,15 +9786,17 @@ def list_taggings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(TaggingsResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(UsersResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', 'page', - 'records_per_page' + 'records_per_page', + 'id', + 'email', + 'is_disabled' ] _all_params.extend( [ @@ -9691,7 +9815,7 @@ def list_taggings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method list_taggings" % _key + " to method list_users" % _key ) _params[_key] = _val del _params['kwargs'] @@ -9700,9 +9824,6 @@ def list_taggings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - # process the query parameters _query_params = [] @@ -9712,161 +9833,14 @@ def list_taggings_with_http_info(self, user_guid : Annotated[StrictStr, Field(.. if _params.get('records_per_page') is not None: # noqa: E501 _query_params.append(('records_per_page', _params['records_per_page'])) - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TaggingsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/taggings', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_tags(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TagsResponseBody: # noqa: E501 - """List tags # noqa: E501 - - Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_tags(user_guid, page, records_per_page, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TagsResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_tags_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_tags_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 - - @validate_arguments - def list_tags_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List tags # noqa: E501 - - Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_tags_with_http_info(user_guid, page, records_per_page, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TagsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'user_guid', - 'page', - 'records_per_page' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_tags" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - + if _params.get('id') is not None: # noqa: E501 + _query_params.append(('id', _params['id'])) - # process the query parameters - _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) + if _params.get('email') is not None: # noqa: E501 + _query_params.append(('email', _params['email'])) - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) + if _params.get('is_disabled') is not None: # noqa: E501 + _query_params.append(('is_disabled', _params['is_disabled'])) # process the header parameters _header_params = dict(_params.get('_headers', {})) @@ -9883,11 +9857,11 @@ def list_tags_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., d _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "TagsResponseBody", + '200': "UsersResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/tags', 'GET', + '/users', 'GET', _path_params, _query_params, _header_params, @@ -9904,24 +9878,20 @@ def list_tags_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., d _request_auth=_params.get('_request_auth')) @validate_arguments - def list_tax_documents(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TaxDocumentsResponseBody: # noqa: E501 - """List Tax Documents # noqa: E501 + def read_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> AccountResponseBody: # noqa: E501 + """Read account # noqa: E501 - Use this endpoint to get a paginated list of tax documents. # noqa: E501 + This endpoint returns the specified `account` resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_tax_documents(member_guid, user_guid, page, records_per_page, async_req=True) + >>> thread = api.read_account(account_guid, user_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -9931,1991 +9901,27 @@ def list_tax_documents(self, member_guid : Annotated[StrictStr, Field(..., descr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TaxDocumentsResponseBody + :rtype: AccountResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the list_tax_documents_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.list_tax_documents_with_http_info(member_guid, user_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.read_account_with_http_info(account_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def list_tax_documents_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List Tax Documents # noqa: E501 - - Use this endpoint to get a paginated list of tax documents. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_tax_documents_with_http_info(member_guid, user_guid, page, records_per_page, async_req=True) - >>> result = thread.get() + def read_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read account # noqa: E501 - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TaxDocumentsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'member_guid', - 'user_guid', - 'page', - 'records_per_page' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_tax_documents" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TaxDocumentsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/tax_documents', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_transaction_rules(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> TransactionRulesResponseBody: # noqa: E501 - """List transaction rules # noqa: E501 - - Use this endpoint to read the attributes of all existing transaction rules belonging to the user. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transaction_rules(user_guid, page, records_per_page, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TransactionRulesResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_transaction_rules_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_transaction_rules_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 - - @validate_arguments - def list_transaction_rules_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List transaction rules # noqa: E501 - - Use this endpoint to read the attributes of all existing transaction rules belonging to the user. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transaction_rules_with_http_info(user_guid, page, records_per_page, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TransactionRulesResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'user_guid', - 'page', - 'records_per_page' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_transaction_rules" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TransactionRulesResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/transaction_rules', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_transactions(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 - """List transactions # noqa: E501 - - Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions(user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TransactionsResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_transactions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_transactions_with_http_info(user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 - - @validate_arguments - def list_transactions_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List transactions # noqa: E501 - - Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_with_http_info(user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'user_guid', - 'from_date', - 'page', - 'records_per_page', - 'to_date' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_transactions" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TransactionsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/transactions', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_transactions_by_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 - """List transactions by account # noqa: E501 - - This endpoint returns a list of the last 90 days of transactions associated with the specified account. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_by_account(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TransactionsResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_transactions_by_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_transactions_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 - - @validate_arguments - def list_transactions_by_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List transactions by account # noqa: E501 - - This endpoint returns a list of the last 90 days of transactions associated with the specified account. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_by_account_with_http_info(account_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'account_guid', - 'user_guid', - 'from_date', - 'page', - 'records_per_page', - 'to_date' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_transactions_by_account" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TransactionsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/accounts/{account_guid}/transactions', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_transactions_by_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 - """List transactions by member # noqa: E501 - - Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_by_member(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TransactionsResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_transactions_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_transactions_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 - - @validate_arguments - def list_transactions_by_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List transactions by member # noqa: E501 - - Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_by_member_with_http_info(member_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'member_guid', - 'user_guid', - 'from_date', - 'page', - 'records_per_page', - 'to_date' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_transactions_by_member" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TransactionsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/transactions', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_transactions_by_tag(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> TransactionsResponseBody: # noqa: E501 - """List transactions by tag # noqa: E501 - - Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_by_tag(tag_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param tag_guid: The unique id for a `tag`. (required) - :type tag_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TransactionsResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_transactions_by_tag_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_transactions_by_tag_with_http_info(tag_guid, user_guid, from_date, page, records_per_page, to_date, **kwargs) # noqa: E501 - - @validate_arguments - def list_transactions_by_tag_with_http_info(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], from_date : Annotated[Optional[StrictStr], Field(description="Filter transactions from this date.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, to_date : Annotated[Optional[StrictStr], Field(description="Filter transactions to this date.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List transactions by tag # noqa: E501 - - Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_transactions_by_tag_with_http_info(tag_guid, user_guid, from_date, page, records_per_page, to_date, async_req=True) - >>> result = thread.get() - - :param tag_guid: The unique id for a `tag`. (required) - :type tag_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param from_date: Filter transactions from this date. - :type from_date: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param to_date: Filter transactions to this date. - :type to_date: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TransactionsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'tag_guid', - 'user_guid', - 'from_date', - 'page', - 'records_per_page', - 'to_date' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_transactions_by_tag" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['tag_guid']: - _path_params['tag_guid'] = _params['tag_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('from_date') is not None: # noqa: E501 - _query_params.append(('from_date', _params['from_date'])) - - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - if _params.get('to_date') is not None: # noqa: E501 - _query_params.append(('to_date', _params['to_date'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "TransactionsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/tags/{tag_guid}/transactions', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_user_accounts(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, is_manual : Annotated[Optional[StrictBool], Field(description="List only accounts that were manually created.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> AccountsResponseBody: # noqa: E501 - """List accounts # noqa: E501 - - This endpoint returns a list of all the accounts associated with the specified `user`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_user_accounts(user_guid, member_is_managed_by_user, page, is_manual, records_per_page, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param member_is_managed_by_user: List only accounts whose member is managed by the user. - :type member_is_managed_by_user: bool - :param page: Specify current page. - :type page: int - :param is_manual: List only accounts that were manually created. - :type is_manual: bool - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: AccountsResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_user_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_user_accounts_with_http_info(user_guid, member_is_managed_by_user, page, is_manual, records_per_page, **kwargs) # noqa: E501 - - @validate_arguments - def list_user_accounts_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], member_is_managed_by_user : Annotated[Optional[StrictBool], Field(description="List only accounts whose member is managed by the user.")] = None, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, is_manual : Annotated[Optional[StrictBool], Field(description="List only accounts that were manually created.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List accounts # noqa: E501 - - This endpoint returns a list of all the accounts associated with the specified `user`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_user_accounts_with_http_info(user_guid, member_is_managed_by_user, page, is_manual, records_per_page, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param member_is_managed_by_user: List only accounts whose member is managed by the user. - :type member_is_managed_by_user: bool - :param page: Specify current page. - :type page: int - :param is_manual: List only accounts that were manually created. - :type is_manual: bool - :param records_per_page: Specify records per page. - :type records_per_page: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(AccountsResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'user_guid', - 'member_is_managed_by_user', - 'page', - 'is_manual', - 'records_per_page' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_user_accounts" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - if _params.get('member_is_managed_by_user') is not None: # noqa: E501 - _query_params.append(('member_is_managed_by_user', _params['member_is_managed_by_user'])) - - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('is_manual') is not None: # noqa: E501 - _query_params.append(('is_manual', _params['is_manual'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "AccountsResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/accounts', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def list_users(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, id : Annotated[Optional[StrictStr], Field(description="The user `id` to search for.")] = None, email : Annotated[Optional[StrictStr], Field(description="The user `email` to search for.")] = None, is_disabled : Annotated[Optional[StrictBool], Field(description="Search for users that are diabled.")] = None, **kwargs) -> UsersResponseBody: # noqa: E501 - """List users # noqa: E501 - - Use this endpoint to list every user you've created in the MX Platform API. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_users(page, records_per_page, id, email, is_disabled, async_req=True) - >>> result = thread.get() - - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param id: The user `id` to search for. - :type id: str - :param email: The user `email` to search for. - :type email: str - :param is_disabled: Search for users that are diabled. - :type is_disabled: bool - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsersResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the list_users_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.list_users_with_http_info(page, records_per_page, id, email, is_disabled, **kwargs) # noqa: E501 - - @validate_arguments - def list_users_with_http_info(self, page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, id : Annotated[Optional[StrictStr], Field(description="The user `id` to search for.")] = None, email : Annotated[Optional[StrictStr], Field(description="The user `email` to search for.")] = None, is_disabled : Annotated[Optional[StrictBool], Field(description="Search for users that are diabled.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """List users # noqa: E501 - - Use this endpoint to list every user you've created in the MX Platform API. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_users_with_http_info(page, records_per_page, id, email, is_disabled, async_req=True) - >>> result = thread.get() - - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int - :param id: The user `id` to search for. - :type id: str - :param email: The user `email` to search for. - :type email: str - :param is_disabled: Search for users that are diabled. - :type is_disabled: bool - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsersResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'page', - 'records_per_page', - 'id', - 'email', - 'is_disabled' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_users" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - - # process the query parameters - _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - - if _params.get('id') is not None: # noqa: E501 - _query_params.append(('id', _params['id'])) - - if _params.get('email') is not None: # noqa: E501 - _query_params.append(('email', _params['email'])) - - if _params.get('is_disabled') is not None: # noqa: E501 - _query_params.append(('is_disabled', _params['is_disabled'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "UsersResponseBody", - } - - return self.api_client.call_api( - '/users', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def read_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> AccountResponseBody: # noqa: E501 - """Read account # noqa: E501 - - This endpoint returns the specified `account` resource. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_account(account_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: AccountResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the read_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.read_account_with_http_info(account_guid, user_guid, **kwargs) # noqa: E501 - - @validate_arguments - def read_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read account # noqa: E501 - - This endpoint returns the specified `account` resource. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_account_with_http_info(account_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(AccountResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'account_guid', - 'user_guid' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method read_account" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "AccountResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/accounts/{account_guid}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def read_account_by_member(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> AccountResponseBody: # noqa: E501 - """Read account by member # noqa: E501 - - This endpoint allows you to read the attributes of an `account` resource. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_account_by_member(account_guid, member_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: AccountResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the read_account_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.read_account_by_member_with_http_info(account_guid, member_guid, user_guid, **kwargs) # noqa: E501 - - @validate_arguments - def read_account_by_member_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read account by member # noqa: E501 - - This endpoint allows you to read the attributes of an `account` resource. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_account_by_member_with_http_info(account_guid, member_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(AccountResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'account_guid', - 'member_guid', - 'user_guid' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method read_account_by_member" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "AccountResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/accounts/{account_guid}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def read_category(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> CategoryResponseBody: # noqa: E501 - """Read a custom category # noqa: E501 - - Use this endpoint to read the attributes of either a default category or a custom category. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_category(category_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param category_guid: The unique id for a `category`. (required) - :type category_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CategoryResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the read_category_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.read_category_with_http_info(category_guid, user_guid, **kwargs) # noqa: E501 - - @validate_arguments - def read_category_with_http_info(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read a custom category # noqa: E501 - - Use this endpoint to read the attributes of either a default category or a custom category. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_category_with_http_info(category_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param category_guid: The unique id for a `category`. (required) - :type category_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CategoryResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'category_guid', - 'user_guid' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method read_category" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['category_guid']: - _path_params['category_guid'] = _params['category_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "CategoryResponseBody", - } - - return self.api_client.call_api( - '/users/{user_guid}/categories/{category_guid}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def read_default_category(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], **kwargs) -> CategoryResponseBody: # noqa: E501 - """Read a default category # noqa: E501 - - Use this endpoint to read the attributes of a default category. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_default_category(category_guid, async_req=True) - >>> result = thread.get() - - :param category_guid: The unique id for a `category`. (required) - :type category_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CategoryResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the read_default_category_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.read_default_category_with_http_info(category_guid, **kwargs) # noqa: E501 - - @validate_arguments - def read_default_category_with_http_info(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read a default category # noqa: E501 - - Use this endpoint to read the attributes of a default category. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_default_category_with_http_info(category_guid, async_req=True) - >>> result = thread.get() - - :param category_guid: The unique id for a `category`. (required) - :type category_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CategoryResponseBody, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'category_guid' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method read_default_category" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['category_guid']: - _path_params['category_guid'] = _params['category_guid'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "CategoryResponseBody", - } - - return self.api_client.call_api( - '/categories/{category_guid}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def read_holding(self, holding_guid : Annotated[StrictStr, Field(..., description="The unique id for a `holding`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> HoldingResponseBody: # noqa: E501 - """Read holding # noqa: E501 - - Use this endpoint to read the attributes of a specific `holding`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.read_holding(holding_guid, user_guid, async_req=True) - >>> result = thread.get() - - :param holding_guid: The unique id for a `holding`. (required) - :type holding_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: HoldingResponseBody - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the read_holding_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.read_holding_with_http_info(holding_guid, user_guid, **kwargs) # noqa: E501 - - @validate_arguments - def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field(..., description="The unique id for a `holding`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read holding # noqa: E501 - - Use this endpoint to read the attributes of a specific `holding`. # noqa: E501 + This endpoint returns the specified `account` resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_holding_with_http_info(holding_guid, user_guid, async_req=True) + >>> thread = api.read_account_with_http_info(account_guid, user_guid, async_req=True) >>> result = thread.get() - :param holding_guid: The unique id for a `holding`. (required) - :type holding_guid: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -11940,13 +9946,13 @@ def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field( :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(HoldingResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'holding_guid', + 'account_guid', 'user_guid' ] _all_params.extend( @@ -11966,7 +9972,7 @@ def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field( if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_holding" % _key + " to method read_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -11975,8 +9981,8 @@ def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field( # process the path parameters _path_params = {} - if _params['holding_guid']: - _path_params['holding_guid'] = _params['holding_guid'] + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -11999,11 +10005,11 @@ def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field( _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "HoldingResponseBody", + '200': "AccountResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/holdings/{holding_guid}', 'GET', + '/users/{user_guid}/accounts/{account_guid}', 'GET', _path_params, _query_params, _header_params, @@ -12020,18 +10026,22 @@ def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field( _request_auth=_params.get('_request_auth')) @validate_arguments - def read_institution(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], **kwargs) -> InstitutionResponseBody: # noqa: E501 - """Read institution # noqa: E501 + def read_account_by_member(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> AccountResponseBody: # noqa: E501 + """Read account by member # noqa: E501 - This endpoint returns information about the institution specified by `institution_code`. # noqa: E501 + This endpoint allows you to read the attributes of an `account` resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_institution(institution_code, async_req=True) + >>> thread = api.read_account_by_member(account_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() - :param institution_code: The institution_code of the institution. (required) - :type institution_code: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -12041,27 +10051,31 @@ def read_institution(self, institution_code : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: InstitutionResponseBody + :rtype: AccountResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_institution_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_account_by_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_institution_with_http_info(institution_code, **kwargs) # noqa: E501 + return self.read_account_by_member_with_http_info(account_guid, member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_institution_with_http_info(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read institution # noqa: E501 + def read_account_by_member_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read account by member # noqa: E501 - This endpoint returns information about the institution specified by `institution_code`. # noqa: E501 + This endpoint allows you to read the attributes of an `account` resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_institution_with_http_info(institution_code, async_req=True) + >>> thread = api.read_account_by_member_with_http_info(account_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() - :param institution_code: The institution_code of the institution. (required) - :type institution_code: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -12084,13 +10098,15 @@ def read_institution_with_http_info(self, institution_code : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(InstitutionResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'institution_code' + 'account_guid', + 'member_guid', + 'user_guid' ] _all_params.extend( [ @@ -12109,7 +10125,7 @@ def read_institution_with_http_info(self, institution_code : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_institution" % _key + " to method read_account_by_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -12118,8 +10134,14 @@ def read_institution_with_http_info(self, institution_code : Annotated[StrictStr # process the path parameters _path_params = {} - if _params['institution_code']: - _path_params['institution_code'] = _params['institution_code'] + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] # process the query parameters @@ -12139,11 +10161,11 @@ def read_institution_with_http_info(self, institution_code : Annotated[StrictStr _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "InstitutionResponseBody", + '200': "AccountResponseBody", } return self.api_client.call_api( - '/institutions/{institution_code}', 'GET', + '/users/{user_guid}/members/{member_guid}/accounts/{account_guid}', 'GET', _path_params, _query_params, _header_params, @@ -12160,20 +10182,18 @@ def read_institution_with_http_info(self, institution_code : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def read_managed_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> AccountResponseBody: # noqa: E501 - """Read managed account # noqa: E501 + def read_category(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> CategoryResponseBody: # noqa: E501 + """Read a custom category # noqa: E501 - Use this endpoint to read the attributes of a partner-managed account according to its unique guid. # noqa: E501 + Use this endpoint to read the attributes of either a default category or a custom category. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_managed_account(account_guid, member_guid, user_guid, async_req=True) + >>> thread = api.read_category(category_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param category_guid: The unique id for a `category`. (required) + :type category_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -12185,29 +10205,27 @@ def read_managed_account(self, account_guid : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: AccountResponseBody + :rtype: CategoryResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_managed_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_category_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_managed_account_with_http_info(account_guid, member_guid, user_guid, **kwargs) # noqa: E501 + return self.read_category_with_http_info(category_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read managed account # noqa: E501 + def read_category_with_http_info(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read a custom category # noqa: E501 - Use this endpoint to read the attributes of a partner-managed account according to its unique guid. # noqa: E501 + Use this endpoint to read the attributes of either a default category or a custom category. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_managed_account_with_http_info(account_guid, member_guid, user_guid, async_req=True) + >>> thread = api.read_category_with_http_info(category_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str + :param category_guid: The unique id for a `category`. (required) + :type category_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -12232,14 +10250,13 @@ def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(AccountResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CategoryResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'account_guid', - 'member_guid', + 'category_guid', 'user_guid' ] _all_params.extend( @@ -12259,7 +10276,7 @@ def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_managed_account" % _key + " to method read_category" % _key ) _params[_key] = _val del _params['kwargs'] @@ -12268,11 +10285,8 @@ def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] + if _params['category_guid']: + _path_params['category_guid'] = _params['category_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -12295,11 +10309,11 @@ def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "AccountResponseBody", + '200': "CategoryResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}', 'GET', + '/users/{user_guid}/categories/{category_guid}', 'GET', _path_params, _query_params, _header_params, @@ -12316,20 +10330,18 @@ def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def read_managed_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 - """Read managed member # noqa: E501 + def read_default_category(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], **kwargs) -> CategoryResponseBody: # noqa: E501 + """Read a default category # noqa: E501 - This endpoint returns the attributes of the specified partner-managed `member`. # noqa: E501 + Use this endpoint to read the attributes of a default category. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_managed_member(member_guid, user_guid, async_req=True) + >>> thread = api.read_default_category(category_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param category_guid: The unique id for a `category`. (required) + :type category_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -12339,29 +10351,27 @@ def read_managed_member(self, member_guid : Annotated[StrictStr, Field(..., desc :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberResponseBody + :rtype: CategoryResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_managed_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_default_category_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_managed_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.read_default_category_with_http_info(category_guid, **kwargs) # noqa: E501 @validate_arguments - def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read managed member # noqa: E501 + def read_default_category_with_http_info(self, category_guid : Annotated[StrictStr, Field(..., description="The unique id for a `category`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read a default category # noqa: E501 - This endpoint returns the attributes of the specified partner-managed `member`. # noqa: E501 + Use this endpoint to read the attributes of a default category. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_managed_member_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.read_default_category_with_http_info(category_guid, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param category_guid: The unique id for a `category`. (required) + :type category_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -12384,14 +10394,13 @@ def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(CategoryResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', - 'user_guid' + 'category_guid' ] _all_params.extend( [ @@ -12410,7 +10419,7 @@ def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_managed_member" % _key + " to method read_default_category" % _key ) _params[_key] = _val del _params['kwargs'] @@ -12419,11 +10428,8 @@ def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] + if _params['category_guid']: + _path_params['category_guid'] = _params['category_guid'] # process the query parameters @@ -12443,11 +10449,11 @@ def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MemberResponseBody", + '200': "CategoryResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}', 'GET', + '/categories/{category_guid}', 'GET', _path_params, _query_params, _header_params, @@ -12464,22 +10470,18 @@ def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, _request_auth=_params.get('_request_auth')) @validate_arguments - def read_managed_transaction(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> TransactionResponseBody: # noqa: E501 - """Read managed transaction # noqa: E501 + def read_holding(self, holding_guid : Annotated[StrictStr, Field(..., description="The unique id for a `holding`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> HoldingResponseBody: # noqa: E501 + """Read holding # noqa: E501 - Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. # noqa: E501 + Use this endpoint to read the attributes of a specific `holding`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, async_req=True) + >>> thread = api.read_holding(holding_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param transaction_guid: The unique id for a `transaction`. (required) - :type transaction_guid: str + :param holding_guid: The unique id for a `holding`. (required) + :type holding_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -12491,31 +10493,27 @@ def read_managed_transaction(self, account_guid : Annotated[StrictStr, Field(... :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: TransactionResponseBody + :rtype: HoldingResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_managed_transaction_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_holding_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, **kwargs) # noqa: E501 + return self.read_holding_with_http_info(holding_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_managed_transaction_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read managed transaction # noqa: E501 + def read_holding_with_http_info(self, holding_guid : Annotated[StrictStr, Field(..., description="The unique id for a `holding`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read holding # noqa: E501 - Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. # noqa: E501 + Use this endpoint to read the attributes of a specific `holding`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, async_req=True) + >>> thread = api.read_holding_with_http_info(holding_guid, user_guid, async_req=True) >>> result = thread.get() - :param account_guid: The unique id for an `account`. (required) - :type account_guid: str - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param transaction_guid: The unique id for a `transaction`. (required) - :type transaction_guid: str + :param holding_guid: The unique id for a `holding`. (required) + :type holding_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str :param async_req: Whether to execute the request asynchronously. @@ -12540,15 +10538,13 @@ def read_managed_transaction_with_http_info(self, account_guid : Annotated[Stric :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(TransactionResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(HoldingResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'account_guid', - 'member_guid', - 'transaction_guid', + 'holding_guid', 'user_guid' ] _all_params.extend( @@ -12568,7 +10564,7 @@ def read_managed_transaction_with_http_info(self, account_guid : Annotated[Stric if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_managed_transaction" % _key + " to method read_holding" % _key ) _params[_key] = _val del _params['kwargs'] @@ -12577,14 +10573,8 @@ def read_managed_transaction_with_http_info(self, account_guid : Annotated[Stric # process the path parameters _path_params = {} - if _params['account_guid']: - _path_params['account_guid'] = _params['account_guid'] - - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['transaction_guid']: - _path_params['transaction_guid'] = _params['transaction_guid'] + if _params['holding_guid']: + _path_params['holding_guid'] = _params['holding_guid'] if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] @@ -12607,11 +10597,11 @@ def read_managed_transaction_with_http_info(self, account_guid : Annotated[Stric _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "TransactionResponseBody", + '200': "HoldingResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}', 'GET', + '/users/{user_guid}/holdings/{holding_guid}', 'GET', _path_params, _query_params, _header_params, @@ -12628,20 +10618,18 @@ def read_managed_transaction_with_http_info(self, account_guid : Annotated[Stric _request_auth=_params.get('_request_auth')) @validate_arguments - def read_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 - """Read member # noqa: E501 + def read_institution(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], **kwargs) -> InstitutionResponseBody: # noqa: E501 + """Read institution # noqa: E501 - Use this endpoint to read the attributes of a specific member. # noqa: E501 + This endpoint returns information about the institution specified by `institution_code`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_member(member_guid, user_guid, async_req=True) + >>> thread = api.read_institution(institution_code, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param institution_code: The institution_code of the institution. (required) + :type institution_code: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -12651,29 +10639,27 @@ def read_member(self, member_guid : Annotated[StrictStr, Field(..., description= :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberResponseBody + :rtype: InstitutionResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_institution_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.read_institution_with_http_info(institution_code, **kwargs) # noqa: E501 @validate_arguments - def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read member # noqa: E501 + def read_institution_with_http_info(self, institution_code : Annotated[StrictStr, Field(..., description="The institution_code of the institution.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read institution # noqa: E501 - Use this endpoint to read the attributes of a specific member. # noqa: E501 + This endpoint returns information about the institution specified by `institution_code`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_member_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.read_institution_with_http_info(institution_code, async_req=True) >>> result = thread.get() - :param member_guid: The unique id for a `member`. (required) - :type member_guid: str - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str + :param institution_code: The institution_code of the institution. (required) + :type institution_code: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -12696,14 +10682,13 @@ def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(.. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(InstitutionResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'member_guid', - 'user_guid' + 'institution_code' ] _all_params.extend( [ @@ -12722,7 +10707,7 @@ def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(.. if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_member" % _key + " to method read_institution" % _key ) _params[_key] = _val del _params['kwargs'] @@ -12731,11 +10716,8 @@ def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(.. # process the path parameters _path_params = {} - if _params['member_guid']: - _path_params['member_guid'] = _params['member_guid'] - - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] + if _params['institution_code']: + _path_params['institution_code'] = _params['institution_code'] # process the query parameters @@ -12755,11 +10737,11 @@ def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(.. _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MemberResponseBody", + '200': "InstitutionResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}', 'GET', + '/institutions/{institution_code}', 'GET', _path_params, _query_params, _header_params, @@ -12776,16 +10758,18 @@ def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(.. _request_auth=_params.get('_request_auth')) @validate_arguments - def read_member_status(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberStatusResponseBody: # noqa: E501 - """Read member status # noqa: E501 + def read_managed_account(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> AccountResponseBody: # noqa: E501 + """Read managed account # noqa: E501 - This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. # noqa: E501 + Use this endpoint to read the attributes of a partner-managed account according to its unique guid. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_member_status(member_guid, user_guid, async_req=True) + >>> thread = api.read_managed_account(account_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str :param user_guid: The unique id for a `user`. (required) @@ -12799,25 +10783,27 @@ def read_member_status(self, member_guid : Annotated[StrictStr, Field(..., descr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MemberStatusResponseBody + :rtype: AccountResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_member_status_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_managed_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_member_status_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 + return self.read_managed_account_with_http_info(account_guid, member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read member status # noqa: E501 + def read_managed_account_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read managed account # noqa: E501 - This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. # noqa: E501 + Use this endpoint to read the attributes of a partner-managed account according to its unique guid. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_member_status_with_http_info(member_guid, user_guid, async_req=True) + >>> thread = api.read_managed_account_with_http_info(account_guid, member_guid, user_guid, async_req=True) >>> result = thread.get() + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str :param member_guid: The unique id for a `member`. (required) :type member_guid: str :param user_guid: The unique id for a `user`. (required) @@ -12844,12 +10830,13 @@ def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MemberStatusResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(AccountResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'account_guid', 'member_guid', 'user_guid' ] @@ -12870,7 +10857,7 @@ def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, F if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_member_status" % _key + " to method read_managed_account" % _key ) _params[_key] = _val del _params['kwargs'] @@ -12879,6 +10866,9 @@ def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, F # process the path parameters _path_params = {} + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + if _params['member_guid']: _path_params['member_guid'] = _params['member_guid'] @@ -12903,11 +10893,11 @@ def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, F _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MemberStatusResponseBody", + '200': "AccountResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/members/{member_guid}/status', 'GET', + '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}', 'GET', _path_params, _query_params, _header_params, @@ -12924,18 +10914,20 @@ def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, F _request_auth=_params.get('_request_auth')) @validate_arguments - def read_merchant(self, merchant_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant`.")], **kwargs) -> MerchantResponseBody: # noqa: E501 - """Read merchant # noqa: E501 + def read_managed_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 + """Read managed member # noqa: E501 - Returns information about a particular merchant, such as a logo, name, and website. # noqa: E501 + This endpoint returns the attributes of the specified partner-managed `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_merchant(merchant_guid, async_req=True) + >>> thread = api.read_managed_member(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param merchant_guid: The unique id for a `merchant`. (required) - :type merchant_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -12945,27 +10937,29 @@ def read_merchant(self, merchant_guid : Annotated[StrictStr, Field(..., descript :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MerchantResponseBody + :rtype: MemberResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_merchant_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_managed_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_merchant_with_http_info(merchant_guid, **kwargs) # noqa: E501 + return self.read_managed_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read merchant # noqa: E501 + def read_managed_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read managed member # noqa: E501 - Returns information about a particular merchant, such as a logo, name, and website. # noqa: E501 + This endpoint returns the attributes of the specified partner-managed `member`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_merchant_with_http_info(merchant_guid, async_req=True) + >>> thread = api.read_managed_member_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() - :param merchant_guid: The unique id for a `merchant`. (required) - :type merchant_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -12988,13 +10982,14 @@ def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Fiel :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MerchantResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'merchant_guid' + 'member_guid', + 'user_guid' ] _all_params.extend( [ @@ -13013,7 +11008,7 @@ def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Fiel if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_merchant" % _key + " to method read_managed_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -13022,8 +11017,11 @@ def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Fiel # process the path parameters _path_params = {} - if _params['merchant_guid']: - _path_params['merchant_guid'] = _params['merchant_guid'] + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] # process the query parameters @@ -13043,11 +11041,11 @@ def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Fiel _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MerchantResponseBody", + '200': "MemberResponseBody", } return self.api_client.call_api( - '/merchants/{merchant_guid}', 'GET', + '/users/{user_guid}/managed_members/{member_guid}', 'GET', _path_params, _query_params, _header_params, @@ -13064,18 +11062,24 @@ def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Fiel _request_auth=_params.get('_request_auth')) @validate_arguments - def read_merchant_location(self, merchant_location_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant_location`.")], **kwargs) -> MerchantLocationResponseBody: # noqa: E501 - """Read merchant location # noqa: E501 + def read_managed_transaction(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> TransactionResponseBody: # noqa: E501 + """Read managed transaction # noqa: E501 - This endpoint returns the specified merchant_location resource. # noqa: E501 + Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_merchant_location(merchant_location_guid, async_req=True) + >>> thread = api.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, async_req=True) >>> result = thread.get() - :param merchant_location_guid: The unique id for a `merchant_location`. (required) - :type merchant_location_guid: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param transaction_guid: The unique id for a `transaction`. (required) + :type transaction_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -13085,27 +11089,33 @@ def read_merchant_location(self, merchant_location_guid : Annotated[StrictStr, F :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: MerchantLocationResponseBody + :rtype: TransactionResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_merchant_location_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_managed_transaction_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_merchant_location_with_http_info(merchant_location_guid, **kwargs) # noqa: E501 + return self.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_merchant_location_with_http_info(self, merchant_location_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant_location`.")], **kwargs) -> ApiResponse: # noqa: E501 - """Read merchant location # noqa: E501 + def read_managed_transaction_with_http_info(self, account_guid : Annotated[StrictStr, Field(..., description="The unique id for an `account`.")], member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], transaction_guid : Annotated[StrictStr, Field(..., description="The unique id for a `transaction`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read managed transaction # noqa: E501 - This endpoint returns the specified merchant_location resource. # noqa: E501 + Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_merchant_location_with_http_info(merchant_location_guid, async_req=True) + >>> thread = api.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, async_req=True) >>> result = thread.get() - :param merchant_location_guid: The unique id for a `merchant_location`. (required) - :type merchant_location_guid: str + :param account_guid: The unique id for an `account`. (required) + :type account_guid: str + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str + :param transaction_guid: The unique id for a `transaction`. (required) + :type transaction_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -13128,13 +11138,16 @@ def read_merchant_location_with_http_info(self, merchant_location_guid : Annotat :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(MerchantLocationResponseBody, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(TransactionResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'merchant_location_guid' + 'account_guid', + 'member_guid', + 'transaction_guid', + 'user_guid' ] _all_params.extend( [ @@ -13153,7 +11166,7 @@ def read_merchant_location_with_http_info(self, merchant_location_guid : Annotat if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_merchant_location" % _key + " to method read_managed_transaction" % _key ) _params[_key] = _val del _params['kwargs'] @@ -13162,8 +11175,17 @@ def read_merchant_location_with_http_info(self, merchant_location_guid : Annotat # process the path parameters _path_params = {} - if _params['merchant_location_guid']: - _path_params['merchant_location_guid'] = _params['merchant_location_guid'] + if _params['account_guid']: + _path_params['account_guid'] = _params['account_guid'] + + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + + if _params['transaction_guid']: + _path_params['transaction_guid'] = _params['transaction_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] # process the query parameters @@ -13183,11 +11205,11 @@ def read_merchant_location_with_http_info(self, merchant_location_guid : Annotat _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "MerchantLocationResponseBody", + '200': "TransactionResponseBody", } return self.api_client.call_api( - '/merchant_locations/{merchant_location_guid}', 'GET', + '/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}', 'GET', _path_params, _query_params, _header_params, @@ -13204,26 +11226,20 @@ def read_merchant_location_with_http_info(self, merchant_location_guid : Annotat _request_auth=_params.get('_request_auth')) @validate_arguments - def read_spending_plan_account(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanAccountResponse: # noqa: E501 - """Read spending plan account # noqa: E501 + def read_member(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberResponseBody: # noqa: E501 + """Read member # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. # noqa: E501 + Use this endpoint to read the attributes of a specific member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, page, records_per_page, async_req=True) + >>> thread = api.read_member(member_guid, user_guid, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param spending_plan_account_guid: The unique ID for the specified account. (required) - :type spending_plan_account_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -13233,35 +11249,29 @@ def read_spending_plan_account(self, user_guid : Annotated[StrictStr, Field(..., :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanAccountResponse + :rtype: MemberResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_spending_plan_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_member_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.read_member_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_spending_plan_account_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Read spending plan account # noqa: E501 + def read_member_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read member # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. # noqa: E501 + Use this endpoint to read the attributes of a specific member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, page, records_per_page, async_req=True) + >>> thread = api.read_member_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param spending_plan_account_guid: The unique ID for the specified account. (required) - :type spending_plan_account_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -13284,17 +11294,14 @@ def read_spending_plan_account_with_http_info(self, user_guid : Annotated[Strict :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanAccountResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MemberResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'spending_plan_account_guid', - 'page', - 'records_per_page' + 'member_guid', + 'user_guid' ] _all_params.extend( [ @@ -13313,7 +11320,7 @@ def read_spending_plan_account_with_http_info(self, user_guid : Annotated[Strict if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_spending_plan_account" % _key + " to method read_member" % _key ) _params[_key] = _val del _params['kwargs'] @@ -13322,24 +11329,15 @@ def read_spending_plan_account_with_http_info(self, user_guid : Annotated[Strict # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - - if _params['spending_plan_account_guid']: - _path_params['spending_plan_account_guid'] = _params['spending_plan_account_guid'] - # process the query parameters _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -13355,11 +11353,11 @@ def read_spending_plan_account_with_http_info(self, user_guid : Annotated[Strict _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanAccountResponse", + '200': "MemberResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}', 'GET', + '/users/{user_guid}/members/{member_guid}', 'GET', _path_params, _query_params, _header_params, @@ -13376,26 +11374,20 @@ def read_spending_plan_account_with_http_info(self, user_guid : Annotated[Strict _request_auth=_params.get('_request_auth')) @validate_arguments - def read_spending_plan_iteration(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_number : Annotated[StrictInt, Field(..., description="The current iteration number for the spending plan `iteration``.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationResponse: # noqa: E501 - """Read a spending plan iteration # noqa: E501 + def read_member_status(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> MemberStatusResponseBody: # noqa: E501 + """Read member status # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. # noqa: E501 + This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, page, records_per_page, async_req=True) + >>> thread = api.read_member_status(member_guid, user_guid, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_number: The current iteration number for the spending plan `iteration``. (required) - :type iteration_number: int - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -13405,35 +11397,29 @@ def read_spending_plan_iteration(self, user_guid : Annotated[StrictStr, Field(.. :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanIterationResponse + :rtype: MemberStatusResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_spending_plan_iteration_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_member_status_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, page, records_per_page, **kwargs) # noqa: E501 + return self.read_member_status_with_http_info(member_guid, user_guid, **kwargs) # noqa: E501 @validate_arguments - def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_number : Annotated[StrictInt, Field(..., description="The current iteration number for the spending plan `iteration``.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Read a spending plan iteration # noqa: E501 + def read_member_status_with_http_info(self, member_guid : Annotated[StrictStr, Field(..., description="The unique id for a `member`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read member status # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. # noqa: E501 + This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, page, records_per_page, async_req=True) + >>> thread = api.read_member_status_with_http_info(member_guid, user_guid, async_req=True) >>> result = thread.get() + :param member_guid: The unique id for a `member`. (required) + :type member_guid: str :param user_guid: The unique id for a `user`. (required) :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_number: The current iteration number for the spending plan `iteration``. (required) - :type iteration_number: int - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -13456,17 +11442,14 @@ def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[Stri :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanIterationResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MemberStatusResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'iteration_number', - 'page', - 'records_per_page' + 'member_guid', + 'user_guid' ] _all_params.extend( [ @@ -13485,7 +11468,7 @@ def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[Stri if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_spending_plan_iteration" % _key + " to method read_member_status" % _key ) _params[_key] = _val del _params['kwargs'] @@ -13494,24 +11477,15 @@ def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[Stri # process the path parameters _path_params = {} + if _params['member_guid']: + _path_params['member_guid'] = _params['member_guid'] + if _params['user_guid']: _path_params['user_guid'] = _params['user_guid'] - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - - if _params['iteration_number']: - _path_params['iteration_number'] = _params['iteration_number'] - # process the query parameters _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -13527,11 +11501,11 @@ def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[Stri _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanIterationResponse", + '200': "MemberStatusResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}', 'GET', + '/users/{user_guid}/members/{member_guid}/status', 'GET', _path_params, _query_params, _header_params, @@ -13548,26 +11522,18 @@ def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[Stri _request_auth=_params.get('_request_auth')) @validate_arguments - def read_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationItemResponse: # noqa: E501 - """Read a spending plan iteration item # noqa: E501 + def read_merchant(self, merchant_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant`.")], **kwargs) -> MerchantResponseBody: # noqa: E501 + """Read merchant # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. # noqa: E501 + Returns information about a particular merchant, such as a logo, name, and website. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, page, records_per_page, async_req=True) + >>> thread = api.read_merchant(merchant_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_item_guid: The unique ID for the `iteration_item`. (required) - :type iteration_item_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int + :param merchant_guid: The unique id for a `merchant`. (required) + :type merchant_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -13577,35 +11543,27 @@ def read_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Fie :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanIterationItemResponse + :rtype: MerchantResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_merchant_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.read_merchant_with_http_info(merchant_guid, **kwargs) # noqa: E501 @validate_arguments - def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Read a spending plan iteration item # noqa: E501 + def read_merchant_with_http_info(self, merchant_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read merchant # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. # noqa: E501 + Returns information about a particular merchant, such as a logo, name, and website. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, page, records_per_page, async_req=True) + >>> thread = api.read_merchant_with_http_info(merchant_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_item_guid: The unique ID for the `iteration_item`. (required) - :type iteration_item_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int + :param merchant_guid: The unique id for a `merchant`. (required) + :type merchant_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -13628,17 +11586,13 @@ def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanIterationItemResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MerchantResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'iteration_item_guid', - 'page', - 'records_per_page' + 'merchant_guid' ] _all_params.extend( [ @@ -13657,7 +11611,7 @@ def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_spending_plan_iteration_item" % _key + " to method read_merchant" % _key ) _params[_key] = _val del _params['kwargs'] @@ -13666,24 +11620,12 @@ def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - - if _params['iteration_item_guid']: - _path_params['iteration_item_guid'] = _params['iteration_item_guid'] + if _params['merchant_guid']: + _path_params['merchant_guid'] = _params['merchant_guid'] # process the query parameters _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -13699,11 +11641,11 @@ def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanIterationItemResponse", + '200': "MerchantResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}', 'GET', + '/merchants/{merchant_guid}', 'GET', _path_params, _query_params, _header_params, @@ -13720,24 +11662,18 @@ def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated _request_auth=_params.get('_request_auth')) @validate_arguments - def read_spending_plan_user(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanResponse: # noqa: E501 - """Read a spending plan for a user # noqa: E501 + def read_merchant_location(self, merchant_location_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant_location`.")], **kwargs) -> MerchantLocationResponseBody: # noqa: E501 + """Read merchant location # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. # noqa: E501 + This endpoint returns the specified merchant_location resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_user(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.read_merchant_location(merchant_location_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int + :param merchant_location_guid: The unique id for a `merchant_location`. (required) + :type merchant_location_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -13747,33 +11683,27 @@ def read_spending_plan_user(self, user_guid : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpendingPlanResponse + :rtype: MerchantLocationResponseBody """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the read_spending_plan_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the read_merchant_location_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + return self.read_merchant_location_with_http_info(merchant_location_guid, **kwargs) # noqa: E501 @validate_arguments - def read_spending_plan_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Read a spending plan for a user # noqa: E501 + def read_merchant_location_with_http_info(self, merchant_location_guid : Annotated[StrictStr, Field(..., description="The unique id for a `merchant_location`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Read merchant location # noqa: E501 - Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. # noqa: E501 + This endpoint returns the specified merchant_location resource. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> thread = api.read_merchant_location_with_http_info(merchant_location_guid, async_req=True) >>> result = thread.get() - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param page: Specify current page. - :type page: int - :param records_per_page: Specify records per page. - :type records_per_page: int + :param merchant_location_guid: The unique id for a `merchant_location`. (required) + :type merchant_location_guid: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -13796,16 +11726,13 @@ def read_spending_plan_user_with_http_info(self, user_guid : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpendingPlanResponse, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(MerchantLocationResponseBody, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'page', - 'records_per_page' + 'merchant_location_guid' ] _all_params.extend( [ @@ -13824,7 +11751,7 @@ def read_spending_plan_user_with_http_info(self, user_guid : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method read_spending_plan_user" % _key + " to method read_merchant_location" % _key ) _params[_key] = _val del _params['kwargs'] @@ -13833,21 +11760,12 @@ def read_spending_plan_user_with_http_info(self, user_guid : Annotated[StrictStr # process the path parameters _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + if _params['merchant_location_guid']: + _path_params['merchant_location_guid'] = _params['merchant_location_guid'] # process the query parameters _query_params = [] - if _params.get('page') is not None: # noqa: E501 - _query_params.append(('page', _params['page'])) - - if _params.get('records_per_page') is not None: # noqa: E501 - _query_params.append(('records_per_page', _params['records_per_page'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -13863,11 +11781,11 @@ def read_spending_plan_user_with_http_info(self, user_guid : Annotated[StrictStr _auth_settings = ['basicAuth'] # noqa: E501 _response_types_map = { - '200': "SpendingPlanResponse", + '200': "MerchantLocationResponseBody", } return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}', 'GET', + '/merchant_locations/{merchant_location_guid}', 'GET', _path_params, _query_params, _header_params, @@ -16753,177 +14671,6 @@ def update_member_with_http_info(self, member_guid : Annotated[StrictStr, Field( collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) - @validate_arguments - def update_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item object to be updated with required parameter (iteration_item_guid)")], **kwargs) -> SpendingPlanIterationItemResponse: # noqa: E501 - """Update a spending plan iteration item # noqa: E501 - - Use this endpoint to update an existing `spending_plan_iteration_item`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_item_guid: The unique ID for the `iteration_item`. (required) - :type iteration_item_guid: str - :param spending_plan_iteration_item_create_request_body: Iteration item object to be updated with required parameter (iteration_item_guid) (required) - :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SpendingPlanIterationItemResponse - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the update_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, **kwargs) # noqa: E501 - - @validate_arguments - def update_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item object to be updated with required parameter (iteration_item_guid)")], **kwargs) -> ApiResponse: # noqa: E501 - """Update a spending plan iteration item # noqa: E501 - - Use this endpoint to update an existing `spending_plan_iteration_item`. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, async_req=True) - >>> result = thread.get() - - :param user_guid: The unique id for a `user`. (required) - :type user_guid: str - :param spending_plan_guid: The unique ID for the `spending_plan`. (required) - :type spending_plan_guid: str - :param iteration_item_guid: The unique ID for the `iteration_item`. (required) - :type iteration_item_guid: str - :param spending_plan_iteration_item_create_request_body: Iteration item object to be updated with required parameter (iteration_item_guid) (required) - :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SpendingPlanIterationItemResponse, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'user_guid', - 'spending_plan_guid', - 'iteration_item_guid', - 'spending_plan_iteration_item_create_request_body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method update_spending_plan_iteration_item" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['user_guid']: - _path_params['user_guid'] = _params['user_guid'] - - if _params['spending_plan_guid']: - _path_params['spending_plan_guid'] = _params['spending_plan_guid'] - - if _params['iteration_item_guid']: - _path_params['iteration_item_guid'] = _params['iteration_item_guid'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['spending_plan_iteration_item_create_request_body'] is not None: - _body_params = _params['spending_plan_iteration_item_create_request_body'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/vnd.mx.api.v1+json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['basicAuth'] # noqa: E501 - - _response_types_map = { - '200': "SpendingPlanIterationItemResponse", - } - - return self.api_client.call_api( - '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}', 'PUT', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - @validate_arguments def update_tag(self, tag_guid : Annotated[StrictStr, Field(..., description="The unique id for a `tag`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], tag_update_request_body : Annotated[TagUpdateRequestBody, Field(..., description="Tag object to be updated with required parameter (tag_guid)")], **kwargs) -> TagResponseBody: # noqa: E501 """Update tag # noqa: E501 diff --git a/mx_platform_python/api/spending_plan_api.py b/mx_platform_python/api/spending_plan_api.py new file mode 100644 index 0000000..84b8df2 --- /dev/null +++ b/mx_platform_python/api/spending_plan_api.py @@ -0,0 +1,2298 @@ +# coding: utf-8 + +""" + MX Platform API + + The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import re # noqa: F401 +import io +import warnings + +from pydantic import validate_arguments, ValidationError + +from typing_extensions import Annotated +from pydantic import Field, StrictInt, StrictStr + +from typing import Optional + +from mx_platform_python.models.spending_plan_account_response import SpendingPlanAccountResponse +from mx_platform_python.models.spending_plan_accounts_response import SpendingPlanAccountsResponse +from mx_platform_python.models.spending_plan_iteration_item_create_request_body import SpendingPlanIterationItemCreateRequestBody +from mx_platform_python.models.spending_plan_iteration_item_response import SpendingPlanIterationItemResponse +from mx_platform_python.models.spending_plan_iteration_items_response_body import SpendingPlanIterationItemsResponseBody +from mx_platform_python.models.spending_plan_iteration_response import SpendingPlanIterationResponse +from mx_platform_python.models.spending_plan_iterations_response import SpendingPlanIterationsResponse +from mx_platform_python.models.spending_plan_response import SpendingPlanResponse +from mx_platform_python.models.spending_plans_response_body import SpendingPlansResponseBody + +from mx_platform_python.api_client import ApiClient +from mx_platform_python.api_response import ApiResponse +from mx_platform_python.exceptions import ( # noqa: F401 + ApiTypeError, + ApiValueError +) + + +class SpendingPlanApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_arguments + def create_spending_plan(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> SpendingPlanResponse: # noqa: E501 + """Create spending plan # noqa: E501 + + This endpoint creates a new `spending_plan` for the user. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_spending_plan(user_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the create_spending_plan_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.create_spending_plan_with_http_info(user_guid, **kwargs) # noqa: E501 + + @validate_arguments + def create_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Create spending plan # noqa: E501 + + This endpoint creates a new `spending_plan` for the user. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_spending_plan_with_http_info(user_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method create_spending_plan" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def create_spending_plan_iteration_item(self, spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item to be created with required parameters (planned_amount)")], **kwargs) -> SpendingPlanIterationItemResponse: # noqa: E501 + """Create spending plan iteration item # noqa: E501 + + This endpoint creates a new `spending_plan_iteration_item`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, async_req=True) + >>> result = thread.get() + + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_iteration_item_create_request_body: Iteration item to be created with required parameters (planned_amount) (required) + :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanIterationItemResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the create_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, **kwargs) # noqa: E501 + + @validate_arguments + def create_spending_plan_iteration_item_with_http_info(self, spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item to be created with required parameters (planned_amount)")], **kwargs) -> ApiResponse: # noqa: E501 + """Create spending plan iteration item # noqa: E501 + + This endpoint creates a new `spending_plan_iteration_item`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, async_req=True) + >>> result = thread.get() + + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_iteration_item_create_request_body: Iteration item to be created with required parameters (planned_amount) (required) + :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanIterationItemResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'spending_plan_guid', + 'user_guid', + 'spending_plan_iteration_item_create_request_body' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method create_spending_plan_iteration_item" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['spending_plan_iteration_item_create_request_body'] is not None: + _body_params = _params['spending_plan_iteration_item_create_request_body'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanIterationItemResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def delete_spending_plan(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], **kwargs) -> None: # noqa: E501 + """Delete spending plan # noqa: E501 + + Use this endpoint to delete a user's `spending_plan`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_spending_plan(user_guid, spending_plan_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique ID for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the delete_spending_plan_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.delete_spending_plan_with_http_info(user_guid, spending_plan_guid, **kwargs) # noqa: E501 + + @validate_arguments + def delete_spending_plan_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete spending plan # noqa: E501 + + Use this endpoint to delete a user's `spending_plan`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_spending_plan_with_http_info(user_guid, spending_plan_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique ID for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_spending_plan" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def delete_spending_plan_account(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], **kwargs) -> None: # noqa: E501 + """Delete spending plan account # noqa: E501 + + Use this endpoint to delete a `spending_plan_account`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique ID for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param spending_plan_account_guid: The unique ID for the specified account. (required) + :type spending_plan_account_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the delete_spending_plan_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, **kwargs) # noqa: E501 + + @validate_arguments + def delete_spending_plan_account_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete spending plan account # noqa: E501 + + Use this endpoint to delete a `spending_plan_account`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique ID for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param spending_plan_account_guid: The unique ID for the specified account. (required) + :type spending_plan_account_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'spending_plan_account_guid' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_spending_plan_account" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['spending_plan_account_guid']: + _path_params['spending_plan_account_guid'] = _params['spending_plan_account_guid'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def delete_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], **kwargs) -> None: # noqa: E501 + """Delete spending plan iteration item # noqa: E501 + + Use this endpoint to delete a spending plan `iteration_item`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique ID for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_item_guid: The unique ID for the `iteration_item`. (required) + :type iteration_item_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the delete_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, **kwargs) # noqa: E501 + + @validate_arguments + def delete_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique ID for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], **kwargs) -> ApiResponse: # noqa: E501 + """Delete spending plan iteration item # noqa: E501 + + Use this endpoint to delete a spending plan `iteration_item`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique ID for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_item_guid: The unique ID for the `iteration_item`. (required) + :type iteration_item_guid: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'iteration_item_guid' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_spending_plan_iteration_item" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['iteration_item_guid']: + _path_params['iteration_item_guid'] = _params['iteration_item_guid'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def list_spending_plan_accounts(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanAccountsResponse: # noqa: E501 + """List spending plan accounts # noqa: E501 + + Use this endpoint to list all the spending plan accounts associated with the spending plan. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plan_accounts(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanAccountsResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the list_spending_plan_accounts_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def list_spending_plan_accounts_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List spending plan accounts # noqa: E501 + + Use this endpoint to list all the spending plan accounts associated with the spending plan. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanAccountsResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method list_spending_plan_accounts" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanAccountsResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def list_spending_plan_iteration_items(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationItemsResponseBody: # noqa: E501 + """List spending plan iteration items # noqa: E501 + + Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plan_iteration_items(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanIterationItemsResponseBody + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the list_spending_plan_iteration_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def list_spending_plan_iteration_items_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List spending plan iteration items # noqa: E501 + + Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanIterationItemsResponseBody, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method list_spending_plan_iteration_items" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanIterationItemsResponseBody", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def list_spending_plan_iterations(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationsResponse: # noqa: E501 + """List spending plan iterations # noqa: E501 + + Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plan_iterations(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanIterationsResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the list_spending_plan_iterations_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def list_spending_plan_iterations_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List spending plan iterations # noqa: E501 + + Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanIterationsResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method list_spending_plan_iterations" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanIterationsResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def list_spending_plans(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlansResponseBody: # noqa: E501 + """List spending plans # noqa: E501 + + Use this endpoint to list all the spending plans associated with the user. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plans(user_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlansResponseBody + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the list_spending_plans_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.list_spending_plans_with_http_info(user_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def list_spending_plans_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List spending plans # noqa: E501 + + Use this endpoint to list all the spending plans associated with the user. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_spending_plans_with_http_info(user_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlansResponseBody, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method list_spending_plans" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlansResponseBody", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def read_spending_plan_account(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanAccountResponse: # noqa: E501 + """Read spending plan account # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param spending_plan_account_guid: The unique ID for the specified account. (required) + :type spending_plan_account_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanAccountResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the read_spending_plan_account_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def read_spending_plan_account_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], spending_plan_account_guid : Annotated[StrictStr, Field(..., description="The unique ID for the specified account.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Read spending plan account # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param spending_plan_account_guid: The unique ID for the specified account. (required) + :type spending_plan_account_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanAccountResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'spending_plan_account_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method read_spending_plan_account" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['spending_plan_account_guid']: + _path_params['spending_plan_account_guid'] = _params['spending_plan_account_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanAccountResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def read_spending_plan_iteration(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_number : Annotated[StrictInt, Field(..., description="The current iteration number for the spending plan `iteration``.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationResponse: # noqa: E501 + """Read a spending plan iteration # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_number: The current iteration number for the spending plan `iteration``. (required) + :type iteration_number: int + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanIterationResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the read_spending_plan_iteration_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def read_spending_plan_iteration_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_number : Annotated[StrictInt, Field(..., description="The current iteration number for the spending plan `iteration``.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Read a spending plan iteration # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_number: The current iteration number for the spending plan `iteration``. (required) + :type iteration_number: int + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanIterationResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'iteration_number', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method read_spending_plan_iteration" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['iteration_number']: + _path_params['iteration_number'] = _params['iteration_number'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanIterationResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def read_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanIterationItemResponse: # noqa: E501 + """Read a spending plan iteration item # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_item_guid: The unique ID for the `iteration_item`. (required) + :type iteration_item_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanIterationItemResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the read_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def read_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Read a spending plan iteration item # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_item_guid: The unique ID for the `iteration_item`. (required) + :type iteration_item_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanIterationItemResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'iteration_item_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method read_spending_plan_iteration_item" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['iteration_item_guid']: + _path_params['iteration_item_guid'] = _params['iteration_item_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanIterationItemResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def read_spending_plan_user(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> SpendingPlanResponse: # noqa: E501 + """Read a spending plan for a user # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_user(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the read_spending_plan_user_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, page, records_per_page, **kwargs) # noqa: E501 + + @validate_arguments + def read_spending_plan_user_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], page : Annotated[Optional[StrictInt], Field(description="Specify current page.")] = None, records_per_page : Annotated[Optional[StrictInt], Field(description="Specify records per page.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Read a spending plan for a user # noqa: E501 + + Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, page, records_per_page, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param page: Specify current page. + :type page: int + :param records_per_page: Specify records per page. + :type records_per_page: int + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'page', + 'records_per_page' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method read_spending_plan_user" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + + # process the query parameters + _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('records_per_page') is not None: # noqa: E501 + _query_params.append(('records_per_page', _params['records_per_page'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def update_spending_plan_iteration_item(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item object to be updated with required parameter (iteration_item_guid)")], **kwargs) -> SpendingPlanIterationItemResponse: # noqa: E501 + """Update a spending plan iteration item # noqa: E501 + + Use this endpoint to update an existing `spending_plan_iteration_item`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_item_guid: The unique ID for the `iteration_item`. (required) + :type iteration_item_guid: str + :param spending_plan_iteration_item_create_request_body: Iteration item object to be updated with required parameter (iteration_item_guid) (required) + :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SpendingPlanIterationItemResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the update_spending_plan_iteration_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, **kwargs) # noqa: E501 + + @validate_arguments + def update_spending_plan_iteration_item_with_http_info(self, user_guid : Annotated[StrictStr, Field(..., description="The unique id for a `user`.")], spending_plan_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `spending_plan`.")], iteration_item_guid : Annotated[StrictStr, Field(..., description="The unique ID for the `iteration_item`.")], spending_plan_iteration_item_create_request_body : Annotated[SpendingPlanIterationItemCreateRequestBody, Field(..., description="Iteration item object to be updated with required parameter (iteration_item_guid)")], **kwargs) -> ApiResponse: # noqa: E501 + """Update a spending plan iteration item # noqa: E501 + + Use this endpoint to update an existing `spending_plan_iteration_item`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, async_req=True) + >>> result = thread.get() + + :param user_guid: The unique id for a `user`. (required) + :type user_guid: str + :param spending_plan_guid: The unique ID for the `spending_plan`. (required) + :type spending_plan_guid: str + :param iteration_item_guid: The unique ID for the `iteration_item`. (required) + :type iteration_item_guid: str + :param spending_plan_iteration_item_create_request_body: Iteration item object to be updated with required parameter (iteration_item_guid) (required) + :type spending_plan_iteration_item_create_request_body: SpendingPlanIterationItemCreateRequestBody + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SpendingPlanIterationItemResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'user_guid', + 'spending_plan_guid', + 'iteration_item_guid', + 'spending_plan_iteration_item_create_request_body' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method update_spending_plan_iteration_item" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['user_guid']: + _path_params['user_guid'] = _params['user_guid'] + + if _params['spending_plan_guid']: + _path_params['spending_plan_guid'] = _params['spending_plan_guid'] + + if _params['iteration_item_guid']: + _path_params['iteration_item_guid'] = _params['iteration_item_guid'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['spending_plan_iteration_item_create_request_body'] is not None: + _body_params = _params['spending_plan_iteration_item_create_request_body'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/vnd.mx.api.v1+json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['basicAuth'] # noqa: E501 + + _response_types_map = { + '200': "SpendingPlanIterationItemResponse", + } + + return self.api_client.call_api( + '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}', 'PUT', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/mx_platform_python/api_client.py b/mx_platform_python/api_client.py index b6a7321..3f09012 100644 --- a/mx_platform_python/api_client.py +++ b/mx_platform_python/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/0.19.0/python' + self.user_agent = 'OpenAPI-Generator/0.20.0/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/mx_platform_python/configuration.py b/mx_platform_python/configuration.py index 803b6b1..3a99ebf 100644 --- a/mx_platform_python/configuration.py +++ b/mx_platform_python/configuration.py @@ -392,7 +392,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 0.1.0\n"\ - "SDK Package Version: 0.19.0".\ + "SDK Package Version: 0.20.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/openapi/config.yml b/openapi/config.yml index eac1e85..1995395 100644 --- a/openapi/config.yml +++ b/openapi/config.yml @@ -1,5 +1,5 @@ --- packageName: mx_platform_python packageUrl: https://pypi.org/project/mx-platform-python -packageVersion: 0.19.0 +packageVersion: 0.20.0 projectName: mx-platform-python diff --git a/pyproject.toml b/pyproject.toml index 062c407..7d29142 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "mx_platform_python" -version = "0.19.0" +version = "0.20.0" description = "MX Platform API" authors = ["MX Platform API "] license = "NoLicense" diff --git a/setup.py b/setup.py index 542510e..2d6eea9 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "mx-platform-python" -VERSION = "0.19.0" +VERSION = "0.20.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", diff --git a/test/test_mx_platform_api.py b/test/test_mx_platform_api.py index 6413526..681caf4 100644 --- a/test/test_mx_platform_api.py +++ b/test/test_mx_platform_api.py @@ -82,20 +82,6 @@ def test_create_member(self) -> None: """ pass - def test_create_spending_plan(self) -> None: - """Test case for create_spending_plan - - Create spending plan # noqa: E501 - """ - pass - - def test_create_spending_plan_iteration_item(self) -> None: - """Test case for create_spending_plan_iteration_item - - Create spending plan iteration item # noqa: E501 - """ - pass - def test_create_tag(self) -> None: """Test case for create_tag @@ -166,27 +152,6 @@ def test_delete_member(self) -> None: """ pass - def test_delete_spending_plan(self) -> None: - """Test case for delete_spending_plan - - Delete spending plan # noqa: E501 - """ - pass - - def test_delete_spending_plan_account(self) -> None: - """Test case for delete_spending_plan_account - - Delete spending plan account # noqa: E501 - """ - pass - - def test_delete_spending_plan_iteration_item(self) -> None: - """Test case for delete_spending_plan_iteration_item - - Delete spending plan iteration item # noqa: E501 - """ - pass - def test_delete_tag(self) -> None: """Test case for delete_tag @@ -418,34 +383,6 @@ def test_list_merchants(self) -> None: """ pass - def test_list_spending_plan_accounts(self) -> None: - """Test case for list_spending_plan_accounts - - List spending plan accounts # noqa: E501 - """ - pass - - def test_list_spending_plan_iteration_items(self) -> None: - """Test case for list_spending_plan_iteration_items - - List spending plan iteration items # noqa: E501 - """ - pass - - def test_list_spending_plan_iterations(self) -> None: - """Test case for list_spending_plan_iterations - - List spending plan iterations # noqa: E501 - """ - pass - - def test_list_spending_plans(self) -> None: - """Test case for list_spending_plans - - List spending plans # noqa: E501 - """ - pass - def test_list_statements_by_member(self) -> None: """Test case for list_statements_by_member @@ -614,34 +551,6 @@ def test_read_merchant_location(self) -> None: """ pass - def test_read_spending_plan_account(self) -> None: - """Test case for read_spending_plan_account - - Read spending plan account # noqa: E501 - """ - pass - - def test_read_spending_plan_iteration(self) -> None: - """Test case for read_spending_plan_iteration - - Read a spending plan iteration # noqa: E501 - """ - pass - - def test_read_spending_plan_iteration_item(self) -> None: - """Test case for read_spending_plan_iteration_item - - Read a spending plan iteration item # noqa: E501 - """ - pass - - def test_read_spending_plan_user(self) -> None: - """Test case for read_spending_plan_user - - Read a spending plan for a user # noqa: E501 - """ - pass - def test_read_statement_by_member(self) -> None: """Test case for read_statement_by_member @@ -768,13 +677,6 @@ def test_update_member(self) -> None: """ pass - def test_update_spending_plan_iteration_item(self) -> None: - """Test case for update_spending_plan_iteration_item - - Update a spending plan iteration item # noqa: E501 - """ - pass - def test_update_tag(self) -> None: """Test case for update_tag diff --git a/test/test_spending_plan_api.py b/test/test_spending_plan_api.py new file mode 100644 index 0000000..8658838 --- /dev/null +++ b/test/test_spending_plan_api.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + MX Platform API + + The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from mx_platform_python.api.spending_plan_api import SpendingPlanApi # noqa: E501 + + +class TestSpendingPlanApi(unittest.TestCase): + """SpendingPlanApi unit test stubs""" + + def setUp(self) -> None: + self.api = SpendingPlanApi() # noqa: E501 + + def tearDown(self) -> None: + pass + + def test_create_spending_plan(self) -> None: + """Test case for create_spending_plan + + Create spending plan # noqa: E501 + """ + pass + + def test_create_spending_plan_iteration_item(self) -> None: + """Test case for create_spending_plan_iteration_item + + Create spending plan iteration item # noqa: E501 + """ + pass + + def test_delete_spending_plan(self) -> None: + """Test case for delete_spending_plan + + Delete spending plan # noqa: E501 + """ + pass + + def test_delete_spending_plan_account(self) -> None: + """Test case for delete_spending_plan_account + + Delete spending plan account # noqa: E501 + """ + pass + + def test_delete_spending_plan_iteration_item(self) -> None: + """Test case for delete_spending_plan_iteration_item + + Delete spending plan iteration item # noqa: E501 + """ + pass + + def test_list_spending_plan_accounts(self) -> None: + """Test case for list_spending_plan_accounts + + List spending plan accounts # noqa: E501 + """ + pass + + def test_list_spending_plan_iteration_items(self) -> None: + """Test case for list_spending_plan_iteration_items + + List spending plan iteration items # noqa: E501 + """ + pass + + def test_list_spending_plan_iterations(self) -> None: + """Test case for list_spending_plan_iterations + + List spending plan iterations # noqa: E501 + """ + pass + + def test_list_spending_plans(self) -> None: + """Test case for list_spending_plans + + List spending plans # noqa: E501 + """ + pass + + def test_read_spending_plan_account(self) -> None: + """Test case for read_spending_plan_account + + Read spending plan account # noqa: E501 + """ + pass + + def test_read_spending_plan_iteration(self) -> None: + """Test case for read_spending_plan_iteration + + Read a spending plan iteration # noqa: E501 + """ + pass + + def test_read_spending_plan_iteration_item(self) -> None: + """Test case for read_spending_plan_iteration_item + + Read a spending plan iteration item # noqa: E501 + """ + pass + + def test_read_spending_plan_user(self) -> None: + """Test case for read_spending_plan_user + + Read a spending plan for a user # noqa: E501 + """ + pass + + def test_update_spending_plan_iteration_item(self) -> None: + """Test case for update_spending_plan_iteration_item + + Update a spending plan iteration item # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main()