-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #95 from mxenabled/openapi-generator-0.40.0
Generated version 0.40.0
- Loading branch information
Showing
97 changed files
with
10,786 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # MxPlatformRuby::BudgetCreateRequest | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **category_guid** | **String** | Unique identifier of the category. | | | ||
| | **parent_guid** | **String** | Unique identifier of the parent budget. This is only required when creating a budget on a sub-category. | | | ||
| | **amount** | **Integer** | Amount of the budget. | [optional] | | ||
| | **metadata** | **String** | Additional information a partner can store on the budget. | [optional] | | ||
| | **skip_webhook** | **Boolean** | When set to true, this parameter will prevent a webhook from being triggered by the request. | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'mx-platform-ruby' | ||
|
|
||
| instance = MxPlatformRuby::BudgetCreateRequest.new( | ||
| category_guid: CAT-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a, | ||
| parent_guid: BGT-6be44a91-e105-f68a-4770-8c7c0a5c9778, | ||
| amount: 1000, | ||
| metadata: Additional information, | ||
| skip_webhook: true | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # MxPlatformRuby::BudgetCreateRequestBody | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **budget** | [**BudgetCreateRequest**](BudgetCreateRequest.md) | | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'mx-platform-ruby' | ||
|
|
||
| instance = MxPlatformRuby::BudgetCreateRequestBody.new( | ||
| budget: null | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # MxPlatformRuby::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** | **String** | Unique identifier for the budget category. Defined by MX. | [optional] | | ||
| | **created_at** | **String** | Date and time the budget was created, represented in ISO 8601 format with timestamp. | [optional] | | ||
| | **guid** | **String** | Unique identifier for the budget. Defined by MX. | [optional] | | ||
| | **is_exceeded** | **Boolean** | If the budget has been exceeded, this field will be true. Otherwise, this field will be false. | [optional] | | ||
| | **is_off_track** | **Boolean** | If the budget is off track, this field will be true. Otherwise, this field will be false. | [optional] | | ||
| | **metadata** | **String** | Additional information a partner can store on the budget. | [optional] | | ||
| | **name** | **String** | 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** | **String** | 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** | **Integer** | 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 | ||
|
|
||
| ```ruby | ||
| require 'mx-platform-ruby' | ||
|
|
||
| instance = MxPlatformRuby::BudgetResponse.new( | ||
| amount: 153.0, | ||
| category_guid: CAT-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a, | ||
| created_at: 2018-10-18T19:51:26+00:00, | ||
| guid: BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d, | ||
| is_exceeded: true, | ||
| is_off_track: true, | ||
| metadata: some metadata, | ||
| name: Food & Dining, | ||
| off_track_percentage: null, | ||
| parent_guid: null, | ||
| percent_spent: 1276.34, | ||
| projected_spending: 3562.4, | ||
| revision: 561, | ||
| transaction_total: 1952.8, | ||
| updated_at: 2022-06-14T21:17:11+00:00, | ||
| user_guid: USR-11141024-90b3-1bce-cac9-c06ced52ab4c | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # MxPlatformRuby::BudgetResponseBody | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **budget** | [**BudgetResponse**](BudgetResponse.md) | | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'mx-platform-ruby' | ||
|
|
||
| instance = MxPlatformRuby::BudgetResponseBody.new( | ||
| budget: null | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # MxPlatformRuby::BudgetUpdateRequest | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **amount** | **Integer** | Amount of the budget. | [optional] | | ||
| | **metadata** | **String** | Additional information a partner can store on the budget. | [optional] | | ||
| | **skip_webhook** | **Boolean** | When set to true, this parameter will prevent a webhook from being triggered by the request. | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'mx-platform-ruby' | ||
|
|
||
| instance = MxPlatformRuby::BudgetUpdateRequest.new( | ||
| amount: 1000, | ||
| metadata: Additional information, | ||
| skip_webhook: true | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # MxPlatformRuby::BudgetUpdateRequestBody | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **budget** | [**BudgetUpdateRequest**](BudgetUpdateRequest.md) | | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'mx-platform-ruby' | ||
|
|
||
| instance = MxPlatformRuby::BudgetUpdateRequestBody.new( | ||
| budget: null | ||
| ) | ||
| ``` | ||
|
|
Oops, something went wrong.