Class: SezzleClient::OrderApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sezzle_client/api/order_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrderApi

Returns a new instance of OrderApi.



16
17
18
 
# File 'lib/sezzle_client/api/order_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/sezzle_client/api/order_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_v2_order(order_uuid, opts = {}) ⇒ InlineResponse2001

Get order details

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/sezzle_client/api/order_api.rb', line 23

def get_v2_order(order_uuid, opts = {})
  data, _status_code, _headers = get_v2_order_with_http_info(order_uuid, opts)
  data
end

#get_v2_order_with_http_info(order_uuid, opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>

Get order details

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2001, Integer, Hash)>) —

    InlineResponse2001 data, response status code and response headers



32
33
34
35
36
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/sezzle_client/api/order_api.rb', line 32

def get_v2_order_with_http_info(order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.get_v2_order ...'
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.get_v2_order"
  end
  # resource path
  local_var_path = '/order/{order_uuid}'.sub('{' + 'order_uuid' + '}', order_uuid.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'])

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

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

  return_type = opts[:return_type] || 'InlineResponse2001'

  auth_names = opts[:auth_names] || ['Bearer']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#get_v2_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_v2_checkout(body, order_uuid, opts = {}) ⇒ nil

Update order

Parameters:

  • body —

    Session request

  • order_uuid —

    Order UUID

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

    the optional parameters

Returns:

  • (nil) 


78
79
80
81
 
# File 'lib/sezzle_client/api/order_api.rb', line 78

def patch_v2_checkout(body, order_uuid, opts = {})
  patch_v2_checkout_with_http_info(body, order_uuid, opts)
  nil
end

#patch_v2_checkout_with_http_info(body, order_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update order

Parameters:

  • body —

    Session request

  • order_uuid —

    Order UUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



88
89
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
132
133
134
 
# File 'lib/sezzle_client/api/order_api.rb', line 88

def patch_v2_checkout_with_http_info(body, order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.patch_v2_checkout ...'
  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 OrderApi.patch_v2_checkout"
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.patch_v2_checkout"
  end
  # resource path
  local_var_path = '/order/{order_uuid}'.sub('{' + 'order_uuid' + '}', order_uuid.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || ['Bearer']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#patch_v2_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_capture_by_order(order_uuid, opts = {}) ⇒ InlineResponse2006

Capture amount by order

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Body3) —

    Capture request

Returns:



140
141
142
143
 
# File 'lib/sezzle_client/api/order_api.rb', line 140

def post_v2_capture_by_order(order_uuid, opts = {})
  data, _status_code, _headers = post_v2_capture_by_order_with_http_info(order_uuid, opts)
  data
end

#post_v2_capture_by_order_with_http_info(order_uuid, opts = {}) ⇒ Array<(InlineResponse2006, Integer, Hash)>

Capture amount by order

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Body3) —

    Capture request

Returns:

  • (Array<(InlineResponse2006, Integer, Hash)>) —

    InlineResponse2006 data, response status code and response headers



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
188
189
190
191
192
 
# File 'lib/sezzle_client/api/order_api.rb', line 150

def post_v2_capture_by_order_with_http_info(order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.post_v2_capture_by_order ...'
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.post_v2_capture_by_order"
  end
  # resource path
  local_var_path = '/order/{order_uuid}/capture'.sub('{' + 'order_uuid' + '}', order_uuid.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'InlineResponse2006'

  auth_names = opts[:auth_names] || ['Bearer']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#post_v2_capture_by_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_reauthorize_by_order(order_uuid, opts = {}) ⇒ InlineResponse2007

Reauthorize amount by order ### DEVELOPER PREVIEW *This API is subject to change and limited to select merchants. Bug fixes and new features will be released based on feedback throughout the preview period.* - Requires customer object on Create Session with at minimum ‘{ tokenize: true }` - Response will be a new order and its `uuid` can be used on the Order API endpoints

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Price) —

    Reauthorize request

Returns:



199
200
201
202
 
# File 'lib/sezzle_client/api/order_api.rb', line 199

def post_v2_reauthorize_by_order(order_uuid, opts = {})
  data, _status_code, _headers = post_v2_reauthorize_by_order_with_http_info(order_uuid, opts)
  data
end

#post_v2_reauthorize_by_order_with_http_info(order_uuid, opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>

Reauthorize amount by order ### DEVELOPER PREVIEW *This API is subject to change and limited to select merchants. Bug fixes and new features will be released based on feedback throughout the preview period.* - Requires customer object on Create Session with at minimum &#x60;{ tokenize: true }&#x60; - Response will be a new order and its &#x60;uuid&#x60; can be used on the Order API endpoints

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Price) —

    Reauthorize request

Returns:

  • (Array<(InlineResponse2007, Integer, Hash)>) —

    InlineResponse2007 data, response status code and response headers



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/sezzle_client/api/order_api.rb', line 210

def post_v2_reauthorize_by_order_with_http_info(order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.post_v2_reauthorize_by_order ...'
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.post_v2_reauthorize_by_order"
  end
  # resource path
  local_var_path = '/order/{order_uuid}/reauthorize'.sub('{' + 'order_uuid' + '}', order_uuid.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'InlineResponse2007'

  auth_names = opts[:auth_names] || ['Bearer']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#post_v2_reauthorize_by_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_refund_by_order(order_uuid, opts = {}) ⇒ InlineResponse2006

Refund amount by order

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Price) —

    Refund request

Returns:



258
259
260
261
 
# File 'lib/sezzle_client/api/order_api.rb', line 258

def post_v2_refund_by_order(order_uuid, opts = {})
  data, _status_code, _headers = post_v2_refund_by_order_with_http_info(order_uuid, opts)
  data
end

#post_v2_refund_by_order_with_http_info(order_uuid, opts = {}) ⇒ Array<(InlineResponse2006, Integer, Hash)>

Refund amount by order

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Price) —

    Refund request

Returns:

  • (Array<(InlineResponse2006, Integer, Hash)>) —

    InlineResponse2006 data, response status code and response headers



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/sezzle_client/api/order_api.rb', line 268

def post_v2_refund_by_order_with_http_info(order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.post_v2_refund_by_order ...'
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.post_v2_refund_by_order"
  end
  # resource path
  local_var_path = '/order/{order_uuid}/refund'.sub('{' + 'order_uuid' + '}', order_uuid.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'InlineResponse2006'

  auth_names = opts[:auth_names] || ['Bearer']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#post_v2_refund_by_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_release_by_order(order_uuid, opts = {}) ⇒ InlineResponse2006

Release amount by order

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Price) —

    Release request

Returns:



316
317
318
319
 
# File 'lib/sezzle_client/api/order_api.rb', line 316

def post_v2_release_by_order(order_uuid, opts = {})
  data, _status_code, _headers = post_v2_release_by_order_with_http_info(order_uuid, opts)
  data
end

#post_v2_release_by_order_with_http_info(order_uuid, opts = {}) ⇒ Array<(InlineResponse2006, Integer, Hash)>

Release amount by order

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Price) —

    Release request

Returns:

  • (Array<(InlineResponse2006, Integer, Hash)>) —

    InlineResponse2006 data, response status code and response headers



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/sezzle_client/api/order_api.rb', line 326

def post_v2_release_by_order_with_http_info(order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.post_v2_release_by_order ...'
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.post_v2_release_by_order"
  end
  # resource path
  local_var_path = '/order/{order_uuid}/release'.sub('{' + 'order_uuid' + '}', order_uuid.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'InlineResponse2006'

  auth_names = opts[:auth_names] || ['Bearer']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#post_v2_release_by_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_upcharge_by_order(order_uuid, opts = {}) ⇒ InlineResponse2007

Upcharge amount by order ### DEVELOPER PREVIEW *This API is subject to change and limited to select merchants. Bug fixes and new features will be released based on feedback throughout the preview period.* - This endpoint is not live and will return a ‘501 Not Implemented`

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Body4) —

    Upcharge request

Returns:



375
376
377
378
 
# File 'lib/sezzle_client/api/order_api.rb', line 375

def post_v2_upcharge_by_order(order_uuid, opts = {})
  data, _status_code, _headers = post_v2_upcharge_by_order_with_http_info(order_uuid, opts)
  data
end

#post_v2_upcharge_by_order_with_http_info(order_uuid, opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>

Upcharge amount by order ### DEVELOPER PREVIEW *This API is subject to change and limited to select merchants. Bug fixes and new features will be released based on feedback throughout the preview period.* - This endpoint is not live and will return a &#x60;501 Not Implemented&#x60;

Parameters:

  • order_uuid —

    Order UUID

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

    the optional parameters

Options Hash (opts):

  • :body (Body4) —

    Upcharge request

Returns:

  • (Array<(InlineResponse2007, Integer, Hash)>) —

    InlineResponse2007 data, response status code and response headers



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/sezzle_client/api/order_api.rb', line 386

def post_v2_upcharge_by_order_with_http_info(order_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderApi.post_v2_upcharge_by_order ...'
  end
  # verify the required parameter 'order_uuid' is set
  if @api_client.config.client_side_validation && order_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'order_uuid' when calling OrderApi.post_v2_upcharge_by_order"
  end
  # resource path
  local_var_path = '/order/{order_uuid}/upcharge'.sub('{' + 'order_uuid' + '}', order_uuid.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'InlineResponse2007'

  auth_names = opts[:auth_names] || ['Bearer']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderApi#post_v2_upcharge_by_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end