Class: TreezorClient::PayoutRefundsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/treezor_client/api/payout_refunds_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayoutRefundsApi

Returns a new instance of PayoutRefundsApi.


19
20
21
# File 'lib/treezor_client/api/payout_refunds_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.


17
18
19
# File 'lib/treezor_client/api/payout_refunds_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_payout_refunds(opts = {}) ⇒ InlineResponse20020

search pay outs refund Get pay out refund that match search criteria.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user's id is used for user's action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user's ip is used for user's action restriction. More info [here](agent.treezor.com/basics).

  • :id (Integer)

    PayoutRefund id

  • :tag (String)

    PayoutRefund tag

  • :code_status (String)

    PayoutRefund Code Status

  • :information_status (String)

    PayoutRefund Information Status

  • :payout_id (Integer)

    Payout Id

  • :page_number (Integer)

    The page number

Returns:


36
37
38
39
# File 'lib/treezor_client/api/payout_refunds_api.rb', line 36

def get_payout_refunds(opts = {})
  data, _status_code, _headers = get_payout_refunds_with_http_info(opts)
  data
end

#get_payout_refunds_with_http_info(opts = {}) ⇒ Array<(InlineResponse20020, Fixnum, Hash)>

search pay outs refund Get pay out refund that match search criteria.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :id (Integer)

    PayoutRefund id

  • :tag (String)

    PayoutRefund tag

  • :code_status (String)

    PayoutRefund Code Status

  • :information_status (String)

    PayoutRefund Information Status

  • :payout_id (Integer)

    Payout Id

  • :page_number (Integer)

    The page number

Returns:

  • (Array<(InlineResponse20020, Fixnum, Hash)>)

    InlineResponse20020 data, response status code and response headers


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/treezor_client/api/payout_refunds_api.rb', line 55

def get_payout_refunds_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutRefundsApi.get_payout_refunds ...'
  end
  # resource path
  local_var_path = '/payoutRefunds'

  # 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[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'codeStatus'] = opts[:'code_status'] if !opts[:'code_status'].nil?
  query_params[:'informationStatus'] = opts[:'information_status'] if !opts[:'information_status'].nil?
  query_params[:'payoutId'] = opts[:'payout_id'] if !opts[:'payout_id'].nil?
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].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 => 'InlineResponse20020')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayoutRefundsApi#get_payout_refunds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end