treezor_client 1.0.0

data/docs/Virtualiban.md

@@ -0,0 +1,18 @@
+# TreezorClient::Virtualiban
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**virtual_iban_id** | **Integer** |  | [optional] 
+**wallet_id** | **Integer** |  | [optional] 
+**type_id** | **Integer** |  | [optional] 
+**tag** | **String** |  | [optional] 
+**reference** | **String** |  | [optional] 
+**valid_from** | **Date** |  | [optional] 
+**valid_to** | **Date** |  | [optional] 
+**max_usage** | **Integer** |  | [optional] 
+**max_amount** | **String** |  | [optional] 
+**iban** | **String** |  | [optional] 
+**created_date** | **String** |  | [optional] 
+
+

data/docs/VirtualibansApi.md

@@ -0,0 +1,315 @@
+# TreezorClient::VirtualibansApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getvirtualiban**](VirtualibansApi.md#getvirtualiban) | **GET** /virtualibans/{id} | get a virtualiban by Id
+[**getvirtualibans**](VirtualibansApi.md#getvirtualibans) | **GET** /virtualibans | search virtualibans
+[**post_virtual_iban**](VirtualibansApi.md#post_virtual_iban) | **POST** /virtualibans | create a virtual IBAN
+[**put_virtual_iban**](VirtualibansApi.md#put_virtual_iban) | **PUT** /virtualibans/{id} | update a Virtual IBAN
+
+
+# **getvirtualiban**
+> InlineResponse20017 getvirtualiban(id)
+
+get a virtualiban by Id
+
+Get a virtualiban from the system by its id.
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::VirtualibansApi.new
+
+id = 789 # Integer | VirtualIban's id.
+
+
+begin
+  #get a virtualiban by Id
+  result = api_instance.getvirtualiban(id)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling VirtualibansApi->getvirtualiban: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| VirtualIban's id. | 
+
+### Return type
+
+[**InlineResponse20017**](InlineResponse20017.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **getvirtualibans**
+> InlineResponse20017 getvirtualibans(valid_from, opts)
+
+search virtualibans
+
+Get virtualiban that match search criteria.
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::VirtualibansApi.new
+
+valid_from = Date.parse("2013-10-20") # Date | The beginning date of validity.
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: 56, # Integer | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  virtual_iban_id: 56, # Integer | VirtualIban's id.
+  wallet_id: 56, # Integer | VirtualIban's wallet id.
+  type_id: 56, # Integer | VirtualIban's type id.
+  tag: 56, # Integer | A tag generated by the client
+  reference: "reference_example", # String | The client's internal reference of the vitual IBAN.
+  valid_to: Date.parse("2013-10-20"), # Date | The limit date of validity.
+  max_usage: "max_usage_example", # String | The maximum number of usage authorized.
+  max_amount: 3.4, # Float | The maximum amount authorized.
+  created_date_from: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The creation date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  created_date_to: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The creation date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  updated_date_from: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The modification date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  updated_date_to: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The modification date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  page_number: 56, # Integer | Pagination page number. More info [here](https://agent.treezor.com/lists).
+  page_count: 56, # Integer | The number of items per page. More info [here](https://agent.treezor.com/lists).
+  sort_by: "sort_by_example", # String | The transaction element you want to sort the list with. Default value : createdDate. More info [here](https://agent.treezor.com/lists).
+  sort_order: "sort_order_example" # String | The order you want to sort the list. * **DESC** for a descending sort * **ASC** for a ascending sort.  Default value : DESC. More info [here](https://agent.treezor.com/lists). 
+}
+
+begin
+  #search virtualibans
+  result = api_instance.getvirtualibans(valid_from, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling VirtualibansApi->getvirtualibans: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **valid_from** | **Date**| The beginning date of validity. | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **Integer**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **virtual_iban_id** | **Integer**| VirtualIban's id. | [optional] 
+ **wallet_id** | **Integer**| VirtualIban's wallet id. | [optional] 
+ **type_id** | **Integer**| VirtualIban's type id. | [optional] 
+ **tag** | **Integer**| A tag generated by the client | [optional] 
+ **reference** | **String**| The client's internal reference of the vitual IBAN. | [optional] 
+ **valid_to** | **Date**| The limit date of validity. | [optional] 
+ **max_usage** | **String**| The maximum number of usage authorized. | [optional] 
+ **max_amount** | **Float**| The maximum amount authorized. | [optional] 
+ **created_date_from** | **DateTime**| The creation date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **created_date_to** | **DateTime**| The creation date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **updated_date_from** | **DateTime**| The modification date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **updated_date_to** | **DateTime**| The modification date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **page_number** | **Integer**| Pagination page number. More info [here](https://agent.treezor.com/lists). | [optional] 
+ **page_count** | **Integer**| The number of items per page. More info [here](https://agent.treezor.com/lists). | [optional] 
+ **sort_by** | **String**| The transaction element you want to sort the list with. Default value : createdDate. More info [here](https://agent.treezor.com/lists). | [optional] 
+ **sort_order** | **String**| The order you want to sort the list. * **DESC** for a descending sort * **ASC** for a ascending sort.  Default value : DESC. More info [here](https://agent.treezor.com/lists).  | [optional] 
+
+### Return type
+
+[**InlineResponse20017**](InlineResponse20017.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_virtual_iban**
+> InlineResponse20017 post_virtual_iban(wallet_id, type_id, opts)
+
+create a virtual IBAN
+
+Create a new virtual IBAN in in the system.
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::VirtualibansApi.new
+
+wallet_id = 56 # Integer | The Id Of the Wallet. The Wallet must be in validated status. The wallet must be of type \"payment\" or \"electronic money\"
+
+type_id = 56 # Integer | | Type Id | Virtual IBAN Type| | ---| --- | | 1 | DEBIT | | 2 | CREDIT | 
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: "access_user_ip_example", # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  tag: 56, # Integer | A tag generated by the client
+  reference: "reference_example", # String | The client's internal reference of the vitual IBAN. Less than 255 characters.
+  valid_from: Date.parse("2013-10-20"), # Date | The beginning date of validity. The beginning date must not be less than today's date.
+  valid_to: Date.parse("2013-10-20"), # Date | The limit date of validity. Cannot be less or equal to the validFrom date.
+  max_usage: 56, # Integer | The maximum number of usage authorized. If you want to set no maximum usage limitation you can omit the parameter or set it to null. If you want to limit usage please send an integer in that field. This integer cannot be less than 1.
+  max_amount: 3.4 # Float | The maximum amount authorized.If you want to set no maximum usage amount limitation you can omit the parameter or set it to null. If you want to limit the amount please send a DECIMAL (with a point as separator) in that field. This decimal cannot be less than 0.00.
+}
+
+begin
+  #create a virtual IBAN
+  result = api_instance.post_virtual_iban(wallet_id, type_id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling VirtualibansApi->post_virtual_iban: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wallet_id** | **Integer**| The Id Of the Wallet. The Wallet must be in validated status. The wallet must be of type \"payment\" or \"electronic money\" | 
+ **type_id** | **Integer**| | Type Id | Virtual IBAN Type| | ---| --- | | 1 | DEBIT | | 2 | CREDIT |  | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **tag** | **Integer**| A tag generated by the client | [optional] 
+ **reference** | **String**| The client's internal reference of the vitual IBAN. Less than 255 characters. | [optional] 
+ **valid_from** | **Date**| The beginning date of validity. The beginning date must not be less than today's date. | [optional] 
+ **valid_to** | **Date**| The limit date of validity. Cannot be less or equal to the validFrom date. | [optional] 
+ **max_usage** | **Integer**| The maximum number of usage authorized. If you want to set no maximum usage limitation you can omit the parameter or set it to null. If you want to limit usage please send an integer in that field. This integer cannot be less than 1. | [optional] 
+ **max_amount** | **Float**| The maximum amount authorized.If you want to set no maximum usage amount limitation you can omit the parameter or set it to null. If you want to limit the amount please send a DECIMAL (with a point as separator) in that field. This decimal cannot be less than 0.00. | [optional] 
+
+### Return type
+
+[**InlineResponse20017**](InlineResponse20017.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_virtual_iban**
+> InlineResponse20017 put_virtual_iban(id, opts)
+
+update a Virtual IBAN
+
+Update Virtual IBAN's information.
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::VirtualibansApi.new
+
+id = 56 # Integer | VirtualIban's id.
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: "access_user_ip_example", # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  reference: "reference_example", # String | The client's internal reference of the vitual IBAN.
+  valid_from: Date.parse("2013-10-20"), # Date | The beginning date of validity. Date of validity can be changed. It must follow the rules explained in the POST endpoint.
+  valid_to: Date.parse("2013-10-20"), # Date | The limit date of validity. It must follow the rules of creation. It must follow the rules explained in the POST endpoint.
+  max_usage: 56, # Integer | The maximum number of usage authorized. It must follow the rules explained in the POST endpoint AND the maximum usage cannot be strictly less than the transaction counter of the Virtual Iban.
+  max_amount: 3.4 # Float | The maximum amount authorized. It must follow the rules explained in the POST endpoint AND the maximum amount cannot be strictly less than the cumulated amount of this Virtual Iban.
+}
+
+begin
+  #update a Virtual IBAN
+  result = api_instance.put_virtual_iban(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling VirtualibansApi->put_virtual_iban: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| VirtualIban's id. | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **reference** | **String**| The client's internal reference of the vitual IBAN. | [optional] 
+ **valid_from** | **Date**| The beginning date of validity. Date of validity can be changed. It must follow the rules explained in the POST endpoint. | [optional] 
+ **valid_to** | **Date**| The limit date of validity. It must follow the rules of creation. It must follow the rules explained in the POST endpoint. | [optional] 
+ **max_usage** | **Integer**| The maximum number of usage authorized. It must follow the rules explained in the POST endpoint AND the maximum usage cannot be strictly less than the transaction counter of the Virtual Iban. | [optional] 
+ **max_amount** | **Float**| The maximum amount authorized. It must follow the rules explained in the POST endpoint AND the maximum amount cannot be strictly less than the cumulated amount of this Virtual Iban. | [optional] 
+
+### Return type
+
+[**InlineResponse20017**](InlineResponse20017.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Wallet.md

@@ -0,0 +1,37 @@
+# TreezorClient::Wallet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_id** | **Integer** |  | [optional] 
+**wallet_type_id** | **Integer** | | Id | Description | |----|----| | 9 | Electronic Money Wallet | | 10 | Payment Account Wallet | | 13 | Mirror Wallet | | 14 | Electronic Money Card (Internal only) |  | [optional] 
+**wallet_status** | **String** |  | [optional] 
+**code_status** | **Integer** |  | [optional] 
+**information_status** | **String** |  | [optional] 
+**wallet_tag** | **String** |  | [optional] 
+**user_id** | **Integer** |  | [optional] 
+**user_lastname** | **String** |  | [optional] 
+**user_firstname** | **String** |  | [optional] 
+**joint_user_id** | **Integer** |  | [optional] 
+**tariff_id** | **Integer** |  | [optional] 
+**event_name** | **String** |  | [optional] 
+**event_alias** | **String** |  | [optional] 
+**event_date** | **String** | Date YYYY-MM-DD | [optional] 
+**event_message** | **String** |  | [optional] 
+**event_payin_start_date** | **String** | Date YYYY-MM-DD | [optional] 
+**event_payin_end_date** | **String** | Date YYYY-MM-DD | [optional] 
+**contract_signed** | **Integer** |  | [optional] 
+**bic** | **String** |  | [optional] 
+**iban** | **String** |  | [optional] 
+**url_image** | **String** |  | [optional] 
+**currency** | **String** |  | [optional] 
+**created_date** | **String** | Date YYYY-MM-DD HH:MM:SS | [optional] 
+**modified_date** | **String** | Date YYYY-MM-DD HH:MM:SS | [optional] 
+**payin_count** | **Integer** |  | [optional] 
+**payout_count** | **Integer** |  | [optional] 
+**transfer_count** | **Integer** |  | [optional] 
+**solde** | **Integer** |  | [optional] 
+**authorized_balance** | **Integer** |  | [optional] 
+**total_rows** | **Integer** |  | [optional] 
+
+

data/docs/WalletApi.md

@@ -0,0 +1,423 @@
+# TreezorClient::WalletApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_wallet**](WalletApi.md#delete_wallet) | **DELETE** /wallets/{id} | delete a wallet
+[**get_wallet**](WalletApi.md#get_wallet) | **GET** /wallets/{id} | get a wallet
+[**get_wallets**](WalletApi.md#get_wallets) | **GET** /wallets | search wallets
+[**post_wallets**](WalletApi.md#post_wallets) | **POST** /wallets | create a wallet
+[**put_wallet**](WalletApi.md#put_wallet) | **PUT** /wallets/{id} | update a wallet
+
+
+# **delete_wallet**
+> InlineResponse20025 delete_wallet(id, origin, opts)
+
+delete a wallet
+
+Change wallet's status to **CANCELED**.
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::WalletApi.new
+
+id = 56 # Integer | Wallet's id
+
+origin = "origin_example" # String | Request's origin. Possible values are: * OPERATOR * USER 
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: "access_user_ip_example" # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+}
+
+begin
+  #delete a wallet
+  result = api_instance.delete_wallet(id, origin, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling WalletApi->delete_wallet: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Wallet's id | 
+ **origin** | **String**| Request's origin. Possible values are: * OPERATOR * USER  | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+
+### Return type
+
+[**InlineResponse20025**](InlineResponse20025.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_wallet**
+> InlineResponse20025 get_wallet(id, opts)
+
+get a wallet
+
+
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::WalletApi.new
+
+id = 789 # Integer | Object internal id.
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: "access_user_ip_example" # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+}
+
+begin
+  #get a wallet
+  result = api_instance.get_wallet(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling WalletApi->get_wallet: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Object internal id. | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+
+### Return type
+
+[**InlineResponse20025**](InlineResponse20025.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_wallets**
+> InlineResponse20025 get_wallets(opts)
+
+search wallets
+
+Get wallets from the system that match the search criteria.
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::WalletApi.new
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: 56, # Integer | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  wallet_id: 56, # Integer | Wallet's unique id.
+  wallet_status: "wallet_status_example", # String | Wallet's status:  * **validated**: Wallet is active. It is possible to deposit to or retrieve money from the wallet.  * **cancelled**: Wallet is closed. No action possible, there is no money in the wallet, it was closed by an operator or by the user.  * **pending**: Wallet being validated (e.g. suspected fraud, late submission of documents' validation ... KYC ). In this case, it is not possible to use the wallet for transactions.
+  user_id: 56, # Integer | Wallet owner's id.
+  parent_user_id: 56, # Integer | Parent user id of the wallet owner
+  wallet_tag: "wallet_tag_example", # String | Custom data.
+  wallet_type_id: 56, # Integer | Wallet type id. The following values are defined:  | Id | Description | |----|----| | 9 | Electronic Money Wallet | | 10 | Payment Account Wallet | | 13 | Mirror Wallet | | 14 | Electronic Money Card (Internal only) | 
+  event_name: "event_name_example", # String | Event name that will be used as wallet name. For example, in a wedding list: Wedding of X and Y
+  event_alias: "event_alias_example", # String | Short url wallet name. It's automatically generated by the system, but it could be modified and customised by the user. For example: www.domain.com/wallet=mywedding
+  event_payin_start_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime |  Wallet activation date. The date from which you can deposit money on the wallet. Format : YYYY-MM-DD HH:MM:SS
+  event_payin_end_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Deadline to money deposit on the wallet. Format : YYYY-MM-DD HH:MM:SS
+  tariff_id: 56, # Integer | Wallet pricing id.
+  payin_count: 56, # Integer | Number of payin done on the wallet.
+  solde: "solde_example", # String | Wallet current balance.
+  page_number: 56, # Integer | Pagination page number. More info [here](https://agent.treezor.com/lists).
+  page_count: 56, # Integer | The number of items per page. More info [here](https://agent.treezor.com/lists).
+  sort_by: "sort_by_example", # String | The transaction element you want to sort the list with. Default value : _createdDate_. More info [here](https://agent.treezor.com/lists).
+  sort_order: "sort_order_example", # String | The order you want to sort the list. * **DESC** for a descending sort * **ASC** for a ascending sort.  Default value : DESC. More info [here](https://agent.treezor.com/lists). 
+  created_date_from: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The creation date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  created_date_to: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The creation date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  updated_date_from: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The modification date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+  updated_date_to: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | The modification date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists)
+}
+
+begin
+  #search wallets
+  result = api_instance.get_wallets(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling WalletApi->get_wallets: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **Integer**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **wallet_id** | **Integer**| Wallet's unique id. | [optional] 
+ **wallet_status** | **String**| Wallet's status:  * **validated**: Wallet is active. It is possible to deposit to or retrieve money from the wallet.  * **cancelled**: Wallet is closed. No action possible, there is no money in the wallet, it was closed by an operator or by the user.  * **pending**: Wallet being validated (e.g. suspected fraud, late submission of documents' validation ... KYC ). In this case, it is not possible to use the wallet for transactions. | [optional] 
+ **user_id** | **Integer**| Wallet owner's id. | [optional] 
+ **parent_user_id** | **Integer**| Parent user id of the wallet owner | [optional] 
+ **wallet_tag** | **String**| Custom data. | [optional] 
+ **wallet_type_id** | **Integer**| Wallet type id. The following values are defined:  | Id | Description | |----|----| | 9 | Electronic Money Wallet | | 10 | Payment Account Wallet | | 13 | Mirror Wallet | | 14 | Electronic Money Card (Internal only) |  | [optional] 
+ **event_name** | **String**| Event name that will be used as wallet name. For example, in a wedding list: Wedding of X and Y | [optional] 
+ **event_alias** | **String**| Short url wallet name. It's automatically generated by the system, but it could be modified and customised by the user. For example: www.domain.com/wallet=mywedding | [optional] 
+ **event_payin_start_date** | **DateTime**|  Wallet activation date. The date from which you can deposit money on the wallet. Format : YYYY-MM-DD HH:MM:SS | [optional] 
+ **event_payin_end_date** | **DateTime**| Deadline to money deposit on the wallet. Format : YYYY-MM-DD HH:MM:SS | [optional] 
+ **tariff_id** | **Integer**| Wallet pricing id. | [optional] 
+ **payin_count** | **Integer**| Number of payin done on the wallet. | [optional] 
+ **solde** | **String**| Wallet current balance. | [optional] 
+ **page_number** | **Integer**| Pagination page number. More info [here](https://agent.treezor.com/lists). | [optional] 
+ **page_count** | **Integer**| The number of items per page. More info [here](https://agent.treezor.com/lists). | [optional] 
+ **sort_by** | **String**| The transaction element you want to sort the list with. Default value : _createdDate_. More info [here](https://agent.treezor.com/lists). | [optional] 
+ **sort_order** | **String**| The order you want to sort the list. * **DESC** for a descending sort * **ASC** for a ascending sort.  Default value : DESC. More info [here](https://agent.treezor.com/lists).  | [optional] 
+ **created_date_from** | **DateTime**| The creation date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **created_date_to** | **DateTime**| The creation date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **updated_date_from** | **DateTime**| The modification date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+ **updated_date_to** | **DateTime**| The modification date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](https://agent.treezor.com/lists) | [optional] 
+
+### Return type
+
+[**InlineResponse20025**](InlineResponse20025.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_wallets**
+> InlineResponse20025 post_wallets(wallet_type_id, tariff_id, user_id, currency, event_name, opts)
+
+create a wallet
+
+Create a new wallet in the system..
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::WalletApi.new
+
+wallet_type_id = 56 # Integer | Wallet type id. The following values are defined:  | Id | Description | |----|----| | 9 | Electronic Money Wallet | | 10 | Payment Account Wallet | | 13 | Mirror Wallet | | 14 | Electronic Money Card (Internal only) | 
+
+tariff_id = 56 # Integer | Wallet pricing id.
+
+user_id = 56 # Integer | Wallet owner's id.
+
+currency = "currency_example" # String | The currency that will be used for all wallet money transactions format : ISO 4217 3-letter code for each currency : Euro = EUR ; US Dollar = USD … Default currency will be same as the wallet
+
+event_name = "event_name_example" # String | Event name that will be used as wallet name. For example, in a wedding list: Wedding of X and Y
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: 56, # Integer | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  joint_user_id: 56, # Integer | Wallet co-owner's id. This user will not be allowed to collect the money from the wallet.
+  wallet_tag: "wallet_tag_example", # String | Custom data
+  load: 3.4, # Float | Initial loading amount.
+  event_alias: "event_alias_example", # String | Short url wallet name. It's automatically generated by the system, but it could be modified and customised by the user. For example: www.domain.com/wallet=mywedding. Please note that the eventAlias must be unique.
+  event_date: Date.parse("2013-10-20"), # Date | Wallet event date. Format : YYYY-MM-DD. Default: Created date + 7 days.
+  event_message: "event_message_example", # String | It can be a description of the wallet.
+  event_payin_start_date: Date.parse("2013-10-20"), # Date |  Wallet activation date. The date from which you can deposit money on the wallet. Format : YYYY-MM-DD. If null, the default date will be the created date of the wallet.
+  event_payin_end_date: Date.parse("2013-10-20") # Date | Deadline to money deposit on the wallet. Format : YYYY-MM-DD. If null, the money can be deposited indefinitely on the wallet
+}
+
+begin
+  #create a wallet
+  result = api_instance.post_wallets(wallet_type_id, tariff_id, user_id, currency, event_name, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling WalletApi->post_wallets: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wallet_type_id** | **Integer**| Wallet type id. The following values are defined:  | Id | Description | |----|----| | 9 | Electronic Money Wallet | | 10 | Payment Account Wallet | | 13 | Mirror Wallet | | 14 | Electronic Money Card (Internal only) |  | 
+ **tariff_id** | **Integer**| Wallet pricing id. | 
+ **user_id** | **Integer**| Wallet owner's id. | 
+ **currency** | **String**| The currency that will be used for all wallet money transactions format : ISO 4217 3-letter code for each currency : Euro = EUR ; US Dollar = USD … Default currency will be same as the wallet | 
+ **event_name** | **String**| Event name that will be used as wallet name. For example, in a wedding list: Wedding of X and Y | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **Integer**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **joint_user_id** | **Integer**| Wallet co-owner's id. This user will not be allowed to collect the money from the wallet. | [optional] 
+ **wallet_tag** | **String**| Custom data | [optional] 
+ **load** | **Float**| Initial loading amount. | [optional] 
+ **event_alias** | **String**| Short url wallet name. It's automatically generated by the system, but it could be modified and customised by the user. For example: www.domain.com/wallet=mywedding. Please note that the eventAlias must be unique. | [optional] 
+ **event_date** | **Date**| Wallet event date. Format : YYYY-MM-DD. Default: Created date + 7 days. | [optional] 
+ **event_message** | **String**| It can be a description of the wallet. | [optional] 
+ **event_payin_start_date** | **Date**|  Wallet activation date. The date from which you can deposit money on the wallet. Format : YYYY-MM-DD. If null, the default date will be the created date of the wallet. | [optional] 
+ **event_payin_end_date** | **Date**| Deadline to money deposit on the wallet. Format : YYYY-MM-DD. If null, the money can be deposited indefinitely on the wallet | [optional] 
+
+### Return type
+
+[**InlineResponse20025**](InlineResponse20025.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_wallet**
+> InlineResponse20025 put_wallet(id, opts)
+
+update a wallet
+
+Modifiy wallet information
+
+### Example
+```ruby
+# load the gem
+require 'treezor_client'
+# setup authorization
+TreezorClient.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 = TreezorClient::WalletApi.new
+
+id = 789 # Integer | Object internal id.
+
+opts = { 
+  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  access_user_ip: "access_user_ip_example", # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  wallet_type_id: "wallet_type_id_example", # String | Change wallet type id
+  event_name: "event_name_example", # String | Change event name
+  event_alias: "event_alias_example", # String | Change event alias. Please note that the eventAlias must be unique.
+  event_date: "event_date_example", # String | Change event date
+  event_message: "event_message_example", # String | Change event message
+  event_payin_start_date: "event_payin_start_date_example", # String | Change event payin starting date
+  event_payin_end_date: "event_payin_end_date_example", # String | Change event payin end date
+  url_image: "url_image_example", # String | Change URL image
+  image_name: "image_name_example", # String | Change image name
+  tariff_id: "tariff_id_example" # String | Change tariff id
+}
+
+begin
+  #update a wallet
+  result = api_instance.put_wallet(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling WalletApi->put_wallet: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Object internal id. | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **wallet_type_id** | **String**| Change wallet type id | [optional] 
+ **event_name** | **String**| Change event name | [optional] 
+ **event_alias** | **String**| Change event alias. Please note that the eventAlias must be unique. | [optional] 
+ **event_date** | **String**| Change event date | [optional] 
+ **event_message** | **String**| Change event message | [optional] 
+ **event_payin_start_date** | **String**| Change event payin starting date | [optional] 
+ **event_payin_end_date** | **String**| Change event payin end date | [optional] 
+ **url_image** | **String**| Change URL image | [optional] 
+ **image_name** | **String**| Change image name | [optional] 
+ **tariff_id** | **String**| Change tariff id | [optional] 
+
+### Return type
+
+[**InlineResponse20025**](InlineResponse20025.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+