Class: SwaggerClient::RefundsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/refunds_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RefundsApi

Returns a new instance of RefundsApi.



19
20
21
 
# File 'lib/swagger_client/api/refunds_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/swagger_client/api/refunds_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_and_apply_refund(body, opts = {}) ⇒ nil

Create and apply refund Creates and applies a refund per the specified parameters. On success the id of the refund is returned.

Parameters:

  • body —

    refund request details json

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/swagger_client/api/refunds_api.rb', line 27

def create_and_apply_refund(body, opts = {})
  create_and_apply_refund_with_http_info(body, opts)
  nil
end

#create_and_apply_refund_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create and apply refund Creates and applies a refund per the specified parameters. On success the id of the refund is returned.

Parameters:

  • body —

    refund request details json

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/swagger_client/api/refunds_api.rb', line 37

def create_and_apply_refund_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundsApi.create_and_apply_refund ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RefundsApi.create_and_apply_refund"
  end
  # resource path
  local_var_path = '/refunds'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#create_and_apply_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_refund_by_id(account_id, id, opts = {}) ⇒ Refund

Get refund details Get the details of the specified refund.

Parameters:

  • account_id —

    id of the account

  • id —

    id of the refund

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/swagger_client/api/refunds_api.rb', line 79

def get_refund_by_id(, id, opts = {})
  data, _status_code, _headers = get_refund_by_id_with_http_info(, id, opts)
  data
end

#get_refund_by_id_with_http_info(account_id, id, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>

Get refund details Get the details of the specified refund.

Parameters:

  • account_id —

    id of the account

  • id —

    id of the refund

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

    the optional parameters

Returns:

  • (Array<(Refund, Fixnum, Hash)>) —

    Refund data, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/swagger_client/api/refunds_api.rb', line 90

def get_refund_by_id_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundsApi.get_refund_by_id ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling RefundsApi.get_refund_by_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 RefundsApi.get_refund_by_id"
  end
  # resource path
  local_var_path = '/refunds/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'accountId'] = 

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'Refund')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#get_refund_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_refunds(account_id, opts = {}) ⇒ Array<RefundDetail>

Get refunds Get all refunds for the specified account, OR if a credit memo number is specified in addition to the account id, get the details of only that.

Parameters:

  • account_id —

    id of the account

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

    the optional parameters

Options Hash (opts):

  • :credit_memo_number (String) —

    id of a credit memo

Returns:



138
139
140
141
 
# File 'lib/swagger_client/api/refunds_api.rb', line 138

def get_refunds(, opts = {})
  data, _status_code, _headers = get_refunds_with_http_info(, opts)
  data
end

#get_refunds_with_http_info(account_id, opts = {}) ⇒ Array<(Array<RefundDetail>, Fixnum, Hash)>

Get refunds Get all refunds for the specified account, OR if a credit memo number is specified in addition to the account id, get the details of only that.

Parameters:

  • account_id —

    id of the account

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

    the optional parameters

Options Hash (opts):

  • :credit_memo_number (String) —

    id of a credit memo

Returns:

  • (Array<(Array<RefundDetail>, Fixnum, Hash)>) —

    Array<RefundDetail> data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/swagger_client/api/refunds_api.rb', line 149

def get_refunds_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundsApi.get_refunds ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling RefundsApi.get_refunds"
  end
  # resource path
  local_var_path = '/refunds'

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'Array<RefundDetail>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#get_refunds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end