mx-platform-ruby 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61add8014e4af8eddee3d7ecff72bb5cbfa5181e92e3e21a056adb4fb0d6c79
-  data.tar.gz: 4bc80c1a991ac8766bbb826733a6cfdfc71076c8c50f795d54591ed5f623614b
+  metadata.gz: 4bc4bd8101a2f5716f0febb5ecdd53dfcda22f2c5c1d79426f046050aa3edd47
+  data.tar.gz: 8c8534adf53b61a2b72293ee2b88f80c7ea5d0c40080299cf77c2b54dae0a01d
 SHA512:
-  metadata.gz: ba096840fc12b092ab449afb51d8a74f4d999e9781725192149cf006c8a7fd3fb69e86612f4ff7ead4e025f1b61f2bf503fc6522c0012dfedaec401bb8b1132f
-  data.tar.gz: 991548fa8e30d1a434bd67de2e3ab4c8fdeb7a8e8ce96c0ca19b1ee3482ab91e182a9044face58c8dab0aa0e210bfe30d8fe03d0e37f87339c6cfd8a3f2b5ebb
+  metadata.gz: 717a4b06557ed16241e431fb40e905670973bf7046f7aa900ed8d6f88c6dbce33dff7b78b89e7c5fa3282bdff0bab9d2d802e6606a9eaf339ce6390033a7cb53
+  data.tar.gz: 8206b49cfc1ebed604cf1bbadbe3b8400ddb0c3fcb81b10fd0184d4ec597a8950ec4d20694583a2d49ebdea6142575577d96fc538bd1782879a24c7d06469756

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.39.0)
+    mx-platform-ruby (0.40.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
 

data/docs/BudgetCreateRequest.md

@@ -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
+)
+```
+

data/docs/BudgetCreateRequestBody.md

@@ -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
+)
+```
+

data/docs/BudgetResponse.md

@@ -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
+)
+```
+

data/docs/BudgetResponseBody.md

@@ -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
+)
+```
+

data/docs/BudgetUpdateRequest.md

@@ -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
+)
+```
+

data/docs/BudgetUpdateRequestBody.md

@@ -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
+)
+```
+

data/docs/BudgetsApi.md

@@ -0,0 +1,444 @@
+# MxPlatformRuby::BudgetsApi
+
+All URIs are relative to *https://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 |
+
+
+## users_user_guid_budgets_budget_guid_delete
+
+> users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid)
+
+Delete a budget
+
+Delete a budget.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+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.
+
+begin
+  # Delete a budget
+  api_instance.users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid)
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_delete: #{e}"
+end
+```
+
+#### Using the users_user_guid_budgets_budget_guid_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_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)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| 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. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## users_user_guid_budgets_budget_guid_get
+
+> <BudgetResponseBody> users_user_guid_budgets_budget_guid_get(budget_guid, user_guid)
+
+Read a specific budget
+
+Read a specific budget.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+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.
+
+begin
+  # Read a specific budget
+  result = api_instance.users_user_guid_budgets_budget_guid_get(budget_guid, user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_get: #{e}"
+end
+```
+
+#### Using the users_user_guid_budgets_budget_guid_get_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)
+
+```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)
+  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}"
+end
+```
+
+### Parameters
+
+| 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. |  |
+
+### Return type
+
+[**BudgetResponseBody**](BudgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_user_guid_budgets_budget_guid_put
+
+> <BudgetResponseBody> users_user_guid_budgets_budget_guid_put(user_guid, budget_guid, opts)
+
+Update a specific budget
+
+Update a specific budget.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+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.
+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
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_put: #{e}"
+end
+```
+
+#### Using the users_user_guid_budgets_budget_guid_put_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_put_with_http_info(user_guid, budget_guid, opts)
+
+```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)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BudgetResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_budget_guid_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| 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. |  |
+| **budget_update_request_body** | [**BudgetUpdateRequestBody**](BudgetUpdateRequestBody.md) |  | [optional] |
+
+### Return type
+
+[**BudgetResponseBody**](BudgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## users_user_guid_budgets_generate_post
+
+> <BudgetResponseBody> users_user_guid_budgets_generate_post(user_guid)
+
+Auto-generate 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`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::BudgetsApi.new
+user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
+
+begin
+  # Auto-generate budgets
+  result = api_instance.users_user_guid_budgets_generate_post(user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_generate_post: #{e}"
+end
+```
+
+#### Using the users_user_guid_budgets_generate_post_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)
+
+```ruby
+begin
+  # Auto-generate budgets
+  data, status_code, headers = api_instance.users_user_guid_budgets_generate_post_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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+
+### Return type
+
+[**BudgetResponseBody**](BudgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_user_guid_budgets_get
+
+> <BudgetResponseBody> users_user_guid_budgets_get(user_guid)
+
+List all budgets
+
+List all budgets
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::BudgetsApi.new
+user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
+
+begin
+  # List all budgets
+  result = api_instance.users_user_guid_budgets_get(user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_get: #{e}"
+end
+```
+
+#### Using the users_user_guid_budgets_get_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)
+
+```ruby
+begin
+  # List all budgets
+  data, status_code, headers = api_instance.users_user_guid_budgets_get_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_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+
+### Return type
+
+[**BudgetResponseBody**](BudgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_user_guid_budgets_post
+
+> <BudgetResponseBody> users_user_guid_budgets_post(user_guid, budget_create_request_body)
+
+Create a 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
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+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 | 
+
+begin
+  # Create a budget
+  result = api_instance.users_user_guid_budgets_post(user_guid, budget_create_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling BudgetsApi->users_user_guid_budgets_post: #{e}"
+end
+```
+
+#### Using the users_user_guid_budgets_post_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)
+
+```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)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+| **budget_create_request_body** | [**BudgetCreateRequestBody**](BudgetCreateRequestBody.md) |  |  |
+
+### Return type
+
+[**BudgetResponseBody**](BudgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreditCardProduct.md

@@ -4,18 +4,18 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **annual_fee** | **Object** |  | [optional] |
-| **duration_of_introductory_rate_on_balance_transfer** | **Object** |  | [optional] |
-| **duration_of_introductory_rate_on_purchases** | **Object** |  | [optional] |
-| **guid** | **Object** |  | [optional] |
+| **annual_fee** | **Float** |  | [optional] |
+| **duration_of_introductory_rate_on_balance_transfer** | **Integer** |  | [optional] |
+| **duration_of_introductory_rate_on_purchases** | **Integer** |  | [optional] |
+| **guid** | **String** |  | [optional] |
 | **has_cashback_rewards** | **Boolean** |  | [optional] |
 | **has_other_rewards** | **Boolean** |  | [optional] |
 | **has_travel_rewards** | **Boolean** |  | [optional] |
 | **has_zero_introductory_annual_fee** | **Boolean** |  | [optional] |
 | **has_zero_percent_introductory_rate** | **Boolean** |  | [optional] |
 | **has_zero_percent_introductory_rate_on_balance_transfer** | **Boolean** |  | [optional] |
-| **financial_institution** | **Boolean** |  | [optional] |
-| **is_accepting_applications** | **Boolean** |  | [optional] |
+| **is_accepting_applicants** | **Boolean** |  | [optional] |
+| **is_active_credit_card_product** | **Boolean** |  | [optional] |
 | **is_small_business_card** | **Boolean** |  | [optional] |
 | **name** | **String** |  | [optional] |
 
@@ -35,8 +35,8 @@ instance = MxPlatformRuby::CreditCardProduct.new(
   has_zero_introductory_annual_fee: true,
   has_zero_percent_introductory_rate: false,
   has_zero_percent_introductory_rate_on_balance_transfer: true,
-  financial_institution: true,
-  is_accepting_applications: true,
+  is_accepting_applicants: true,
+  is_active_credit_card_product: true,
   is_small_business_card: true,
   name: Chase Credit Card
 )

data/docs/CreditCardProductResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **reward** | [**CreditCardProduct**](CreditCardProduct.md) |  | [optional] |
+| **credit_card_product** | [**CreditCardProduct**](CreditCardProduct.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::CreditCardProductResponse.new(
-  reward: null
+  credit_card_product: null
 )
 ```