mx-platform-ruby 1.10.0 → 1.10.1

data/docs/BudgetsApi.md

@@ -1,24 +1,24 @@
 # MxPlatformRuby::BudgetsApi
 
-All URIs are relative to *https://api.mx.com*
+All URIs are relative to *https://int-api.mx.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**users_user_guid_budgets_budget_guid_delete**](BudgetsApi.md#users_user_guid_budgets_budget_guid_delete) | **DELETE** /users/{user_guid}/budgets/{budget_guid} | Delete a budget |
-| [**users_user_guid_budgets_budget_guid_get**](BudgetsApi.md#users_user_guid_budgets_budget_guid_get) | **GET** /users/{user_guid}/budgets/{budget_guid} | Read a specific budget |
-| [**users_user_guid_budgets_budget_guid_put**](BudgetsApi.md#users_user_guid_budgets_budget_guid_put) | **PUT** /users/{user_guid}/budgets/{budget_guid} | Update a specific budget |
-| [**users_user_guid_budgets_generate_post**](BudgetsApi.md#users_user_guid_budgets_generate_post) | **POST** /users/{user_guid}/budgets/generate | Auto-generate budgets |
-| [**users_user_guid_budgets_get**](BudgetsApi.md#users_user_guid_budgets_get) | **GET** /users/{user_guid}/budgets | List all budgets |
-| [**users_user_guid_budgets_post**](BudgetsApi.md#users_user_guid_budgets_post) | **POST** /users/{user_guid}/budgets | Create a budget |
+| [**auto_generate_budgets**](BudgetsApi.md#auto_generate_budgets) | **POST** /users/{user_guid}/budgets/generate | Auto-generate budgets |
+| [**create_budget**](BudgetsApi.md#create_budget) | **POST** /users/{user_guid}/budgets | Create a budget |
+| [**delete_budget**](BudgetsApi.md#delete_budget) | **DELETE** /users/{user_guid}/budgets/{budget_guid} | Delete a budget |
+| [**list_all_budgets**](BudgetsApi.md#list_all_budgets) | **GET** /users/{user_guid}/budgets | List all budgets |
+| [**read_specific_budget**](BudgetsApi.md#read_specific_budget) | **GET** /users/{user_guid}/budgets/{budget_guid} | Read a specific budget |
+| [**update_specific_budget**](BudgetsApi.md#update_specific_budget) | **PUT** /users/{user_guid}/budgets/{budget_guid} | Update a specific budget |
 
 
-## users_user_guid_budgets_budget_guid_delete
+## auto_generate_budgets
 
-> users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid)
+> <BudgetResponseBody> auto_generate_budgets(user_guid)
 
-Delete a budget
+Auto-generate budgets
 
-Delete a budget.
+This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \"Bills & Utilities\" `transaction` in both January and February, a budget will be generated for \"Bills & Utilities.\" If there are two \"Bills & Utilities\" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`.
 
 ### Examples
 
@@ -33,32 +33,32 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::BudgetsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the budget. Defined by MX.
-budget_guid = 'budget_guid_example' # String | The unique identifier for the budget. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
 
 begin
-  # Delete a budget
-  api_instance.users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid)
+  # Auto-generate budgets
+  result = api_instance.auto_generate_budgets(user_guid)
+  p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_delete: #{e}"
+  puts "Error when calling BudgetsApi->auto_generate_budgets: #{e}"
 end
 ```
 
-#### Using the users_user_guid_budgets_budget_guid_delete_with_http_info variant
+#### Using the auto_generate_budgets_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid)
+> <Array(<BudgetResponseBody>, Integer, Hash)> auto_generate_budgets_with_http_info(user_guid)
 
 ```ruby
 begin
-  # Delete a budget
-  data, status_code, headers = api_instance.users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid)
+  # Auto-generate budgets
+  data, status_code, headers = api_instance.auto_generate_budgets_with_http_info(user_guid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <BudgetResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_delete_with_http_info: #{e}"
+  puts "Error when calling BudgetsApi->auto_generate_budgets_with_http_info: #{e}"
 end
 ```
 
@@ -66,12 +66,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
-| **budget_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
 
 ### Return type
 
-nil (empty response body)
+[**BudgetResponseBody**](BudgetResponseBody.md)
 
 ### Authorization
 
@@ -80,16 +79,16 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
 
 
-## users_user_guid_budgets_budget_guid_get
+## create_budget
 
-> <BudgetResponseBody> users_user_guid_budgets_budget_guid_get(budget_guid, user_guid)
+> <BudgetResponseBody> create_budget(user_guid, budget_create_request_body)
 
-Read a specific budget
+Create a budget
 
-Read a specific budget.
+Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for \"Gas\", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.
 
 ### Examples
 
@@ -104,33 +103,33 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::BudgetsApi.new
-budget_guid = 'budget_guid_example' # String | The unique identifier for the budget. Defined by MX.
-user_guid = 'user_guid_example' # String | The unique identifier for the budget. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+budget_create_request_body = MxPlatformRuby::BudgetCreateRequestBody.new # BudgetCreateRequestBody | 
 
 begin
-  # Read a specific budget
-  result = api_instance.users_user_guid_budgets_budget_guid_get(budget_guid, user_guid)
+  # Create a budget
+  result = api_instance.create_budget(user_guid, budget_create_request_body)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_get: #{e}"
+  puts "Error when calling BudgetsApi->create_budget: #{e}"
 end
 ```
 
-#### Using the users_user_guid_budgets_budget_guid_get_with_http_info variant
+#### Using the create_budget_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BudgetResponseBody>, Integer, Hash)> users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid)
+> <Array(<BudgetResponseBody>, Integer, Hash)> create_budget_with_http_info(user_guid, budget_create_request_body)
 
 ```ruby
 begin
-  # Read a specific budget
-  data, status_code, headers = api_instance.users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid)
+  # Create a budget
+  data, status_code, headers = api_instance.create_budget_with_http_info(user_guid, budget_create_request_body)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BudgetResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_get_with_http_info: #{e}"
+  puts "Error when calling BudgetsApi->create_budget_with_http_info: #{e}"
 end
 ```
 
@@ -138,8 +137,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **budget_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
-| **user_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **budget_create_request_body** | [**BudgetCreateRequestBody**](BudgetCreateRequestBody.md) |  |  |
 
 ### Return type
 
@@ -151,17 +150,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/vnd.mx.api.v1+json
 - **Accept**: application/json
 
 
-## users_user_guid_budgets_budget_guid_put
+## delete_budget
 
-> <BudgetResponseBody> users_user_guid_budgets_budget_guid_put(user_guid, budget_guid, opts)
+> delete_budget(user_guid, budget_guid)
 
-Update a specific budget
+Delete a budget
 
-Update a specific budget.
+Delete a budget.
 
 ### Examples
 
@@ -176,36 +175,32 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::BudgetsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the budget. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
 budget_guid = 'budget_guid_example' # String | The unique identifier for the budget. Defined by MX.
-opts = {
-  budget_update_request_body: MxPlatformRuby::BudgetUpdateRequestBody.new # BudgetUpdateRequestBody | 
-}
 
 begin
-  # Update a specific budget
-  result = api_instance.users_user_guid_budgets_budget_guid_put(user_guid, budget_guid, opts)
-  p result
+  # Delete a budget
+  api_instance.delete_budget(user_guid, budget_guid)
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_put: #{e}"
+  puts "Error when calling BudgetsApi->delete_budget: #{e}"
 end
 ```
 
-#### Using the users_user_guid_budgets_budget_guid_put_with_http_info variant
+#### Using the delete_budget_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<BudgetResponseBody>, Integer, Hash)> users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts)
+> <Array(nil, Integer, Hash)> delete_budget_with_http_info(user_guid, budget_guid)
 
 ```ruby
 begin
-  # Update a specific budget
-  data, status_code, headers = api_instance.users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts)
+  # Delete a budget
+  data, status_code, headers = api_instance.delete_budget_with_http_info(user_guid, budget_guid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <BudgetResponseBody>
+  p data # => nil
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_put_with_http_info: #{e}"
+  puts "Error when calling BudgetsApi->delete_budget_with_http_info: #{e}"
 end
 ```
 
@@ -213,13 +208,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
 | **budget_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
-| **budget_update_request_body** | [**BudgetUpdateRequestBody**](BudgetUpdateRequestBody.md) |  | [optional] |
 
 ### Return type
 
-[**BudgetResponseBody**](BudgetResponseBody.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -227,17 +221,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: Not defined
 
 
-## users_user_guid_budgets_generate_post
+## list_all_budgets
 
-> <BudgetResponseBody> users_user_guid_budgets_generate_post(user_guid)
+> <BudgetResponseBody> list_all_budgets(user_guid)
 
-Auto-generate budgets
+List all budgets
 
-This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \"Bills & Utilities\" `transaction` in both January and February, a budget will be generated for \"Bills & Utilities.\" If there are two \"Bills & Utilities\" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`.
+List all budgets
 
 ### Examples
 
@@ -252,32 +246,32 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::BudgetsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
 
 begin
-  # Auto-generate budgets
-  result = api_instance.users_user_guid_budgets_generate_post(user_guid)
+  # List all budgets
+  result = api_instance.list_all_budgets(user_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_generate_post: #{e}"
+  puts "Error when calling BudgetsApi->list_all_budgets: #{e}"
 end
 ```
 
-#### Using the users_user_guid_budgets_generate_post_with_http_info variant
+#### Using the list_all_budgets_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BudgetResponseBody>, Integer, Hash)> users_user_guid_budgets_generate_post_with_http_info(user_guid)
+> <Array(<BudgetResponseBody>, Integer, Hash)> list_all_budgets_with_http_info(user_guid)
 
 ```ruby
 begin
-  # Auto-generate budgets
-  data, status_code, headers = api_instance.users_user_guid_budgets_generate_post_with_http_info(user_guid)
+  # List all budgets
+  data, status_code, headers = api_instance.list_all_budgets_with_http_info(user_guid)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BudgetResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_generate_post_with_http_info: #{e}"
+  puts "Error when calling BudgetsApi->list_all_budgets_with_http_info: #{e}"
 end
 ```
 
@@ -285,7 +279,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
 
 ### Return type
 
@@ -298,16 +292,16 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
 
 
-## users_user_guid_budgets_get
+## read_specific_budget
 
-> <BudgetResponseBody> users_user_guid_budgets_get(user_guid)
+> <BudgetResponseBody> read_specific_budget(user_guid, budget_guid)
 
-List all budgets
+Read a specific budget
 
-List all budgets
+Read a specific budget.
 
 ### Examples
 
@@ -322,32 +316,33 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::BudgetsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+budget_guid = 'budget_guid_example' # String | The unique identifier for the budget. Defined by MX.
 
 begin
-  # List all budgets
-  result = api_instance.users_user_guid_budgets_get(user_guid)
+  # Read a specific budget
+  result = api_instance.read_specific_budget(user_guid, budget_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_get: #{e}"
+  puts "Error when calling BudgetsApi->read_specific_budget: #{e}"
 end
 ```
 
-#### Using the users_user_guid_budgets_get_with_http_info variant
+#### Using the read_specific_budget_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BudgetResponseBody>, Integer, Hash)> users_user_guid_budgets_get_with_http_info(user_guid)
+> <Array(<BudgetResponseBody>, Integer, Hash)> read_specific_budget_with_http_info(user_guid, budget_guid)
 
 ```ruby
 begin
-  # List all budgets
-  data, status_code, headers = api_instance.users_user_guid_budgets_get_with_http_info(user_guid)
+  # Read a specific budget
+  data, status_code, headers = api_instance.read_specific_budget_with_http_info(user_guid, budget_guid)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BudgetResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_get_with_http_info: #{e}"
+  puts "Error when calling BudgetsApi->read_specific_budget_with_http_info: #{e}"
 end
 ```
 
@@ -355,7 +350,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **budget_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
 
 ### Return type
 
@@ -368,16 +364,16 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
 
 
-## users_user_guid_budgets_post
+## update_specific_budget
 
-> <BudgetResponseBody> users_user_guid_budgets_post(user_guid, budget_create_request_body)
+> <BudgetResponseBody> update_specific_budget(user_guid, budget_guid, opts)
 
-Create a budget
+Update a specific budget
 
-Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for \"Gas\", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.
+Update a specific budget.
 
 ### Examples
 
@@ -392,33 +388,36 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::BudgetsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
-budget_create_request_body = MxPlatformRuby::BudgetCreateRequestBody.new # BudgetCreateRequestBody | 
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+budget_guid = 'budget_guid_example' # String | The unique identifier for the budget. Defined by MX.
+opts = {
+  budget_update_request_body: MxPlatformRuby::BudgetUpdateRequestBody.new # BudgetUpdateRequestBody | 
+}
 
 begin
-  # Create a budget
-  result = api_instance.users_user_guid_budgets_post(user_guid, budget_create_request_body)
+  # Update a specific budget
+  result = api_instance.update_specific_budget(user_guid, budget_guid, opts)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_post: #{e}"
+  puts "Error when calling BudgetsApi->update_specific_budget: #{e}"
 end
 ```
 
-#### Using the users_user_guid_budgets_post_with_http_info variant
+#### Using the update_specific_budget_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BudgetResponseBody>, Integer, Hash)> users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body)
+> <Array(<BudgetResponseBody>, Integer, Hash)> update_specific_budget_with_http_info(user_guid, budget_guid, opts)
 
 ```ruby
 begin
-  # Create a budget
-  data, status_code, headers = api_instance.users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body)
+  # Update a specific budget
+  data, status_code, headers = api_instance.update_specific_budget_with_http_info(user_guid, budget_guid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BudgetResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling BudgetsApi->users_user_guid_budgets_post_with_http_info: #{e}"
+  puts "Error when calling BudgetsApi->update_specific_budget_with_http_info: #{e}"
 end
 ```
 
@@ -426,8 +425,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
-| **budget_create_request_body** | [**BudgetCreateRequestBody**](BudgetCreateRequestBody.md) |  |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **budget_guid** | **String** | The unique identifier for the budget. Defined by MX. |  |
+| **budget_update_request_body** | [**BudgetUpdateRequestBody**](BudgetUpdateRequestBody.md) |  | [optional] |
 
 ### Return type
 
@@ -439,6 +439,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/vnd.mx.api.v1+json
 - **Accept**: application/json