treezor_client 1.0.0

data/docs/CardtransactionApi.md

@@ -0,0 +1,141 @@
+# TreezorClient::CardtransactionApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_cardtransaction**](CardtransactionApi.md#get_cardtransaction) | **GET** /cardtransactions/{id} | get a card transaction
+[**read_card_transaction**](CardtransactionApi.md#read_card_transaction) | **GET** /cardtransactions | search for card transactions
+
+
+# **get_cardtransaction**
+> InlineResponse20010 get_cardtransaction(id)
+
+get a card transaction
+
+get a card transaction
+
+### 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::CardtransactionApi.new
+
+id = 789 # Integer | Card transactions's internal id.
+
+
+begin
+  #get a card transaction
+  result = api_instance.get_cardtransaction(id)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardtransactionApi->get_cardtransaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Card transactions's internal id. | 
+
+### Return type
+
+[**InlineResponse20010**](InlineResponse20010.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **read_card_transaction**
+> InlineResponse20010 read_card_transaction(opts)
+
+search for card transactions
+
+Search for documents.
+
+### 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::CardtransactionApi.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).
+  cardtransaction_id: 56, # Integer | Card transaction's Id
+  card_id: 56, # Integer | Card's Id
+  wallet_id: 56, # Integer | Card's wallet Id
+  merchant_id: 56, # Integer | Merchant's Id
+  public_token: "public_token_example", # String | Card's public token
+  payment_id: 56, # Integer | Payment's Id
+  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).
+}
+
+begin
+  #search for card transactions
+  result = api_instance.read_card_transaction(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardtransactionApi->read_card_transaction: #{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] 
+ **cardtransaction_id** | **Integer**| Card transaction's Id | [optional] 
+ **card_id** | **Integer**| Card's Id | [optional] 
+ **wallet_id** | **Integer**| Card's wallet Id | [optional] 
+ **merchant_id** | **Integer**| Merchant's Id | [optional] 
+ **public_token** | **String**| Card's public token | [optional] 
+ **payment_id** | **Integer**| Payment's Id | [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] 
+
+### Return type
+
+[**InlineResponse20010**](InlineResponse20010.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CountryRestrictionGroupsApi.md

@@ -0,0 +1,333 @@
+# TreezorClient::CountryRestrictionGroupsApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_country_restriction_groups**](CountryRestrictionGroupsApi.md#delete_country_restriction_groups) | **DELETE** /countryRestrictionGroups/{id} | cancel a country group
+[**get_country_restriction_groups**](CountryRestrictionGroupsApi.md#get_country_restriction_groups) | **GET** /countryRestrictionGroups | search country restriction groups
+[**get_country_restriction_groups_id**](CountryRestrictionGroupsApi.md#get_country_restriction_groups_id) | **GET** /countryRestrictionGroups/{id} | get a country group
+[**post_country_restriction_group**](CountryRestrictionGroupsApi.md#post_country_restriction_group) | **POST** /countryRestrictionGroups | create a countryRestrictionGroup
+[**put_country_restriction_groups**](CountryRestrictionGroupsApi.md#put_country_restriction_groups) | **PUT** /countryRestrictionGroups/{id} | edit a country restriction group
+
+
+# **delete_country_restriction_groups**
+> InlineResponse20015 delete_country_restriction_groups(id, opts)
+
+cancel a country group
+
+Cancel a country restriction group from 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::CountryRestrictionGroupsApi.new
+
+id = 789 # Integer | country restriction Group internal id.
+
+opts = { 
+  fields: ["fields_example"] # Array<String> | List of the object's properties you want to pick up.
+}
+
+begin
+  #cancel a country group
+  result = api_instance.delete_country_restriction_groups(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CountryRestrictionGroupsApi->delete_country_restriction_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| country restriction Group internal id. | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| List of the object&#39;s properties you want to pick up. | [optional] 
+
+### Return type
+
+[**InlineResponse20015**](InlineResponse20015.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_country_restriction_groups**
+> InlineResponse20015 get_country_restriction_groups(opts)
+
+search country restriction groups
+
+Get country restriction groups 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::CountryRestrictionGroupsApi.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).
+  fields: ["fields_example"], # Array<String> | List of the object's properties you want to pick up.
+  filter: "filter_example", # String | You can filter the API response by using filter(s). Filterable fields are :   - id   - name   - isWhitelist   - status   - startDate   - createdDate    Filters should be separated by a \";\". Example for 3 filters : FILTER1;FILTER2;FILTER3.    A single filter has the following syntax : \"fieldName criterion expression\".    Where :     - fieldName : the name of a filterable field of this object.      - expression : the values to be included or excluded (see the table below for more information)      - criterion : a filter criterion.    Here are the possible values for criterion :   | Criteria |         Description    |                   Type                   | Expression Example |   |----------|------------------------|------------------------------------------|--------------------|   |     >    |      greater than      |            alphanumeric string           |         100        |   |    >=    | greater or equal than  |            alphanumeric string           |         100        |   |     <    |        less than       |            alphanumeric string           |         100        |   |    <=    |   less or equal than   |            alphanumeric string           |         100        |   |    !=    |      not equal to      |            alphanumeric string           |         100        |   |   like   |          like          |            alphanumeric string           |         100        |   |    in    |           in           | alphanumeric strings separated by commas |      100,30,25     |   |    ==    |         equals         |            alphanumeric string           |         100        | 
+  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 country restriction groups
+  result = api_instance.get_country_restriction_groups(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CountryRestrictionGroupsApi->get_country_restriction_groups: #{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&#39;s id is used for user&#39;s action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user&#39;s ip is used for user&#39;s action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| List of the object&#39;s properties you want to pick up. | [optional] 
+ **filter** | **String**| You can filter the API response by using filter(s). Filterable fields are :   - id   - name   - isWhitelist   - status   - startDate   - createdDate    Filters should be separated by a \&quot;;\&quot;. Example for 3 filters : FILTER1;FILTER2;FILTER3.    A single filter has the following syntax : \&quot;fieldName criterion expression\&quot;.    Where :     - fieldName : the name of a filterable field of this object.      - expression : the values to be included or excluded (see the table below for more information)      - criterion : a filter criterion.    Here are the possible values for criterion :   | Criteria |         Description    |                   Type                   | Expression Example |   |----------|------------------------|------------------------------------------|--------------------|   |     &gt;    |      greater than      |            alphanumeric string           |         100        |   |    &gt;&#x3D;    | greater or equal than  |            alphanumeric string           |         100        |   |     &lt;    |        less than       |            alphanumeric string           |         100        |   |    &lt;&#x3D;    |   less or equal than   |            alphanumeric string           |         100        |   |    !&#x3D;    |      not equal to      |            alphanumeric string           |         100        |   |   like   |          like          |            alphanumeric string           |         100        |   |    in    |           in           | alphanumeric strings separated by commas |      100,30,25     |   |    &#x3D;&#x3D;    |         equals         |            alphanumeric string           |         100        |  | [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
+
+[**InlineResponse20015**](InlineResponse20015.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_country_restriction_groups_id**
+> InlineResponse20015 get_country_restriction_groups_id(id, opts)
+
+get a country group
+
+Get a country group from 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::CountryRestrictionGroupsApi.new
+
+id = 789 # Integer | country restriction Group internal id.
+
+opts = { 
+  fields: ["fields_example"] # Array<String> | List of the object's properties you want to pick up.
+}
+
+begin
+  #get a country group
+  result = api_instance.get_country_restriction_groups_id(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CountryRestrictionGroupsApi->get_country_restriction_groups_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| country restriction Group internal id. | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| List of the object&#39;s properties you want to pick up. | [optional] 
+
+### Return type
+
+[**InlineResponse20015**](InlineResponse20015.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_country_restriction_group**
+> InlineResponse20015 post_country_restriction_group(opts)
+
+create a countryRestrictionGroup
+
+Create a new country restriction group 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::CountryRestrictionGroupsApi.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).
+  fields: ["fields_example"], # Array<String> | List of the object's properties you want to pick up.
+  body: TreezorClient::Body9.new # Body9 | 
+}
+
+begin
+  #create a countryRestrictionGroup
+  result = api_instance.post_country_restriction_group(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CountryRestrictionGroupsApi->post_country_restriction_group: #{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&#39;s id is used for user&#39;s action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user&#39;s ip is used for user&#39;s action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| List of the object&#39;s properties you want to pick up. | [optional] 
+ **body** | [**Body9**](Body9.md)|  | [optional] 
+
+### Return type
+
+[**InlineResponse20015**](InlineResponse20015.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_country_restriction_groups**
+> InlineResponse20015 put_country_restriction_groups(id, opts)
+
+edit a country restriction group
+
+Edit a country restriction group 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::CountryRestrictionGroupsApi.new
+
+id = 56 # Integer | country group'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).
+  body: TreezorClient::Body10.new # Body10 | 
+}
+
+begin
+  #edit a country restriction group
+  result = api_instance.put_country_restriction_groups(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CountryRestrictionGroupsApi->put_country_restriction_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| country group&#39;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&#39;s id is used for user&#39;s action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user&#39;s ip is used for user&#39;s action restriction. More info [here](https://agent.treezor.com/basics). | [optional] 
+ **body** | [**Body10**](Body10.md)|  | [optional] 
+
+### Return type
+
+[**InlineResponse20015**](InlineResponse20015.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+