docs/BanksApi.md in budgea_client-2.0.0 vs docs/BanksApi.md in budgea_client-2.0.1

- old
+ new

@@ -13,10 +13,12 @@ [**banks_id_connector_connections_get**](BanksApi.md#banks_id_connector_connections_get) | **GET** /banks/{id_connector}/connections | Get a subset of id_connection with the largest diversity of account [**banks_id_connector_logos_get**](BanksApi.md#banks_id_connector_logos_get) | **GET** /banks/{id_connector}/logos | Get all links to the files associated with this connector. [**banks_id_connector_logos_main_get**](BanksApi.md#banks_id_connector_logos_main_get) | **GET** /banks/{id_connector}/logos/main | Get all links to the files associated with this connector. [**banks_id_connector_logos_thumbnail_get**](BanksApi.md#banks_id_connector_logos_thumbnail_get) | **GET** /banks/{id_connector}/logos/thumbnail | Get all links to the files associated with this connector. [**categories_get**](BanksApi.md#categories_get) | **GET** /categories | Get all categories +[**categories_keywords_id_keyword_delete**](BanksApi.md#categories_keywords_id_keyword_delete) | **DELETE** /categories/keywords/{id_keyword} | Delete a particular key-value pair on a transaction. +[**categories_keywords_post**](BanksApi.md#categories_keywords_post) | **POST** /categories/keywords | Add a new keyword associated with a category in the database. [**categorize_post**](BanksApi.md#categorize_post) | **POST** /categorize | categorize transactions without storing them [**connections_get**](BanksApi.md#connections_get) | **GET** /connections | Get connections without a user [**connectors_get**](BanksApi.md#connectors_get) | **GET** /connectors | Get list of connectors [**connectors_id_connector_logos_get**](BanksApi.md#connectors_id_connector_logos_get) | **GET** /connectors/{id_connector}/logos | Get all links to the files associated with this connector. [**connectors_id_connector_logos_id_logo_delete**](BanksApi.md#connectors_id_connector_logos_id_logo_delete) | **DELETE** /connectors/{id_connector}/logos/{id_logo} | Delete a single Logo object. @@ -493,10 +495,11 @@ id_connector = 56 # Integer | opts = { range: 56, # Integer | the length of the connection subset type: 56, # Integer | to target a specific account type which will be + occurrences: 56, # Integer | require at least N accounts of the targeted expand: 'expand_example' # String | } begin #Get a subset of id_connection with the largest diversity of account @@ -512,10 +515,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id_connector** | **Integer**| | **range** | **Integer**| the length of the connection subset | [optional] **type** | **Integer**| to target a specific account type which will be | [optional] + **occurrences** | **Integer**| require at least N accounts of the targeted | [optional] **expand** | **String**| | [optional] ### Return type [**InlineResponse2009**](InlineResponse2009.md) @@ -758,10 +762,123 @@ - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **categories_keywords_id_keyword_delete** +> Keyword categories_keywords_id_keyword_delete(id_keyword, opts) + +Delete a particular key-value pair on a transaction. + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_keyword = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Delete a particular key-value pair on a transaction. + result = api_instance.categories_keywords_id_keyword_delete(id_keyword, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->categories_keywords_id_keyword_delete: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_keyword** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**Keyword**](Keyword.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + +# **categories_keywords_post** +> Keyword categories_keywords_post(opts) + +Add a new keyword associated with a category in the database. + +If the keyword already exists the keyword is not added. Used for the categorization of transactions.<br><br>Form params: - id_category (integer): a reference towards the category associated with the keyword - keyword (string): the searched keyword - income (bool): 1 if the associated category represents an income else 0 - priority (integer): sets the priority for the keyword, used when categorizing<br><br> + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +opts = { + expand: 'expand_example' # String | +} + +begin + #Add a new keyword associated with a category in the database. + result = api_instance.categories_keywords_post(opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->categories_keywords_post: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | **String**| | [optional] + +### Return type + +[**Keyword**](Keyword.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **categorize_post** > Object categorize_post(wording, value, type) categorize transactions without storing them @@ -874,11 +991,11 @@ - **Accept**: application/json # **connectors_get** -> InlineResponse20013 connectors_get(opts) +> InlineResponse20014 connectors_get(opts) Get list of connectors @@ -915,11 +1032,11 @@ ------------- | ------------- | ------------- | ------------- **expand** | **String**| | [optional] ### Return type -[**InlineResponse20013**](InlineResponse20013.md) +[**InlineResponse20014**](InlineResponse20014.md) ### Authorization [api_key](../README.md#api_key) @@ -1432,11 +1549,10 @@ login = 'login_example' # String | Users login password = 'password_example' # String | Users password opts = { - api: 'api_example', # String | Name of the API url: 'url_example', # String | Url of the bank email: 'email_example', # String | Email of the user types: 'types_example', # String | Type of connector, eg. banks or providers comment: 'comment_example', # String | Optionnal comment sendmail: true, # BOOLEAN | if set, send an email to user @@ -1457,11 +1573,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **String**| Name of the bank or provider | **login** | **String**| Users login | **password** | **String**| Users password | - **api** | **String**| Name of the API | [optional] **url** | **String**| Url of the bank | [optional] **email** | **String**| Email of the user | [optional] **types** | **String**| Type of connector, eg. banks or providers | [optional] **comment** | **String**| Optionnal comment | [optional] **sendmail** | **BOOLEAN**| if set, send an email to user | [optional] @@ -1541,11 +1656,11 @@ - **Accept**: application/json # **logs_get** -> InlineResponse20016 logs_get(opts) +> InlineResponse20017 logs_get(opts) Get connection logs Get logs about connections.<br><br> @@ -1602,11 +1717,11 @@ **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20016**](InlineResponse20016.md) +[**InlineResponse20017**](InlineResponse20017.md) ### Authorization [api_key](../README.md#api_key) @@ -1616,11 +1731,11 @@ - **Accept**: application/json # **providers_get** -> InlineResponse20017 providers_get(opts) +> InlineResponse20018 providers_get(opts) Get list of connectors @@ -1657,11 +1772,11 @@ ------------- | ------------- | ------------- | ------------- **expand** | **String**| | [optional] ### Return type -[**InlineResponse20017**](InlineResponse20017.md) +[**InlineResponse20018**](InlineResponse20018.md) ### Authorization [api_key](../README.md#api_key) @@ -2082,11 +2197,11 @@ - **Accept**: application/json # **users_id_user_accounts_get** -> InlineResponse20020 users_id_user_accounts_get(id_user, opts) +> InlineResponse20021 users_id_user_accounts_get(id_user, opts) Get accounts list. @@ -2126,11 +2241,11 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20020**](InlineResponse20020.md) +[**InlineResponse20021**](InlineResponse20021.md) ### Authorization [api_key](../README.md#api_key) @@ -2321,11 +2436,11 @@ - **Accept**: application/json # **users_id_user_accounts_id_account_logs_get** -> InlineResponse20023 users_id_user_accounts_id_account_logs_get(id_user, id_account, opts) +> InlineResponse20024 users_id_user_accounts_id_account_logs_get(id_user, id_account, opts) Get accounts logs. Get logs of account.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -2376,11 +2491,11 @@ **max_date** | **Date**| maximum (inclusive) date | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20023**](InlineResponse20023.md) +[**InlineResponse20024**](InlineResponse20024.md) ### Authorization [api_key](../README.md#api_key) @@ -2526,11 +2641,11 @@ - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_get** -> InlineResponse20027 users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts) +> InlineResponse20028 users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -2599,11 +2714,11 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20027**](InlineResponse20027.md) +[**InlineResponse20028**](InlineResponse20028.md) ### Authorization [api_key](../README.md#api_key) @@ -2677,11 +2792,11 @@ - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_informations_get** -> InlineResponse20029 users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts) +> InlineResponse20030 users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -2727,11 +2842,11 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20029**](InlineResponse20029.md) +[**InlineResponse20030**](InlineResponse20030.md) ### Authorization [api_key](../README.md#api_key) @@ -3097,11 +3212,11 @@ - **Accept**: application/json # **users_id_user_accounts_id_account_transactionsclusters_get** -> InlineResponse20030 users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts) +> InlineResponse20031 users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts) Get clustered transactions @@ -3144,11 +3259,11 @@ **id_account** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) @@ -3477,11 +3592,11 @@ - **Accept**: application/json # **users_id_user_alerts_get** -> InlineResponse20031 users_id_user_alerts_get(id_user, opts) +> InlineResponse20032 users_id_user_alerts_get(id_user, opts) Get alerts @@ -3521,11 +3636,11 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20031**](InlineResponse20031.md) +[**InlineResponse20032**](InlineResponse20032.md) ### Authorization [api_key](../README.md#api_key) @@ -3535,11 +3650,11 @@ - **Accept**: application/json # **users_id_user_categories_full_get** -> InlineResponse20032 users_id_user_categories_full_get(id_user, opts) +> InlineResponse20033 users_id_user_categories_full_get(id_user, opts) Get the category Ressource to get categories<br><br> @@ -3579,11 +3694,11 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization [api_key](../README.md#api_key) @@ -4021,11 +4136,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_get** -> InlineResponse20020 users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts) +> InlineResponse20021 users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts) Get accounts list. @@ -4068,11 +4183,11 @@ **id_connection** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20020**](InlineResponse20020.md) +[**InlineResponse20021**](InlineResponse20021.md) ### Authorization [api_key](../README.md#api_key) @@ -4272,11 +4387,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_logs_get** -> InlineResponse20023 users_id_user_connections_id_connection_accounts_id_account_logs_get(id_user, id_connection, id_account, opts) +> InlineResponse20024 users_id_user_connections_id_connection_accounts_id_account_logs_get(id_user, id_connection, id_account, opts) Get accounts logs. Get logs of account.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -4330,11 +4445,11 @@ **max_date** | **Date**| maximum (inclusive) date | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20023**](InlineResponse20023.md) +[**InlineResponse20024**](InlineResponse20024.md) ### Authorization [api_key](../README.md#api_key) @@ -4486,11 +4601,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_get** -> InlineResponse20027 users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts) +> InlineResponse20028 users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -4562,11 +4677,11 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20027**](InlineResponse20027.md) +[**InlineResponse20028**](InlineResponse20028.md) ### Authorization [api_key](../README.md#api_key) @@ -4643,11 +4758,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get** -> InlineResponse20029 users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts) +> InlineResponse20030 users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -4696,11 +4811,11 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20029**](InlineResponse20029.md) +[**InlineResponse20030**](InlineResponse20030.md) ### Authorization [api_key](../README.md#api_key) @@ -5081,11 +5196,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get** -> InlineResponse20030 users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts) +> InlineResponse20031 users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts) Get clustered transactions @@ -5131,11 +5246,11 @@ **id_account** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) @@ -5601,11 +5716,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_logs_get** -> InlineResponse20016 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts) +> InlineResponse20017 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts) Get connection logs Get logs about connections.<br><br> @@ -5668,11 +5783,11 @@ **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20016**](InlineResponse20016.md) +[**InlineResponse20017**](InlineResponse20017.md) ### Authorization [api_key](../README.md#api_key) @@ -5873,11 +5988,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_get** -> InlineResponse20027 users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts) +> InlineResponse20028 users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -5946,11 +6061,11 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20027**](InlineResponse20027.md) +[**InlineResponse20028**](InlineResponse20028.md) ### Authorization [api_key](../README.md#api_key) @@ -6024,11 +6139,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_informations_get** -> InlineResponse20029 users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts) +> InlineResponse20030 users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -6074,11 +6189,11 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20029**](InlineResponse20029.md) +[**InlineResponse20030**](InlineResponse20030.md) ### Authorization [api_key](../README.md#api_key) @@ -6444,11 +6559,11 @@ - **Accept**: application/json # **users_id_user_connections_id_connection_transactionsclusters_get** -> InlineResponse20030 users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts) +> InlineResponse20031 users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts) Get clustered transactions @@ -6491,11 +6606,11 @@ **id_connection** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) @@ -6718,10 +6833,11 @@ id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' opts = { id_connector: 56, # Integer | ID of the connector + connector_uuid: 'connector_uuid_example', # String | optional uuid of the connector (replaces id_connector) birthday: 'birthday_example', # String | bank additional login parameter password: 'password_example', # String | bank additional login parameter oauth_token: 'oauth_token_example', # String | bank additional login parameter oauth_token_secret: 'oauth_token_secret_example', # String | bank additional login parameter auth_type: 'auth_type_example', # String | bank additional login parameter @@ -6748,10 +6864,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **id_connector** | **Integer**| ID of the connector | [optional] + **connector_uuid** | **String**| optional uuid of the connector (replaces id_connector) | [optional] **birthday** | **String**| bank additional login parameter | [optional] **password** | **String**| bank additional login parameter | [optional] **oauth_token** | **String**| bank additional login parameter | [optional] **oauth_token_secret** | **String**| bank additional login parameter | [optional] **auth_type** | **String**| bank additional login parameter | [optional] @@ -6831,11 +6948,11 @@ - **Accept**: application/json # **users_id_user_logs_get** -> InlineResponse20016 users_id_user_logs_get(id_user, opts) +> InlineResponse20017 users_id_user_logs_get(id_user, opts) Get connection logs Get logs about connections.<br><br> @@ -6895,11 +7012,11 @@ **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20016**](InlineResponse20016.md) +[**InlineResponse20017**](InlineResponse20017.md) ### Authorization [api_key](../README.md#api_key) @@ -6967,11 +7084,11 @@ - **Accept**: application/json # **users_id_user_transactions_get** -> InlineResponse20027 users_id_user_transactions_get(id_user, opts) +> InlineResponse20028 users_id_user_transactions_get(id_user, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -7037,11 +7154,11 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20027**](InlineResponse20027.md) +[**InlineResponse20028**](InlineResponse20028.md) ### Authorization [api_key](../README.md#api_key) @@ -7112,11 +7229,11 @@ - **Accept**: application/json # **users_id_user_transactions_id_transaction_informations_get** -> InlineResponse20029 users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts) +> InlineResponse20030 users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -7159,11 +7276,11 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20029**](InlineResponse20029.md) +[**InlineResponse20030**](InlineResponse20030.md) ### Authorization [api_key](../README.md#api_key) @@ -7514,11 +7631,11 @@ - **Accept**: application/json # **users_id_user_transactionsclusters_get** -> InlineResponse20030 users_id_user_transactionsclusters_get(id_user, opts) +> InlineResponse20031 users_id_user_transactionsclusters_get(id_user, opts) Get clustered transactions @@ -7558,10 +7675,10 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key)