treezor_client 1.1.0 → 1.2.0

data/docs/PayoutApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **delete_payout**
-> InlineResponse20019 delete_payout(id)
+> InlineResponse20020 delete_payout(id)
 
 cancel a payout
 
@@ -51,7 +51,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse20019**](InlineResponse20019.md)
+[**InlineResponse20020**](InlineResponse20020.md)
 
 ### Authorization
 
@@ -65,7 +65,7 @@ Name | Type | Description  | Notes
 
 
 # **get_payout**
-> InlineResponse20019 get_payout(id)
+> InlineResponse20020 get_payout(id)
 
 get a payout
 
@@ -105,7 +105,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse20019**](InlineResponse20019.md)
+[**InlineResponse20020**](InlineResponse20020.md)
 
 ### Authorization
 
@@ -119,7 +119,7 @@ Name | Type | Description  | Notes
 
 
 # **get_payouts**
-> InlineResponse20019 get_payouts(opts)
+> InlineResponse20020 get_payouts(opts)
 
 search pay outs
 
@@ -140,10 +140,10 @@ end
 api_instance = TreezorClient::PayoutApi.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: "access_user_ip_example", # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  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). 
   payout_id: 56, # Integer | Payout's Id
   payout_tag: "payout_tag_example", # String | Custom data.
   payout_status: "payout_status_example", # String | pay out status; Possible values: * CANCELED * PENDING * VALIDATED 
@@ -160,14 +160,14 @@ opts = {
   label: "label_example", # String | Pay out label that will be displayed in the receiver's account.
   amount: "amount_example", # String | Pay out amount.
   currency: "currency_example", # String | Transfert amount currency. Format: [ISO 4217](https://fr.wikipedia.org/wiki/ISO_4217). 
-  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).
+  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)
+  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
@@ -183,10 +183,10 @@ end
 
 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** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **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] 
  **payout_id** | **Integer**| Payout's Id | [optional] 
  **payout_tag** | **String**| Custom data. | [optional] 
  **payout_status** | **String**| pay out status; Possible values: * CANCELED * PENDING * VALIDATED  | [optional] 
@@ -203,18 +203,18 @@ Name | Type | Description  | Notes
  **label** | **String**| Pay out label that will be displayed in the receiver's account. | [optional] 
  **amount** | **String**| Pay out amount. | [optional] 
  **currency** | **String**| Transfert amount currency. Format: [ISO 4217](https://fr.wikipedia.org/wiki/ISO_4217).  | [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] 
+ **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] 
+ **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
 
-[**InlineResponse20019**](InlineResponse20019.md)
+[**InlineResponse20020**](InlineResponse20020.md)
 
 ### Authorization
 
@@ -228,7 +228,7 @@ Name | Type | Description  | Notes
 
 
 # **post_payout**
-> InlineResponse20019 post_payout(wallet_id, amount, currency, opts)
+> InlineResponse20020 post_payout(wallet_id, amount, currency, opts)
 
 create a pay out
 
@@ -255,10 +255,10 @@ amount = 56 # Integer | Pay out amount.
 currency = "currency_example" # String | Transfert amount currency. Format: [ISO 4217](https://fr.wikipedia.org/wiki/ISO_4217). 
 
 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).
+  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). 
   payout_tag: "payout_tag_example", # String | Custom data.
   bankaccount_id: 56, # Integer | Pay out bank account's id. Mandatory id beneficiaryId is not provided. If bankaccountId and beneficiaryId are both provided, the beneficiaryId will be used.
   beneficiary_id: 56, # Integer | Pay out beneficiary's id. Mandatory id bankaccountId is not provided. If bankaccountId and beneficiaryId are both provided, the beneficiaryId will be used.
@@ -282,10 +282,10 @@ Name | Type | Description  | Notes
  **wallet_id** | **Integer**| Pay out wallet id. | 
  **amount** | **Integer**| Pay out amount. | 
  **currency** | **String**| Transfert amount currency. Format: [ISO 4217](https://fr.wikipedia.org/wiki/ISO_4217).  | 
- **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] 
+ **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] 
  **payout_tag** | **String**| Custom data. | [optional] 
  **bankaccount_id** | **Integer**| Pay out bank account's id. Mandatory id beneficiaryId is not provided. If bankaccountId and beneficiaryId are both provided, the beneficiaryId will be used. | [optional] 
  **beneficiary_id** | **Integer**| Pay out beneficiary's id. Mandatory id bankaccountId is not provided. If bankaccountId and beneficiaryId are both provided, the beneficiaryId will be used. | [optional] 
@@ -294,7 +294,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse20019**](InlineResponse20019.md)
+[**InlineResponse20020**](InlineResponse20020.md)
 
 ### Authorization
 

data/docs/PayoutRefund.md

@@ -0,0 +1,22 @@
+# TreezorClient::PayoutRefund
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**tag** | **String** |  | [optional] 
+**code_status** | **Integer** |  | [optional] 
+**information_status** | **String** |  | [optional] 
+**payout_id** | **Integer** |  | [optional] 
+**request_amount** | **String** |  | [optional] 
+**request_currency** | **String** |  | [optional] 
+**request_comment** | **String** |  | [optional] 
+**reason_code** | **String** |  | [optional] 
+**refund_amount** | **String** |  | [optional] 
+**refund_currency** | **String** |  | [optional] 
+**refund_date** | **String** |  | [optional] 
+**refund_comment** | **String** |  | [optional] 
+**created_date** | **String** |  | [optional] 
+**modified_date** | **String** |  | [optional] 
+
+

data/docs/PayoutRefundsApi.md

@@ -0,0 +1,82 @@
+# TreezorClient::PayoutRefundsApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_payout_refunds**](PayoutRefundsApi.md#get_payout_refunds) | **GET** /payoutRefunds | search pay outs refund
+
+
+# **get_payout_refunds**
+> InlineResponse20021 get_payout_refunds(opts)
+
+search pay outs refund
+
+Get pay out refund 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::PayoutRefundsApi.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: "access_user_ip_example", # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
+  id: 56, # Integer | PayoutRefund id
+  tag: "tag_example", # String | PayoutRefund tag
+  code_status: "code_status_example", # String | PayoutRefund Code Status
+  information_status: "information_status_example", # String | PayoutRefund Information Status
+  payout_id: 56, # Integer | Payout Id
+  page_number: 56 # Integer | The page number
+}
+
+begin
+  #search pay outs refund
+  result = api_instance.get_payout_refunds(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling PayoutRefundsApi->get_payout_refunds: #{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** | **String**| Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **id** | **Integer**| PayoutRefund id | [optional] 
+ **tag** | **String**| PayoutRefund tag | [optional] 
+ **code_status** | **String**| PayoutRefund Code Status | [optional] 
+ **information_status** | **String**| PayoutRefund Information Status | [optional] 
+ **payout_id** | **Integer**| Payout Id | [optional] 
+ **page_number** | **Integer**| The page number | [optional] 
+
+### Return type
+
+[**InlineResponse20021**](InlineResponse20021.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TaxResidence.md

@@ -0,0 +1,15 @@
+# TreezorClient::TaxResidence
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | TaxResidence Id | [optional] 
+**user_id** | **Integer** | The user id | [optional] 
+**country** | **String** | The residence country | [optional] 
+**tax_payer_id** | **String** | the taxPayer id | [optional] 
+**liability_waiver** | **BOOLEAN** | Tax declaration | [optional] 
+**created_date** | **String** | Date of creation | [optional] 
+**last_update** | **String** | Date of the TaxResidence has been updated | [optional] 
+**deleted_date** | **String** | Date of the TaxResidence has been deleted | [optional] 
+
+

data/docs/TaxResidenceApi.md

@@ -0,0 +1,319 @@
+# TreezorClient::TaxResidenceApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**tax_residences_get**](TaxResidenceApi.md#tax_residences_get) | **GET** /taxResidences | search a residence
+[**tax_residences_id_delete**](TaxResidenceApi.md#tax_residences_id_delete) | **DELETE** /taxResidences/{id} | delete a residence
+[**tax_residences_id_get**](TaxResidenceApi.md#tax_residences_id_get) | **GET** /taxResidences/{id} | read the informations of a residence
+[**tax_residences_id_put**](TaxResidenceApi.md#tax_residences_id_put) | **PUT** /taxResidences/{id} | update the residence
+[**tax_residences_post**](TaxResidenceApi.md#tax_residences_post) | **POST** /taxResidences | create a residence
+
+
+# **tax_residences_get**
+> InlineResponse20028 tax_residences_get(opts)
+
+search a residence
+
+Search a residence 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::TaxResidenceApi.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).
+  id: 56, # Integer | id of the residence
+  user_id: 56 # Integer | User's id residence
+}
+
+begin
+  #search a residence
+  result = api_instance.tax_residences_get(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling TaxResidenceApi->tax_residences_get: #{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] 
+ **id** | **Integer**| id of the residence | [optional] 
+ **user_id** | **Integer**| User's id residence | [optional] 
+
+### Return type
+
+[**InlineResponse20028**](InlineResponse20028.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **tax_residences_id_delete**
+> InlineResponse20028 tax_residences_id_delete(id, opts)
+
+delete a residence
+
+Delete a residence that match 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::TaxResidenceApi.new
+
+id = 56 # Integer | id of the residence
+
+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).
+}
+
+begin
+  #delete a residence
+  result = api_instance.tax_residences_id_delete(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling TaxResidenceApi->tax_residences_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| id of the residence | 
+ **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] 
+
+### Return type
+
+[**InlineResponse20028**](InlineResponse20028.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **tax_residences_id_get**
+> InlineResponse20028 tax_residences_id_get(id, opts)
+
+read the informations of a residence
+
+Read the informations of a residence that match with 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::TaxResidenceApi.new
+
+id = 56 # Integer | id of the residence
+
+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).
+}
+
+begin
+  #read the informations of a residence
+  result = api_instance.tax_residences_id_get(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling TaxResidenceApi->tax_residences_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| id of the residence | 
+ **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] 
+
+### Return type
+
+[**InlineResponse20028**](InlineResponse20028.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **tax_residences_id_put**
+> InlineResponse20028 tax_residences_id_put(id, opts)
+
+update the residence
+
+Update a residence already created.
+
+### 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::TaxResidenceApi.new
+
+id = 56 # Integer | residence 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).
+  user_id: 56, # Integer | User's id residence
+  country: "country_example", # String | country of the resident
+  tax_payer_id: "tax_payer_id_example", # String | Tax payer's id
+  liability_waiver: true # BOOLEAN | Tax declaration
+}
+
+begin
+  #update the residence
+  result = api_instance.tax_residences_id_put(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling TaxResidenceApi->tax_residences_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| residence 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] 
+ **user_id** | **Integer**| User's id residence | [optional] 
+ **country** | **String**| country of the resident | [optional] 
+ **tax_payer_id** | **String**| Tax payer's id | [optional] 
+ **liability_waiver** | **BOOLEAN**| Tax declaration | [optional] 
+
+### Return type
+
+[**InlineResponse20028**](InlineResponse20028.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **tax_residences_post**
+> InlineResponse20028 tax_residences_post(user_id, country, opts)
+
+create a residence
+
+Create a new tax residence.
+
+### 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::TaxResidenceApi.new
+
+user_id = 56 # Integer | User's id residence
+
+country = "country_example" # String | country of the resident
+
+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).
+  tax_payer_id: "tax_payer_id_example", # String | Tax payer's id
+  liability_waiver: true # BOOLEAN | When there is no taxPayerId for a residence, this field shall be set to true.
+}
+
+begin
+  #create a residence
+  result = api_instance.tax_residences_post(user_id, country, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling TaxResidenceApi->tax_residences_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User's id residence | 
+ **country** | **String**| country of the resident | 
+ **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] 
+ **tax_payer_id** | **String**| Tax payer's id | [optional] 
+ **liability_waiver** | **BOOLEAN**| When there is no taxPayerId for a residence, this field shall be set to true. | [optional] 
+
+### Return type
+
+[**InlineResponse20028**](InlineResponse20028.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+