Skip to content

Commit 1972eac

Browse files
author
devexperience
committed
Generated version 0.14.0
This commit was automatically created by a GitHub Action to generate version 0.14.0 of this library.
1 parent 87f715e commit 1972eac

18 files changed

+1293
-5
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.gitignore
22
README.md
3+
docs/AccountCreateRequest.md
4+
docs/AccountCreateRequestBody.md
35
docs/AccountNumberResponse.md
46
docs/AccountNumbersResponseBody.md
57
docs/AccountOwnerResponse.md
@@ -128,6 +130,8 @@ mx_platform_python/apis/__init__.py
128130
mx_platform_python/configuration.py
129131
mx_platform_python/exceptions.py
130132
mx_platform_python/model/__init__.py
133+
mx_platform_python/model/account_create_request.py
134+
mx_platform_python/model/account_create_request_body.py
131135
mx_platform_python/model/account_number_response.py
132136
mx_platform_python/model/account_numbers_response_body.py
133137
mx_platform_python/model/account_owner_response.py
@@ -255,6 +259,8 @@ setup.cfg
255259
setup.py
256260
test-requirements.txt
257261
test/__init__.py
262+
test/test_account_create_request.py
263+
test/test_account_create_request_body.py
258264
test/test_account_number_response.py
259265
test/test_account_numbers_response_body.py
260266
test/test_account_owner_response.py

‎docs/AccountCreateRequest.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# AccountCreateRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**balance** | **float** | |
8+
**name** | **str** | |
9+
**type** | **str** | |
10+
**account_number** | **str** | | [optional]
11+
**apr** | **float** | | [optional]
12+
**apy** | **float** | | [optional]
13+
**available_balance** | **float** | | [optional]
14+
**available_credit** | **float** | | [optional]
15+
**cash_surrender_value** | **float** | | [optional]
16+
**credit_limit** | **float** | | [optional]
17+
**currency_code** | **str** | | [optional]
18+
**day_payment_is_due** | **int** | | [optional]
19+
**death_benefit** | **int** | | [optional]
20+
**id** | **str** | | [optional]
21+
**interest_rate** | **float** | | [optional]
22+
**is_closed** | **bool** | | [optional]
23+
**is_hidden** | **bool** | | [optional]
24+
**last_payment** | **float** | | [optional]
25+
**last_payment_at** | **str** | | [optional]
26+
**loan_amount** | **float** | | [optional]
27+
**matures_on** | **str** | | [optional]
28+
**metadata** | **str** | | [optional]
29+
**minimum_balance** | **float** | | [optional]
30+
**minimum_payment** | **float** | | [optional]
31+
**nickname** | **str** | | [optional]
32+
**original_balance** | **float** | | [optional]
33+
**payment_due_at** | **str** | | [optional]
34+
**payoff_balance** | **float** | | [optional]
35+
**routing_number** | **str** | | [optional]
36+
**started_on** | **str** | | [optional]
37+
**subtype** | **str** | | [optional]
38+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
39+
40+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
41+
42+

‎docs/AccountCreateRequestBody.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AccountCreateRequestBody
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**skip_webhook** | **bool, none_type** | | [optional]
8+
**account** | [**AccountCreateRequest**](AccountCreateRequest.md) | | [optional]
9+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/AccountResponse.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Name | Type | Description | Notes
2424
**institution_code** | **str, none_type** | | [optional]
2525
**insured_name** | **str, none_type** | | [optional]
2626
**interest_rate** | **float, none_type** | | [optional]
27+
**is_business** | **bool, none_type** | | [optional]
2728
**is_closed** | **bool, none_type** | | [optional]
2829
**is_hidden** | **bool, none_type** | | [optional]
30+
**is_manual** | **bool, none_type** | | [optional]
2931
**last_payment** | **float, none_type** | | [optional]
3032
**last_payment_at** | **str, none_type** | | [optional]
3133
**loan_amount** | **float, none_type** | | [optional]
@@ -43,6 +45,7 @@ Name | Type | Description | Notes
4345
**payment_due_at** | **str, none_type** | | [optional]
4446
**payoff_balance** | **float, none_type** | | [optional]
4547
**premium_amount** | **float, none_type** | | [optional]
48+
**property_type** | **str, none_type** | | [optional]
4649
**routing_number** | **str, none_type** | | [optional]
4750
**started_on** | **str, none_type** | | [optional]
4851
**subtype** | **str, none_type** | | [optional]

‎docs/MxPlatformApi.md‎

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Method | HTTP request | Description
1010
[**create_managed_account**](MxPlatformApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account
1111
[**create_managed_member**](MxPlatformApi.md#create_managed_member) | **POST** /users/{user_guid}/managed_members | Create managed member
1212
[**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | Create managed transaction
13+
[**create_manual_account**](MxPlatformApi.md#create_manual_account) | **POST** /users/{user_guid}/accounts | Create manual account
1314
[**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
1415
[**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag
1516
[**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging
@@ -19,6 +20,7 @@ Method | HTTP request | Description
1920
[**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account
2021
[**delete_managed_member**](MxPlatformApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member
2122
[**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
23+
[**delete_manual_account**](MxPlatformApi.md#delete_manual_account) | **DELETE** /users/{user_guid}/accounts/{account_guid} | Delete manual account
2224
[**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
2325
[**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag
2426
[**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging
@@ -663,6 +665,122 @@ Name | Type | Description | Notes
663665

664666
[[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)
665667

668+
# **create_manual_account**
669+
> AccountResponseBody create_manual_account(user_guid, account_create_request_body)
670+
671+
Create manual account
672+
673+
This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
674+
675+
### Example
676+
677+
* Basic Authentication (basicAuth):
678+
679+
```python
680+
import time
681+
import mx_platform_python
682+
from mx_platform_python.api import mx_platform_api
683+
from mx_platform_python.model.account_response_body import AccountResponseBody
684+
from mx_platform_python.model.account_create_request_body import AccountCreateRequestBody
685+
from pprint import pprint
686+
# Defining the host is optional and defaults to https://api.mx.com
687+
# See configuration.py for a list of all supported configuration parameters.
688+
configuration = mx_platform_python.Configuration(
689+
host = "https://api.mx.com"
690+
)
691+
692+
# The client must configure the authentication and authorization parameters
693+
# in accordance with the API server security policy.
694+
# Examples for each auth method are provided below, use the example that
695+
# satisfies your auth use case.
696+
697+
# Configure HTTP basic authorization: basicAuth
698+
configuration = mx_platform_python.Configuration(
699+
username = 'YOUR_USERNAME',
700+
password = 'YOUR_PASSWORD'
701+
)
702+
703+
# Enter a context with an instance of the API client
704+
with mx_platform_python.ApiClient(configuration) as api_client:
705+
# Create an instance of the API class
706+
api_instance = mx_platform_api.MxPlatformApi(api_client)
707+
user_guid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54" # str | The unique id for a `user`.
708+
account_create_request_body = AccountCreateRequestBody(
709+
skip_webhook=True,
710+
account=AccountCreateRequest(
711+
account_number="5366",
712+
apr=1.0,
713+
apy=1.0,
714+
available_balance=1000.0,
715+
available_credit=1000.0,
716+
balance=1000.0,
717+
cash_surrender_value=1000.0,
718+
credit_limit=100.0,
719+
currency_code="USD",
720+
day_payment_is_due=20,
721+
death_benefit=1000,
722+
id="1040434698",
723+
interest_rate=1.0,
724+
is_closed=False,
725+
is_hidden=False,
726+
last_payment=100.0,
727+
last_payment_at="2015-10-13T17:57:37.000Z",
728+
loan_amount=1000.0,
729+
matures_on="2015-10-13T17:57:37.000Z",
730+
metadata="some metadata",
731+
minimum_balance=100.0,
732+
minimum_payment=10.0,
733+
name="Test account 2",
734+
nickname="Swiss Account",
735+
original_balance=10.0,
736+
payment_due_at="2015-10-13T17:57:37.000Z",
737+
payoff_balance=10.0,
738+
routing_number="68899990000000",
739+
started_on="2015-10-13T17:57:37.000Z",
740+
subtype="NONE",
741+
type="SAVINGS",
742+
),
743+
) # AccountCreateRequestBody | Manual account object to be created.
744+
745+
# example passing only required values which don't have defaults set
746+
try:
747+
# Create manual account
748+
api_response = api_instance.create_manual_account(user_guid, account_create_request_body)
749+
pprint(api_response)
750+
except mx_platform_python.ApiException as e:
751+
print("Exception when calling MxPlatformApi->create_manual_account: %s\n" % e)
752+
```
753+
754+
755+
### Parameters
756+
757+
Name | Type | Description | Notes
758+
------------- | ------------- | ------------- | -------------
759+
**user_guid** | **str**| The unique id for a `user`. |
760+
**account_create_request_body** | [**AccountCreateRequestBody**](AccountCreateRequestBody.md)| Manual account object to be created. |
761+
762+
### Return type
763+
764+
[**AccountResponseBody**](AccountResponseBody.md)
765+
766+
### Authorization
767+
768+
[basicAuth](../README.md#basicAuth)
769+
770+
### HTTP request headers
771+
772+
- **Content-Type**: application/json
773+
- **Accept**: application/vnd.mx.api.v1+json
774+
775+
776+
### HTTP response details
777+
778+
| Status code | Description | Response headers |
779+
|-------------|-------------|------------------|
780+
**200** | OK | - |
781+
782+
[[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)
783+
666784
# **create_member**
667785
> MemberResponseBody create_member(user_guid, member_create_request_body)
668786
@@ -1424,6 +1542,84 @@ void (empty response body)
14241542

14251543
[[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)
14261544

1545+
# **delete_manual_account**
1546+
> delete_manual_account(account_guid, user_guid)
1547+
1548+
Delete manual account
1549+
1550+
This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.
1551+
1552+
### Example
1553+
1554+
* Basic Authentication (basicAuth):
1555+
1556+
```python
1557+
import time
1558+
import mx_platform_python
1559+
from mx_platform_python.api import mx_platform_api
1560+
from pprint import pprint
1561+
# Defining the host is optional and defaults to https://api.mx.com
1562+
# See configuration.py for a list of all supported configuration parameters.
1563+
configuration = mx_platform_python.Configuration(
1564+
host = "https://api.mx.com"
1565+
)
1566+
1567+
# The client must configure the authentication and authorization parameters
1568+
# in accordance with the API server security policy.
1569+
# Examples for each auth method are provided below, use the example that
1570+
# satisfies your auth use case.
1571+
1572+
# Configure HTTP basic authorization: basicAuth
1573+
configuration = mx_platform_python.Configuration(
1574+
username = 'YOUR_USERNAME',
1575+
password = 'YOUR_PASSWORD'
1576+
)
1577+
1578+
# Enter a context with an instance of the API client
1579+
with mx_platform_python.ApiClient(configuration) as api_client:
1580+
# Create an instance of the API class
1581+
api_instance = mx_platform_api.MxPlatformApi(api_client)
1582+
account_guid = "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1" # str | The unique id for an `account`.
1583+
user_guid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54" # str | The unique id for a `user`.
1584+
1585+
# example passing only required values which don't have defaults set
1586+
try:
1587+
# Delete manual account
1588+
api_instance.delete_manual_account(account_guid, user_guid)
1589+
except mx_platform_python.ApiException as e:
1590+
print("Exception when calling MxPlatformApi->delete_manual_account: %s\n" % e)
1591+
```
1592+
1593+
1594+
### Parameters
1595+
1596+
Name | Type | Description | Notes
1597+
------------- | ------------- | ------------- | -------------
1598+
**account_guid** | **str**| The unique id for an `account`. |
1599+
**user_guid** | **str**| The unique id for a `user`. |
1600+
1601+
### Return type
1602+
1603+
void (empty response body)
1604+
1605+
### Authorization
1606+
1607+
[basicAuth](../README.md#basicAuth)
1608+
1609+
### HTTP request headers
1610+
1611+
- **Content-Type**: Not defined
1612+
- **Accept**: Not defined
1613+
1614+
1615+
### HTTP response details
1616+
1617+
| Status code | Description | Response headers |
1618+
|-------------|-------------|------------------|
1619+
**204** | No content. | - |
1620+
1621+
[[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)
1622+
14271623
# **delete_member**
14281624
> delete_member(member_guid, user_guid)
14291625

‎mx_platform_python/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111

1212

13-
__version__ = "0.13.0"
13+
__version__ = "0.14.0"
1414

1515
# import ApiClient
1616
from mx_platform_python.api_client import ApiClient

0 commit comments

Comments
 (0)