class TreezorClient::CardDigitalizationsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/treezor_client/api/card_digitalizations_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

card_digitalizations_id(id, opts = {}) click to toggle source

Get a card digitalizations based on its internal id Get a card digitalizations based on its internal id @param id Card digitalization internal id. @param [Hash] opts the optional parameters @option opts [String] :fields fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate @return [InlineResponse2007]

# File lib/treezor_client/api/card_digitalizations_api.rb, line 28
def card_digitalizations_id(id, opts = {})
  data, _status_code, _headers = card_digitalizations_id_with_http_info(id, opts)
  data
end
card_digitalizations_id_with_http_info(id, opts = {}) click to toggle source

Get a card digitalizations based on its internal id Get a card digitalizations based on its internal id @param id Card digitalization internal id. @param [Hash] opts the optional parameters @option opts [String] :fields fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers

# File lib/treezor_client/api/card_digitalizations_api.rb, line 39
def card_digitalizations_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardDigitalizationsApi.card_digitalizations_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CardDigitalizationsApi.card_digitalizations_id"
  end
  # resource path
  local_var_path = '/cardDigitalizations/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardDigitalizationsApi#card_digitalizations_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
deletecard_digitalizations_id(id, reason_code, opts = {}) click to toggle source

Deletes a payment Token Deletes a payment Token @param id Card digitalization internal id. @param reason_code The reason code for the action. Possible values are : | Reason code | Description | | —- | ———– | | L | Cardholder confirmed token device lost | | S | Cardholder confirmed token device stolen | | F | Issuer or cardholder confirmed fraudulent token transactions (Deprecated) | | T | Issuer or cardholder confirmed fraudulent token transactions | | C | Account closed | | Z | Other | @param [Hash] opts the optional parameters @return [InlineResponse2007]

# File lib/treezor_client/api/card_digitalizations_api.rb, line 85
def deletecard_digitalizations_id(id, reason_code, opts = {})
  data, _status_code, _headers = deletecard_digitalizations_id_with_http_info(id, reason_code, opts)
  data
end
deletecard_digitalizations_id_with_http_info(id, reason_code, opts = {}) click to toggle source

Deletes a payment Token Deletes a payment Token @param id Card digitalization internal id. @param reason_code The reason code for the action. Possible values are : | Reason code | Description | | —- | ———– | | L | Cardholder confirmed token device lost | | S | Cardholder confirmed token device stolen | | F | Issuer or cardholder confirmed fraudulent token transactions (Deprecated) | | T | Issuer or cardholder confirmed fraudulent token transactions | | C | Account closed | | Z | Other | @param [Hash] opts the optional parameters @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers

# File lib/treezor_client/api/card_digitalizations_api.rb, line 96
def deletecard_digitalizations_id_with_http_info(id, reason_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardDigitalizationsApi.deletecard_digitalizations_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CardDigitalizationsApi.deletecard_digitalizations_id"
  end
  # verify the required parameter 'reason_code' is set
  if @api_client.config.client_side_validation && reason_code.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code' when calling CardDigitalizationsApi.deletecard_digitalizations_id"
  end
  # resource path
  local_var_path = '/cardDigitalizations/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'reasonCode'] = reason_code

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardDigitalizationsApi#deletecard_digitalizations_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
putcard_digitalizations_id(id, status, reason_code, opts = {}) click to toggle source

Update the status of a payment Token Update the status of a payment Token @param id Card digitalization internal id. @param status The new status for the payment Token. Possible values are : | Status | Description | | —- | ———– | | unsuspend | Unsuspend | | suspend | Suspend | @param reason_code The reason code for the action. Possible values are : - For a suspension : | Reason code | Description | | —- | ———– | | L | Cardholder confirmed token device lost | | S | Cardholder confirmed token device stolen | | T | Issuer or cardholder confirmed fraudulent token transactions | | Z | Other | - For an unsuspension : | Reason code | Description | | —- | ———– | | F | Cardholder reported token device found or not stolen | | T | Issuer or cardholder confirmed no fraudulent token transactions | | Z | Other | @param [Hash] opts the optional parameters @return [InlineResponse2007]

# File lib/treezor_client/api/card_digitalizations_api.rb, line 147
def putcard_digitalizations_id(id, status, reason_code, opts = {})
  data, _status_code, _headers = putcard_digitalizations_id_with_http_info(id, status, reason_code, opts)
  data
end
putcard_digitalizations_id_with_http_info(id, status, reason_code, opts = {}) click to toggle source

Update the status of a payment Token Update the status of a payment Token @param id Card digitalization internal id. @param status The new status for the payment Token. Possible values are : | Status | Description | | —- | ———– | | unsuspend | Unsuspend | | suspend | Suspend | @param reason_code The reason code for the action. Possible values are : - For a suspension : | Reason code | Description | | —- | ———– | | L | Cardholder confirmed token device lost | | S | Cardholder confirmed token device stolen | | T | Issuer or cardholder confirmed fraudulent token transactions | | Z | Other | - For an unsuspension : | Reason code | Description | | —- | ———– | | F | Cardholder reported token device found or not stolen | | T | Issuer or cardholder confirmed no fraudulent token transactions | | Z | Other | @param [Hash] opts the optional parameters @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers

# File lib/treezor_client/api/card_digitalizations_api.rb, line 159
def putcard_digitalizations_id_with_http_info(id, status, reason_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardDigitalizationsApi.putcard_digitalizations_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CardDigitalizationsApi.putcard_digitalizations_id"
  end
  # verify the required parameter 'status' is set
  if @api_client.config.client_side_validation && status.nil?
    fail ArgumentError, "Missing the required parameter 'status' when calling CardDigitalizationsApi.putcard_digitalizations_id"
  end
  # verify the required parameter 'reason_code' is set
  if @api_client.config.client_side_validation && reason_code.nil?
    fail ArgumentError, "Missing the required parameter 'reason_code' when calling CardDigitalizationsApi.putcard_digitalizations_id"
  end
  # resource path
  local_var_path = '/cardDigitalizations/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'status'] = status
  query_params[:'reasonCode'] = reason_code

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardDigitalizationsApi#putcard_digitalizations_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
readcard_digitalizations(opts = {}) click to toggle source

search for card digitalizations Search for card digitalizations. @param [Hash] opts the optional parameters @option opts [String] :access_signature Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication). @option opts [String] :access_tag Access tag is used for idem potency query. More info [here](agent.treezor.com/basics). @option opts [Integer] :access_user_id Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics). @option opts [String] :access_user_ip Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics). @option opts [String] :filter Filterable fields are : - id - externalId - cardId - status - detailsFromGPS - createdDate - modifiedDate More info [here](agent.treezor.com/filterv2). @option opts [String] :fields fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate @return [InlineResponse2007]

# File lib/treezor_client/api/card_digitalizations_api.rb, line 218
def readcard_digitalizations(opts = {})
  data, _status_code, _headers = readcard_digitalizations_with_http_info(opts)
  data
end
readcard_digitalizations_with_http_info(opts = {}) click to toggle source

search for card digitalizations Search for card digitalizations. @param [Hash] opts the optional parameters @option opts [String] :access_signature Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication). @option opts [String] :access_tag Access tag is used for idem potency query. More info [here](agent.treezor.com/basics). @option opts [Integer] :access_user_id Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics). @option opts [String] :access_user_ip Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics). @option opts [String] :filter Filterable fields are : - id - externalId - cardId - status - detailsFromGPS - createdDate - modifiedDate More info [here](agent.treezor.com/filterv2). @option opts [String] :fields fields to output separated by commas. Possible fields are id, externalId, cardId, detailsFromGPS, status, createdDate, modifiedDate @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers

# File lib/treezor_client/api/card_digitalizations_api.rb, line 233
def readcard_digitalizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardDigitalizationsApi.readcard_digitalizations ...'
  end
  # resource path
  local_var_path = '/cardDigitalizations'

  # query parameters
  query_params = {}
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'accessTag'] = opts[:'access_tag'] if !opts[:'access_tag'].nil?
  query_params[:'accessUserId'] = opts[:'access_user_id'] if !opts[:'access_user_id'].nil?
  query_params[:'accessUserIp'] = opts[:'access_user_ip'] if !opts[:'access_user_ip'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardDigitalizationsApi#readcard_digitalizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end