mx-platform-ruby 1.10.0 → 1.10.1

data/docs/TransactionResponse.md

@@ -23,6 +23,7 @@
 | **is_fee** | **Boolean** |  | [optional] |
 | **is_income** | **Boolean** |  | [optional] |
 | **is_international** | **Boolean** |  | [optional] |
+| **is_manual** | **Boolean** |  | [optional] |
 | **is_overdraft_fee** | **Boolean** |  | [optional] |
 | **is_payroll_advance** | **Boolean** |  | [optional] |
 | **is_recurring** | **Boolean** |  | [optional] |
@@ -54,49 +55,50 @@
 require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::TransactionResponse.new(
-  account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
-  account_id: account123,
-  amount: 61.11,
-  category: Groceries,
-  category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8,
-  check_number_string: 6812,
-  created_at: 2016-10-06T09:43:42.000Z,
-  currency_code: USD,
-  date: 2013-09-23T00:00:00.000Z,
-  description: Whole Foods,
-  extended_transaction_type: partner_transaction_type,
-  guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9,
-  id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9,
+  account_guid: ACT-0af29528-bb91-447f-b5de-85c1c42593e5,
+  account_id: FdvkkAgLS0nbDNUujrblz6rYDSl5w-tTLwYRgIxe7jw,
+  amount: 5003.9,
+  category: Paycheck,
+  category_guid: CAT-982ea9e6-3f0e-0c5b-611b-6657a10ba819,
+  check_number_string: null,
+  created_at: 2024-12-20T18:52:36Z,
+  currency_code: null,
+  date: 2024-12-20,
+  description: MX Technologies,
+  extended_transaction_type: null,
+  guid: TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1,
+  id: 1734681600000-178fa8095c154a55b9172f977b4c5f9a-0,
   is_bill_pay: false,
   is_direct_deposit: false,
-  is_expense: true,
+  is_expense: false,
   is_fee: false,
-  is_income: false,
-  is_international: false,
+  is_income: true,
+  is_international: null,
+  is_manual: false,
   is_overdraft_fee: false,
   is_payroll_advance: false,
-  is_recurring: false,
+  is_recurring: null,
   is_subscription: false,
-  latitude: -43.2075,
-  localized_description: This is a localized_description,
-  localized_memo: This is a localized_memo,
-  longitude: 139.691706,
-  member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
-  member_is_managed_by_user: false,
-  memo: This is a memo,
-  merchant_category_code: 5411,
-  merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
-  merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea,
-  metadata: some metadata,
-  original_description: WHOLEFDS TSQ 102,
-  posted_at: 2016-10-07T06:00:00.000Z,
+  latitude: null,
+  localized_description: null,
+  localized_memo: null,
+  longitude: null,
+  member_guid: MBR-78b14c5f-7297-4fb5-a966-65ac45f74d8,
+  member_is_managed_by_user: true,
+  memo: Transactions,
+  merchant_category_code: null,
+  merchant_guid: MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1,
+  merchant_location_guid: null,
+  metadata: null,
+  original_description: MX TECHNOLOGIES PAYMENT,
+  posted_at: 2024-12-20T12:00:00Z,
   status: POSTED,
-  top_level_category: Food & Dining,
-  transacted_at: 2016-10-06T13:00:00.000Z,
-  type: DEBIT,
-  updated_at: 2016-10-07T05:49:12.000Z,
-  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54,
-  user_id: user123
+  top_level_category: Income,
+  transacted_at: 2024-12-20T12:00:00Z,
+  type: CREDIT,
+  updated_at: 2024-12-20T18:52:38Z,
+  user_guid: USR-ef7a82f6-d6c1-42c4-9061-bdece5c4d44e,
+  user_id: null
 )
 ```
 

data/docs/TransactionRulesApi.md

@@ -0,0 +1,305 @@
+# MxPlatformRuby::TransactionRulesApi
+
+All URIs are relative to *https://int-api.mx.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_transaction_rule**](TransactionRulesApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule |
+| [**list_transaction_rules**](TransactionRulesApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules |
+| [**read_transaction_rule**](TransactionRulesApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
+| [**update_transaction_rule**](TransactionRulesApi.md#update_transaction_rule) | **PUT** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Update transaction rule |
+
+
+## create_transaction_rule
+
+> <TransactionRuleResponseBody> create_transaction_rule(user_guid, transaction_rule_create_request_body)
+
+Create transaction rule
+
+Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful.
+
+### 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::TransactionRulesApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+transaction_rule_create_request_body = MxPlatformRuby::TransactionRuleCreateRequestBody.new # TransactionRuleCreateRequestBody | TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)
+
+begin
+  # Create transaction rule
+  result = api_instance.create_transaction_rule(user_guid, transaction_rule_create_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->create_transaction_rule: #{e}"
+end
+```
+
+#### Using the create_transaction_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionRuleResponseBody>, Integer, Hash)> create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body)
+
+```ruby
+begin
+  # Create transaction rule
+  data, status_code, headers = api_instance.create_transaction_rule_with_http_info(user_guid, transaction_rule_create_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionRuleResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->create_transaction_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **transaction_rule_create_request_body** | [**TransactionRuleCreateRequestBody**](TransactionRuleCreateRequestBody.md) | TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description) |  |
+
+### Return type
+
+[**TransactionRuleResponseBody**](TransactionRuleResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## list_transaction_rules
+
+> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts)
+
+List transaction rules
+
+Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
+
+### 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::TransactionRulesApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+opts = {
+  page: 1, # Integer | Results are paginated. Specify current page.
+  records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
+}
+
+begin
+  # List transaction rules
+  result = api_instance.list_transaction_rules(user_guid, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->list_transaction_rules: #{e}"
+end
+```
+
+#### Using the list_transaction_rules_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionRulesResponseBody>, Integer, Hash)> list_transaction_rules_with_http_info(user_guid, opts)
+
+```ruby
+begin
+  # List transaction rules
+  data, status_code, headers = api_instance.list_transaction_rules_with_http_info(user_guid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionRulesResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->list_transaction_rules_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
+| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
+
+### Return type
+
+[**TransactionRulesResponseBody**](TransactionRulesResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## read_transaction_rule
+
+> <TransactionRuleResponseBody> read_transaction_rule(transaction_rule_guid, user_guid)
+
+Read transaction rule
+
+Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.
+
+### 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::TransactionRulesApi.new
+transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+
+begin
+  # Read transaction rule
+  result = api_instance.read_transaction_rule(transaction_rule_guid, user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->read_transaction_rule: #{e}"
+end
+```
+
+#### Using the read_transaction_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionRuleResponseBody>, Integer, Hash)> read_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
+
+```ruby
+begin
+  # Read transaction rule
+  data, status_code, headers = api_instance.read_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionRuleResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->read_transaction_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+
+### Return type
+
+[**TransactionRuleResponseBody**](TransactionRuleResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## update_transaction_rule
+
+> <TransactionRuleResponseBody> update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body)
+
+Update transaction rule
+
+Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.
+
+### 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::TransactionRulesApi.new
+transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+transaction_rule_update_request_body = MxPlatformRuby::TransactionRuleUpdateRequestBody.new # TransactionRuleUpdateRequestBody | TransactionRule object to be updated
+
+begin
+  # Update transaction rule
+  result = api_instance.update_transaction_rule(transaction_rule_guid, user_guid, transaction_rule_update_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->update_transaction_rule: #{e}"
+end
+```
+
+#### Using the update_transaction_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionRuleResponseBody>, Integer, Hash)> update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body)
+
+```ruby
+begin
+  # Update transaction rule
+  data, status_code, headers = api_instance.update_transaction_rule_with_http_info(transaction_rule_guid, user_guid, transaction_rule_update_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionRuleResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling TransactionRulesApi->update_transaction_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **transaction_rule_update_request_body** | [**TransactionRuleUpdateRequestBody**](TransactionRuleUpdateRequestBody.md) | TransactionRule object to be updated |  |
+
+### Return type
+
+[**TransactionRuleResponseBody**](TransactionRuleResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+

data/docs/TransactionRulesResponseBody.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
 | **transaction_rules** | [**Array<TransactionRuleResponse>**](TransactionRuleResponse.md) |  | [optional] |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::TransactionRulesResponseBody.new(
-  pagination: null,
-  transaction_rules: null
+  transaction_rules: null,
+  pagination: null
 )
 ```
 

data/docs/TransactionUpdateRequest.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **description** | **String** |  |  |
+| **date** | **String** |  | [optional] |
+| **memo** | **String** |  | [optional] |
+| **category_guid** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
 
 ## Example
 
@@ -12,6 +15,9 @@
 require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::TransactionUpdateRequest.new(
+  date: null,
+  memo: null,
+  category_guid: null,
   description: new description
 )
 ```