docs/MxPlatformApi.md in mx-platform-ruby-0.5.0 vs docs/MxPlatformApi.md in mx-platform-ruby-0.6.0

- old
+ new

@@ -2197,11 +2197,11 @@ - **Accept**: application/vnd.mx.api.v1+json ## list_default_categories -> <CategoriesResponseBody> list_default_categories(user_guid) +> <CategoriesResponseBody> list_default_categories(user_guid, opts) List default categories Use this endpoint to read the attributes of a specific user. @@ -2217,30 +2217,34 @@ config.password = 'YOUR PASSWORD' end api_instance = MxPlatformRuby::MxPlatformApi.new user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. +opts = { + page: 1, # Integer | Specify current page. + records_per_page: 10 # Integer | Specify records per page. +} begin # List default categories - result = api_instance.list_default_categories(user_guid) + result = api_instance.list_default_categories(user_guid, opts) p result rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->list_default_categories: #{e}" end ``` #### Using the list_default_categories_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid) +> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts) ```ruby begin # List default categories - data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid) + data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <CategoriesResponseBody> rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->list_default_categories_with_http_info: #{e}" @@ -2250,10 +2254,12 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | +| **page** | **Integer** | Specify current page. | [optional] | +| **records_per_page** | **Integer** | Specify records per page. | [optional] | ### Return type [**CategoriesResponseBody**](CategoriesResponseBody.md) @@ -2600,10 +2606,12 @@ end api_instance = MxPlatformRuby::MxPlatformApi.new opts = { name: 'chase', # String | This will list only institutions in which the appended string appears. + page: 1, # Integer | Specify current page. + records_per_page: 10, # Integer | Specify records per page. supports_account_identification: true, # Boolean | Filter only institutions which support account identification. supports_account_statement: true, # Boolean | Filter only institutions which support account statements. supports_account_verification: true, # Boolean | Filter only institutions which support account verification. supports_transaction_history: true # Boolean | Filter only institutions which support extended transaction history. } @@ -2638,10 +2646,12 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **name** | **String** | This will list only institutions in which the appended string appears. | [optional] | +| **page** | **Integer** | Specify current page. | [optional] | +| **records_per_page** | **Integer** | Specify records per page. | [optional] | | **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] | | **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] | | **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] | | **supports_transaction_history** | **Boolean** | Filter only institutions which support extended transaction history. | [optional] | @@ -3821,11 +3831,11 @@ - **Accept**: application/vnd.mx.api.v1+json ## list_transactions_by_tag -> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid) +> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid, opts) List transactions by tag Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. @@ -3842,30 +3852,36 @@ end api_instance = MxPlatformRuby::MxPlatformApi.new tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`. user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`. +opts = { + from_date: '2015-09-20', # String | Filter transactions from this date. + page: 1, # Integer | Specify current page. + records_per_page: 10, # Integer | Specify records per page. + to_date: '2019-10-20' # String | Filter transactions to this date. +} begin # List transactions by tag - result = api_instance.list_transactions_by_tag(tag_guid, user_guid) + result = api_instance.list_transactions_by_tag(tag_guid, user_guid, opts) p result rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}" end ``` #### Using the list_transactions_by_tag_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid) +> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts) ```ruby begin # List transactions by tag - data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid) + data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts) p status_code # => 2xx p headers # => { ... } p data # => <TransactionsResponseBody> rescue MxPlatformRuby::ApiError => e puts "Error when calling MxPlatformApi->list_transactions_by_tag_with_http_info: #{e}" @@ -3876,9 +3892,13 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | | | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | | +| **from_date** | **String** | Filter transactions from this date. | [optional] | +| **page** | **Integer** | Specify current page. | [optional] | +| **records_per_page** | **Integer** | Specify records per page. | [optional] | +| **to_date** | **String** | Filter transactions to this date. | [optional] | ### Return type [**TransactionsResponseBody**](TransactionsResponseBody.md)