treezor_client 1.0.0

data/docs/CardDigitalization.md

@@ -0,0 +1,14 @@
+# TreezorClient::CardDigitalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**external_id** | **Integer** |  | [optional] 
+**card_id** | **String** |  | [optional] 
+**details_from_gps** | [**CardDigitalizationDetailsFromGPS**](CardDigitalizationDetailsFromGPS.md) |  | [optional] 
+**status** | **Integer** |  | [optional] 
+**created_date** | **String** |  | [optional] 
+**modified_date** | **String** |  | [optional] 
+
+

data/docs/CardDigitalizationDetailsFromGPS.md

@@ -0,0 +1,40 @@
+# TreezorClient::CardDigitalizationDetailsFromGPS
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**creator** | **String** | Creator Name | [optional] 
+**creator_pan_ref** | **String** | Digitiser's (i.e. who created this payment_token) unique ref to the linkedcard | [optional] 
+**creator_token_ref** | **String** | See internal documentation | [optional] 
+**pant** | **String** | PAN for the Card linked to the MDES card | [optional] 
+**payment_token** | **String** | PaymentToken DPAN for MDES Card | [optional] 
+**payment_token_exp_date** | **String** | Expiry date of payment token | [optional] 
+**payment_token_id** | **String** | PaymentToken Id for MDES card | [optional] 
+**payment_token_type** | **String** | See Appendix LL | [optional] 
+**gps_status** | **String** | This is the GPS set status of the token for transacting | [optional] 
+**tokenised_datetime** | **String** | date/time yyyy-mm-dd hh:mm:ss when tokenise | [optional] 
+**tokenised_status** | **String** | Has this Payment Token been digitised/personalised ? U=unknown 0=not-tokenised 1=tokenised | [optional] 
+**txn_status** | **String** | Status of token for transacting. After tokenisation, this is not changed by GPS, but is received from token creator who maintains this. | [optional] 
+**txn_status_actor** | **String** | This says who/which-system was the last to change txn_status | [optional] 
+**txn_status_change_datetime** | **String** | Date/time that txn_status was last changed | [optional] 
+**accepted_terms_version** | **String** | Version of the terms and conditions which were accepted by the cardholder.(As received from network) | [optional] 
+**auth_datetime** | **String** | date/time yyyy-mm-dd hh:mm:ss when token authorisation (to digitise/personalise) request last responded to | [optional] 
+**auth_decision** | **String** | Final tokenisation decision - Values U=unknown (not tested) 0=Approve digitisation request A=Approve digitisation request (with additional authentication) | [optional] 
+**auth_rspsrc** | **String** | who approved tokenisation | [optional] 
+**auth_status** | **String** | Status of the authorisation given to Digitise/personalise this Payment Token note not related to transaction authorisation Values U=unknown (not tested) 0=Approve digitisation request A=Approve digitisation request (with additional authentication) 1=decline digitisation request | [optional] 
+**digitisation_ref** | **String** | Unique (per payment_token_issuer_id) reference which all digitisation messageswill use, to link them together | [optional] 
+**activation_code** | **String** | Activation code to be sent directly to cardholder to activate this Payment Token | [optional] 
+**activation_code_expdate** | **String** | Date/time yyyy-mm-dd hh:mm:ss when activation code expires, in GMT (UTC) | [optional] 
+**activation_method** | **String** | Which Activation Method wa used 0 - None 1 - SMS to mobile phone 2 - Email 3 - Cardholder to call automated call centre 4 - Cardholder to call human call centre 5 - Website 6 - Mobile application 7 - Voice phone call | [optional] 
+**device_id** | **String** | unique ID of the secure element in the device | [optional] 
+**device_ip** | **String** | IP address (full or last part only) of the device at digitisation time | [optional] 
+**device_lang2** | **String** | Device language code as ISO 639-1 (2 letter lowercase) code | [optional] 
+**device_latitude** | **String** | Device Latitude in degrees at time of digitisation request -180 to +180 +ve=East, -ve=West (of Greenwich) eg  176.2 => East 176.2 degrees,- 98.5 => West 98.5 degrees | [optional] 
+**device_longitude** | **String** | Longitude as above | [optional] 
+**device_name** | **String** | name cardholder assigned to device in Wallet | [optional] 
+**device_tel_num** | **String** | Device telephone number (full or last part only) | [optional] 
+**device_type** | **String** | Not described | [optional] 
+**first_name** | **String** | Cardholder firstname as provided by Wallet Provider during digitisation. May not be provided, or just initial. | [optional] 
+**last_name** | **String** | Cardholder last name as provided by Wallet Provider during digitisation. May not be provided, or just initial. | [optional] 
+
+

data/docs/CardDigitalizationsApi.md

@@ -0,0 +1,195 @@
+# TreezorClient::CardDigitalizationsApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**card_digitalizations_id**](CardDigitalizationsApi.md#card_digitalizations_id) | **GET** /cardDigitalizations/{id} | Get a card digitalizations based on its internal id
+[**putcard_digitalizations_id**](CardDigitalizationsApi.md#putcard_digitalizations_id) | **PUT** /cardDigitalizations/{id} | Update the status of a payment Token
+[**readcard_digitalizations**](CardDigitalizationsApi.md#readcard_digitalizations) | **GET** /cardDigitalizations | search for card digitalizations
+
+
+# **card_digitalizations_id**
+> InlineResponse2008 card_digitalizations_id(id, opts)
+
+Get a card digitalizations based on its internal id
+
+Get a card digitalizations based on its internal 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::CardDigitalizationsApi.new
+
+id = 789 # Integer | Card digitalization internal id.
+
+opts = { 
+  fields: "fields_example" # String | fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate
+}
+
+begin
+  #Get a card digitalizations based on its internal id
+  result = api_instance.card_digitalizations_id(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardDigitalizationsApi->card_digitalizations_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Card digitalization internal id. | 
+ **fields** | **String**| fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **putcard_digitalizations_id**
+> InlineResponse2008 putcard_digitalizations_id(id, status, opts)
+
+Update the status of a payment Token
+
+Update the status of a payment Token
+
+### 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::CardDigitalizationsApi.new
+
+id = 789 # Integer | Card digitalization internal id.
+
+status = 789 # Integer | The new Status for the payment Token. Possible values TODO add values here
+
+opts = { 
+  fields: "fields_example" # String | fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate
+}
+
+begin
+  #Update the status of a payment Token
+  result = api_instance.putcard_digitalizations_id(id, status, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardDigitalizationsApi->putcard_digitalizations_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Card digitalization internal id. | 
+ **status** | **Integer**| The new Status for the payment Token. Possible values TODO add values here | 
+ **fields** | **String**| fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **readcard_digitalizations**
+> InlineResponse2008 readcard_digitalizations(opts)
+
+search for card digitalizations
+
+Search for card digitalizations.
+
+### 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::CardDigitalizationsApi.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).
+  filter: "filter_example", # String | Filterable fields are : - id - externalId - cardId - status - detailsFromGPS - createdDate - modifiedDate  More info [here](https://agent.treezor.com/filterv2). 
+  fields: "fields_example" # String | fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate
+}
+
+begin
+  #search for card digitalizations
+  result = api_instance.readcard_digitalizations(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardDigitalizationsApi->readcard_digitalizations: #{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] 
+ **filter** | **String**| Filterable fields are : - id - externalId - cardId - status - detailsFromGPS - createdDate - modifiedDate  More info [here](https://agent.treezor.com/filterv2).  | [optional] 
+ **fields** | **String**| fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CardReserveApi.md

@@ -0,0 +1,201 @@
+# TreezorClient::CardReserveApi
+
+All URIs are relative to *https://sandbox.treezor.com/v1/index.php*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**card_reserve_add_to**](CardReserveApi.md#card_reserve_add_to) | **POST** /cardReserves/AddTo | add an amount to the reserved amount of a card
+[**card_reserve_check**](CardReserveApi.md#card_reserve_check) | **POST** /cardReserves/Check | check reserved amount
+[**card_reserve_get**](CardReserveApi.md#card_reserve_get) | **GET** /cardReserves/{id} | get the reserved amount of a card
+
+
+# **card_reserve_add_to**
+> Float card_reserve_add_to(opts)
+
+add an amount to the reserved amount of a card
+
+add an amount to the reserved amount of a card
+
+### 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::CardReserveApi.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://www.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://www.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://www.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://www.treezor.com/basics).
+  body: TreezorClient::Body3.new # Body3 | 
+}
+
+begin
+  #add an amount to the reserved amount of a card
+  result = api_instance.card_reserve_add_to(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardReserveApi->card_reserve_add_to: #{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://www.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://www.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://www.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://www.treezor.com/basics). | [optional] 
+ **body** | [**Body3**](Body3.md)|  | [optional] 
+
+### Return type
+
+**Float**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **card_reserve_check**
+> BOOLEAN card_reserve_check(opts)
+
+check reserved amount
+
+Check if an amount can be substract to the reserved amount
+
+### 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::CardReserveApi.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://www.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://www.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://www.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://www.treezor.com/basics).
+  body: TreezorClient::Body4.new # Body4 | 
+}
+
+begin
+  #check reserved amount
+  result = api_instance.card_reserve_check(opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardReserveApi->card_reserve_check: #{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://www.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://www.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://www.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://www.treezor.com/basics). | [optional] 
+ **body** | [**Body4**](Body4.md)|  | [optional] 
+
+### Return type
+
+**BOOLEAN**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **card_reserve_get**
+> InlineResponse2009 card_reserve_get(id, opts)
+
+get the reserved amount of a card
+
+get the reserved amount of a card
+
+### 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::CardReserveApi.new
+
+id = 789 # Integer | the cardId of the reserved amount you want to pick up
+
+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://www.treezor.com/security-authentication).
+  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://www.treezor.com/basics).
+  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://www.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://www.treezor.com/basics).
+}
+
+begin
+  #get the reserved amount of a card
+  result = api_instance.card_reserve_get(id, opts)
+  p result
+rescue TreezorClient::ApiError => e
+  puts "Exception when calling CardReserveApi->card_reserve_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| the cardId of the reserved amount you want to pick up | 
+ **access_signature** | **String**| Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://www.treezor.com/security-authentication). | [optional] 
+ **access_tag** | **String**| Access tag is used for idem potency query. More info [here](https://www.treezor.com/basics). | [optional] 
+ **access_user_id** | **Integer**| Access user's id is used for user's action restriction. More info [here](https://www.treezor.com/basics). | [optional] 
+ **access_user_ip** | **String**| Access user's ip is used for user's action restriction. More info [here](https://www.treezor.com/basics). | [optional] 
+
+### Return type
+
+[**InlineResponse2009**](InlineResponse2009.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+