Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ docs/AuthorizationCodeRequest.md
docs/AuthorizationCodeRequestBody.md
docs/AuthorizationCodeResponse.md
docs/AuthorizationCodeResponseBody.md
docs/BudgetCreateRequest.md
docs/BudgetCreateRequestBody.md
docs/BudgetResponse.md
docs/BudgetResponseBody.md
docs/BudgetUpdateRequest.md
docs/BudgetUpdateRequestBody.md
docs/BudgetsApi.md
docs/CategoriesResponseBody.md
docs/CategoryCreateRequest.md
docs/CategoryCreateRequestBody.md
Expand All @@ -37,6 +44,13 @@ docs/EnhanceTransactionResponse.md
docs/EnhanceTransactionsRequest.md
docs/EnhanceTransactionsRequestBody.md
docs/EnhanceTransactionsResponseBody.md
docs/GoalRequest.md
docs/GoalRequestBody.md
docs/GoalResponse.md
docs/GoalResponseBody.md
docs/GoalsApi.md
docs/GoalsResponse.md
docs/GoalsResponseBody.md
docs/HoldingResponse.md
docs/HoldingResponseBody.md
docs/HoldingsResponseBody.md
Expand Down Expand Up @@ -77,6 +91,10 @@ docs/MerchantLocationResponseBody.md
docs/MerchantResponse.md
docs/MerchantResponseBody.md
docs/MerchantsResponseBody.md
docs/MonthlyCashFlowProfileRequest.md
docs/MonthlyCashFlowProfileRequestBody.md
docs/MonthlyCashFlowResponse.md
docs/MonthlyCashFlowResponseBody.md
docs/MxPlatformApi.md
docs/OAuthWindowResponse.md
docs/OAuthWindowResponseBody.md
Expand All @@ -86,6 +104,9 @@ docs/PaymentProcessorAuthorizationCodeRequest.md
docs/PaymentProcessorAuthorizationCodeRequestBody.md
docs/PaymentProcessorAuthorizationCodeResponse.md
docs/PaymentProcessorAuthorizationCodeResponseBody.md
docs/RepositionRequest.md
docs/RepositionRequestBody.md
docs/RepositionResponseBody.md
docs/RewardResponse.md
docs/RewardResponseBody.md
docs/RewardsResponse.md
Expand All @@ -102,6 +123,9 @@ docs/SpendingPlanIterationResponse.md
docs/SpendingPlanIterationsResponse.md
docs/SpendingPlanResponse.md
docs/SpendingPlansResponseBody.md
docs/SplitTransactionRequest.md
docs/SplitTransactionRequestBody.md
docs/SplitTransactionsResponseBody.md
docs/StatementResponse.md
docs/StatementResponseBody.md
docs/StatementsResponseBody.md
Expand Down Expand Up @@ -134,6 +158,8 @@ docs/TransactionRulesResponseBody.md
docs/TransactionUpdateRequest.md
docs/TransactionUpdateRequestBody.md
docs/TransactionsResponseBody.md
docs/UpdateGoalRequest.md
docs/UpdateGoalRequestBody.md
docs/UserCreateRequest.md
docs/UserCreateRequestBody.md
docs/UserResponse.md
Expand All @@ -147,6 +173,8 @@ docs/WidgetResponse.md
docs/WidgetResponseBody.md
mx_platform_python/__init__.py
mx_platform_python/api/__init__.py
mx_platform_python/api/budgets_api.py
mx_platform_python/api/goals_api.py
mx_platform_python/api/insights_api.py
mx_platform_python/api/mx_platform_api.py
mx_platform_python/api/spending_plan_api.py
Expand All @@ -170,6 +198,12 @@ mx_platform_python/models/authorization_code_request.py
mx_platform_python/models/authorization_code_request_body.py
mx_platform_python/models/authorization_code_response.py
mx_platform_python/models/authorization_code_response_body.py
mx_platform_python/models/budget_create_request.py
mx_platform_python/models/budget_create_request_body.py
mx_platform_python/models/budget_response.py
mx_platform_python/models/budget_response_body.py
mx_platform_python/models/budget_update_request.py
mx_platform_python/models/budget_update_request_body.py
mx_platform_python/models/categories_response_body.py
mx_platform_python/models/category_create_request.py
mx_platform_python/models/category_create_request_body.py
Expand All @@ -192,6 +226,12 @@ mx_platform_python/models/enhance_transaction_response.py
mx_platform_python/models/enhance_transactions_request.py
mx_platform_python/models/enhance_transactions_request_body.py
mx_platform_python/models/enhance_transactions_response_body.py
mx_platform_python/models/goal_request.py
mx_platform_python/models/goal_request_body.py
mx_platform_python/models/goal_response.py
mx_platform_python/models/goal_response_body.py
mx_platform_python/models/goals_response.py
mx_platform_python/models/goals_response_body.py
mx_platform_python/models/holding_response.py
mx_platform_python/models/holding_response_body.py
mx_platform_python/models/holdings_response_body.py
Expand Down Expand Up @@ -231,6 +271,10 @@ mx_platform_python/models/merchant_location_response_body.py
mx_platform_python/models/merchant_response.py
mx_platform_python/models/merchant_response_body.py
mx_platform_python/models/merchants_response_body.py
mx_platform_python/models/monthly_cash_flow_profile_request.py
mx_platform_python/models/monthly_cash_flow_profile_request_body.py
mx_platform_python/models/monthly_cash_flow_response.py
mx_platform_python/models/monthly_cash_flow_response_body.py
mx_platform_python/models/o_auth_window_response.py
mx_platform_python/models/o_auth_window_response_body.py
mx_platform_python/models/option_response.py
Expand All @@ -239,6 +283,9 @@ mx_platform_python/models/payment_processor_authorization_code_request.py
mx_platform_python/models/payment_processor_authorization_code_request_body.py
mx_platform_python/models/payment_processor_authorization_code_response.py
mx_platform_python/models/payment_processor_authorization_code_response_body.py
mx_platform_python/models/reposition_request.py
mx_platform_python/models/reposition_request_body.py
mx_platform_python/models/reposition_response_body.py
mx_platform_python/models/reward_response.py
mx_platform_python/models/reward_response_body.py
mx_platform_python/models/rewards_response.py
Expand All @@ -254,6 +301,9 @@ mx_platform_python/models/spending_plan_iteration_response.py
mx_platform_python/models/spending_plan_iterations_response.py
mx_platform_python/models/spending_plan_response.py
mx_platform_python/models/spending_plans_response_body.py
mx_platform_python/models/split_transaction_request.py
mx_platform_python/models/split_transaction_request_body.py
mx_platform_python/models/split_transactions_response_body.py
mx_platform_python/models/statement_response.py
mx_platform_python/models/statement_response_body.py
mx_platform_python/models/statements_response_body.py
Expand Down Expand Up @@ -286,6 +336,8 @@ mx_platform_python/models/transaction_rules_response_body.py
mx_platform_python/models/transaction_update_request.py
mx_platform_python/models/transaction_update_request_body.py
mx_platform_python/models/transactions_response_body.py
mx_platform_python/models/update_goal_request.py
mx_platform_python/models/update_goal_request_body.py
mx_platform_python/models/user_create_request.py
mx_platform_python/models/user_create_request_body.py
mx_platform_python/models/user_response.py
Expand Down Expand Up @@ -320,6 +372,13 @@ test/test_authorization_code_request.py
test/test_authorization_code_request_body.py
test/test_authorization_code_response.py
test/test_authorization_code_response_body.py
test/test_budget_create_request.py
test/test_budget_create_request_body.py
test/test_budget_response.py
test/test_budget_response_body.py
test/test_budget_update_request.py
test/test_budget_update_request_body.py
test/test_budgets_api.py
test/test_categories_response_body.py
test/test_category_create_request.py
test/test_category_create_request_body.py
Expand All @@ -342,6 +401,13 @@ test/test_enhance_transaction_response.py
test/test_enhance_transactions_request.py
test/test_enhance_transactions_request_body.py
test/test_enhance_transactions_response_body.py
test/test_goal_request.py
test/test_goal_request_body.py
test/test_goal_response.py
test/test_goal_response_body.py
test/test_goals_api.py
test/test_goals_response.py
test/test_goals_response_body.py
test/test_holding_response.py
test/test_holding_response_body.py
test/test_holdings_response_body.py
Expand Down Expand Up @@ -382,6 +448,10 @@ test/test_merchant_location_response_body.py
test/test_merchant_response.py
test/test_merchant_response_body.py
test/test_merchants_response_body.py
test/test_monthly_cash_flow_profile_request.py
test/test_monthly_cash_flow_profile_request_body.py
test/test_monthly_cash_flow_response.py
test/test_monthly_cash_flow_response_body.py
test/test_mx_platform_api.py
test/test_o_auth_window_response.py
test/test_o_auth_window_response_body.py
Expand All @@ -391,6 +461,9 @@ test/test_payment_processor_authorization_code_request.py
test/test_payment_processor_authorization_code_request_body.py
test/test_payment_processor_authorization_code_response.py
test/test_payment_processor_authorization_code_response_body.py
test/test_reposition_request.py
test/test_reposition_request_body.py
test/test_reposition_response_body.py
test/test_reward_response.py
test/test_reward_response_body.py
test/test_rewards_response.py
Expand All @@ -407,6 +480,9 @@ test/test_spending_plan_iteration_response.py
test/test_spending_plan_iterations_response.py
test/test_spending_plan_response.py
test/test_spending_plans_response_body.py
test/test_split_transaction_request.py
test/test_split_transaction_request_body.py
test/test_split_transactions_response_body.py
test/test_statement_response.py
test/test_statement_response_body.py
test/test_statements_response_body.py
Expand Down Expand Up @@ -439,6 +515,8 @@ test/test_transaction_rules_response_body.py
test/test_transaction_update_request.py
test/test_transaction_update_request_body.py
test/test_transactions_response_body.py
test/test_update_goal_request.py
test/test_update_goal_request_body.py
test/test_user_create_request.py
test/test_user_create_request_body.py
test/test_user_response.py
Expand Down
32 changes: 32 additions & 0 deletions docs/BudgetCreateRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# BudgetCreateRequest


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category_guid** | **str** | Unique identifier of the category. |
**parent_guid** | **str** | Unique identifier of the parent budget. This is only required when creating a budget on a sub-category. |
**amount** | **int** | Amount of the budget. | [optional]
**metadata** | **str** | Additional information a partner can store on the budget. | [optional]
**skip_webhook** | **bool** | When set to true, this parameter will prevent a webhook from being triggered by the request. | [optional]

## Example

```python
from mx_platform_python.models.budget_create_request import BudgetCreateRequest

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetCreateRequest from a JSON string
budget_create_request_instance = BudgetCreateRequest.from_json(json)
# print the JSON string representation of the object
print BudgetCreateRequest.to_json()

# convert the object into a dict
budget_create_request_dict = budget_create_request_instance.to_dict()
# create an instance of BudgetCreateRequest from a dict
budget_create_request_form_dict = budget_create_request.from_dict(budget_create_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


28 changes: 28 additions & 0 deletions docs/BudgetCreateRequestBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# BudgetCreateRequestBody


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**budget** | [**BudgetCreateRequest**](BudgetCreateRequest.md) | | [optional]

## Example

```python
from mx_platform_python.models.budget_create_request_body import BudgetCreateRequestBody

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetCreateRequestBody from a JSON string
budget_create_request_body_instance = BudgetCreateRequestBody.from_json(json)
# print the JSON string representation of the object
print BudgetCreateRequestBody.to_json()

# convert the object into a dict
budget_create_request_body_dict = budget_create_request_body_instance.to_dict()
# create an instance of BudgetCreateRequestBody from a dict
budget_create_request_body_form_dict = budget_create_request_body.from_dict(budget_create_request_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


43 changes: 43 additions & 0 deletions docs/BudgetResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# BudgetResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | **float** | A goal amount set by the user for a category's transaction total during a month. | [optional]
**category_guid** | **str** | Unique identifier for the budget category. Defined by MX. | [optional]
**created_at** | **str** | Date and time the budget was created, represented in ISO 8601 format with timestamp. | [optional]
**guid** | **str** | Unique identifier for the budget. Defined by MX. | [optional]
**is_exceeded** | **bool** | If the budget has been exceeded, this field will be true. Otherwise, this field will be false. | [optional]
**is_off_track** | **bool** | If the budget is off track, this field will be true. Otherwise, this field will be false. | [optional]
**metadata** | **str** | Additional information a partner can store on the budget. | [optional]
**name** | **str** | The name of the budget that is visible to the user (ie \"Food\", \"Bills\", \"Entertainment\", etc). | [optional]
**off_track_percentage** | **float** | The percentage amount of off track spending. (Deprecated). | [optional]
**parent_guid** | **str** | Unique identifier for the parent budget. Defined by MX. | [optional]
**percent_spent** | **float** | The percentage of a budget that has been spent during the current calendar month Calculated as the transaction total divided by the amount and then multiplied by 100.A value of zero will be returned when `amount` is zero. | [optional]
**projected_spending** | **float** | The projected amount of spending for the budget. | [optional]
**revision** | **int** | The revision number of this budget record. | [optional]
**transaction_total** | **object** | The cumulative amount of all transactions under the budget. | [optional]
**updated_at** | **object** | Date and time the budget was updated, represented in ISO 8601 format with timestamp. | [optional]
**user_guid** | **object** | Unique identifier for the user. Defined by MX. | [optional]

## Example

```python
from mx_platform_python.models.budget_response import BudgetResponse

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetResponse from a JSON string
budget_response_instance = BudgetResponse.from_json(json)
# print the JSON string representation of the object
print BudgetResponse.to_json()

# convert the object into a dict
budget_response_dict = budget_response_instance.to_dict()
# create an instance of BudgetResponse from a dict
budget_response_form_dict = budget_response.from_dict(budget_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


28 changes: 28 additions & 0 deletions docs/BudgetResponseBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# BudgetResponseBody


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**budget** | [**BudgetResponse**](BudgetResponse.md) | | [optional]

## Example

```python
from mx_platform_python.models.budget_response_body import BudgetResponseBody

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetResponseBody from a JSON string
budget_response_body_instance = BudgetResponseBody.from_json(json)
# print the JSON string representation of the object
print BudgetResponseBody.to_json()

# convert the object into a dict
budget_response_body_dict = budget_response_body_instance.to_dict()
# create an instance of BudgetResponseBody from a dict
budget_response_body_form_dict = budget_response_body.from_dict(budget_response_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/BudgetUpdateRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# BudgetUpdateRequest


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | **int** | Amount of the budget. | [optional]
**metadata** | **str** | Additional information a partner can store on the budget. | [optional]
**skip_webhook** | **bool** | When set to true, this parameter will prevent a webhook from being triggered by the request. | [optional]

## Example

```python
from mx_platform_python.models.budget_update_request import BudgetUpdateRequest

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetUpdateRequest from a JSON string
budget_update_request_instance = BudgetUpdateRequest.from_json(json)
# print the JSON string representation of the object
print BudgetUpdateRequest.to_json()

# convert the object into a dict
budget_update_request_dict = budget_update_request_instance.to_dict()
# create an instance of BudgetUpdateRequest from a dict
budget_update_request_form_dict = budget_update_request.from_dict(budget_update_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading