Skip to content

Latest commit

 

History

History
333 lines (241 loc) · 16.9 KB

CountryRestrictionGroupsApi.md

File metadata and controls

333 lines (241 loc) · 16.9 KB
Raw

TreezorClient::CountryRestrictionGroupsApi

All URIs are relative to https://sandbox.treezor.com/v1/index.php

Method HTTP request Description
delete_country_restriction_groups DELETE /countryRestrictionGroups/{id} cancel a country group
get_country_restriction_groups GET /countryRestrictionGroups search country restriction groups
get_country_restriction_groups_id GET /countryRestrictionGroups/{id} get a country group
post_country_restriction_group POST /countryRestrictionGroups create a countryRestrictionGroup
put_country_restriction_groups PUT /countryRestrictionGroups/{id} edit a country restriction group

delete_country_restriction_groups

InlineResponse20011 delete_country_restriction_groups(id, opts)

cancel a country group

Cancel a country restriction group from the system.

Example

# 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<String> List of the object's properties you want to pick up. [optional]

Return type

InlineResponse20011

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_country_restriction_groups

InlineResponse20011 get_country_restriction_groups(opts)

search country restriction groups

Get country restriction groups that match search criteria.

Example

# 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. [optional]
access_tag String Access tag is used for idem potency query. More info here. [optional]
access_user_id Integer Access user's id is used for user's action restriction. More info here. [optional]
access_user_ip String Access user's ip is used for user's action restriction. More info here. [optional]
fields Array<String> List of the object'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
page_number Integer Pagination page number. More info here. [optional]
page_count Integer The number of items per page. More info here. [optional]
sort_by String The transaction element you want to sort the list with. Default value : createdDate. More info here. [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. [optional]

Return type

InlineResponse20011

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_country_restriction_groups_id

InlineResponse20011 get_country_restriction_groups_id(id, opts)

get a country group

Get a country group from the system.

Example

# 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<String> List of the object's properties you want to pick up. [optional]

Return type

InlineResponse20011

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_country_restriction_group

InlineResponse20011 post_country_restriction_group(opts)

create a countryRestrictionGroup

Create a new country restriction group in the system.

Example

# 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::Body4.new # Body4 | 
}

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. [optional]
access_tag String Access tag is used for idem potency query. More info here. [optional]
access_user_id Integer Access user's id is used for user's action restriction. More info here. [optional]
access_user_ip String Access user's ip is used for user's action restriction. More info here. [optional]
fields Array<String> List of the object's properties you want to pick up. [optional]
body Body4 [optional]

Return type

InlineResponse20011

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

put_country_restriction_groups

InlineResponse20011 put_country_restriction_groups(id, opts)

edit a country restriction group

Edit a country restriction group in the system.

Example

# 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::Body5.new # Body5 | 
}

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's id.
access_signature String Access signature can be mandatory for specific context. Treezor will contact you if so. More info here. [optional]
access_tag String Access tag is used for idem potency query. More info here. [optional]
access_user_id Integer Access user's id is used for user's action restriction. More info here. [optional]
access_user_ip String Access user's ip is used for user's action restriction. More info here. [optional]
body Body5 [optional]

Return type

InlineResponse20011

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json