class PolarAccesslinkApiGem::PhysicalInfoApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

commit_physical_info_transaction(transaction_id, user_id, opts = {}) click to toggle source

Commit transaction After successfully retrieving physical information within a transaction, partners are expected to commit the transaction. @param transaction_id [Integer] Transaction identifier @param user_id [Integer] User identifier @param [Hash] opts the optional parameters @return [nil]

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 28
def commit_physical_info_transaction(transaction_id, user_id, opts = {})
  commit_physical_info_transaction_with_http_info(transaction_id, user_id, opts)
  nil
end
commit_physical_info_transaction_with_http_info(transaction_id, user_id, opts = {}) click to toggle source

Commit transaction After successfully retrieving physical information within a transaction, partners are expected to commit the transaction. @param transaction_id [Integer] Transaction identifier @param user_id [Integer] User identifier @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 39
def commit_physical_info_transaction_with_http_info(transaction_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.commit_physical_info_transaction ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PhysicalInfoApi.commit_physical_info_transaction"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.commit_physical_info_transaction"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions/{transaction-id}'.sub('{' + 'transaction-id' + '}', CGI.escape(transaction_id.to_s)).sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"PhysicalInfoApi.commit_physical_info_transaction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhysicalInfoApi#commit_physical_info_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_physical_info_transaction(user_id, opts = {}) click to toggle source

Create transaction Initiate physical info transaction. Check for new physical info and create a new transaction if found. @param user_id [Integer] User identifier @param [Hash] opts the optional parameters @return [TransactionLocation]

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 94
def create_physical_info_transaction(user_id, opts = {})
  data, _status_code, _headers = create_physical_info_transaction_with_http_info(user_id, opts)
  data
end
create_physical_info_transaction_with_http_info(user_id, opts = {}) click to toggle source

Create transaction Initiate physical info transaction. Check for new physical info and create a new transaction if found. @param user_id [Integer] User identifier @param [Hash] opts the optional parameters @return [Array<(TransactionLocation, Integer, Hash)>] TransactionLocation data, response status code and response headers

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 104
def create_physical_info_transaction_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.create_physical_info_transaction ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.create_physical_info_transaction"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions'.sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionLocation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"PhysicalInfoApi.create_physical_info_transaction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhysicalInfoApi#create_physical_info_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_physical_info(user_id, transaction_id, physical_info_id, opts = {}) click to toggle source

Get physical info Get physical info entity data @param user_id [Integer] User identifier @param transaction_id [Integer] Transaction identifier @param physical_info_id [Integer] Physical information identifier @param [Hash] opts the optional parameters @return [PhysicalInformation]

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 159
def get_physical_info(user_id, transaction_id, physical_info_id, opts = {})
  data, _status_code, _headers = get_physical_info_with_http_info(user_id, transaction_id, physical_info_id, opts)
  data
end
get_physical_info_with_http_info(user_id, transaction_id, physical_info_id, opts = {}) click to toggle source

Get physical info Get physical info entity data @param user_id [Integer] User identifier @param transaction_id [Integer] Transaction identifier @param physical_info_id [Integer] Physical information identifier @param [Hash] opts the optional parameters @return [Array<(PhysicalInformation, Integer, Hash)>] PhysicalInformation data, response status code and response headers

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 171
def get_physical_info_with_http_info(user_id, transaction_id, physical_info_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.get_physical_info ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.get_physical_info"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PhysicalInfoApi.get_physical_info"
  end
  # verify the required parameter 'physical_info_id' is set
  if @api_client.config.client_side_validation && physical_info_id.nil?
    fail ArgumentError, "Missing the required parameter 'physical_info_id' when calling PhysicalInfoApi.get_physical_info"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id}'.sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'transaction-id' + '}', CGI.escape(transaction_id.to_s)).sub('{' + 'physical-info-id' + '}', CGI.escape(physical_info_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PhysicalInformation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"PhysicalInfoApi.get_physical_info",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhysicalInfoApi#get_physical_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_physical_infos(transaction_id, user_id, opts = {}) click to toggle source

List physical infos List new physical info data. After successfully initiating a transaction, physical infos included within it can be retrieved with the provided transactionId. @param transaction_id [Integer] Transaction identifier @param user_id [Integer] User identifier @param [Hash] opts the optional parameters @return [PhysicalInformations]

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 233
def list_physical_infos(transaction_id, user_id, opts = {})
  data, _status_code, _headers = list_physical_infos_with_http_info(transaction_id, user_id, opts)
  data
end
list_physical_infos_with_http_info(transaction_id, user_id, opts = {}) click to toggle source

List physical infos List new physical info data. After successfully initiating a transaction, physical infos included within it can be retrieved with the provided transactionId. @param transaction_id [Integer] Transaction identifier @param user_id [Integer] User identifier @param [Hash] opts the optional parameters @return [Array<(PhysicalInformations, Integer, Hash)>] PhysicalInformations data, response status code and response headers

# File lib/polar-accesslink-api-gem/api/physical_info_api.rb, line 244
def list_physical_infos_with_http_info(transaction_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.list_physical_infos ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PhysicalInfoApi.list_physical_infos"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.list_physical_infos"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions/{transaction-id}'.sub('{' + 'transaction-id' + '}', CGI.escape(transaction_id.to_s)).sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PhysicalInformations'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"PhysicalInfoApi.list_physical_infos",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhysicalInfoApi#list_physical_infos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end