Class: Conekta::DiscountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/conekta/api/discounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DiscountsApi

Returns a new instance of DiscountsApi.



19
20
21
# File 'lib/conekta/api/discounts_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/conekta/api/discounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#orders_create_discount_line(id, order_discount_lines_request, opts = {}) ⇒ DiscountLinesResponse

Create Discount Create discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • order_discount_lines_request (OrderDiscountLinesRequest)

    requested field for a discount lines

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



30
31
32
33
# File 'lib/conekta/api/discounts_api.rb', line 30

def orders_create_discount_line(id, order_discount_lines_request, opts = {})
  data, _status_code, _headers = orders_create_discount_line_with_http_info(id, order_discount_lines_request, opts)
  data
end

#orders_create_discount_line_with_http_info(id, order_discount_lines_request, opts = {}) ⇒ Array<(DiscountLinesResponse, Integer, Hash)>

Create Discount Create discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • order_discount_lines_request (OrderDiscountLinesRequest)

    requested field for a discount lines

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:

  • (Array<(DiscountLinesResponse, Integer, Hash)>)

    DiscountLinesResponse data, response status code and response headers



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
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
100
101
102
103
104
# File 'lib/conekta/api/discounts_api.rb', line 43

def orders_create_discount_line_with_http_info(id, order_discount_lines_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.orders_create_discount_line ...'
  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 DiscountsApi.orders_create_discount_line"
  end
  # verify the required parameter 'order_discount_lines_request' is set
  if @api_client.config.client_side_validation && order_discount_lines_request.nil?
    fail ArgumentError, "Missing the required parameter 'order_discount_lines_request' when calling DiscountsApi.orders_create_discount_line"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/orders/{id}/discount_lines'.sub('{' + 'id' + '}', CGI.escape(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/vnd.conekta-v2.1.0+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"DiscountsApi.orders_create_discount_line",
    :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: DiscountsApi#orders_create_discount_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_delete_discount_lines(id, discount_lines_id, opts = {}) ⇒ DiscountLinesResponse

Delete Discount Delete an existing discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • discount_lines_id (String)

    discount line id identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



114
115
116
117
# File 'lib/conekta/api/discounts_api.rb', line 114

def orders_delete_discount_lines(id, discount_lines_id, opts = {})
  data, _status_code, _headers = orders_delete_discount_lines_with_http_info(id, discount_lines_id, opts)
  data
end

#orders_delete_discount_lines_with_http_info(id, discount_lines_id, opts = {}) ⇒ Array<(DiscountLinesResponse, Integer, Hash)>

Delete Discount Delete an existing discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • discount_lines_id (String)

    discount line id identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:

  • (Array<(DiscountLinesResponse, Integer, Hash)>)

    DiscountLinesResponse data, response status code and response headers



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
# File 'lib/conekta/api/discounts_api.rb', line 127

def orders_delete_discount_lines_with_http_info(id, discount_lines_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.orders_delete_discount_lines ...'
  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 DiscountsApi.orders_delete_discount_lines"
  end
  # verify the required parameter 'discount_lines_id' is set
  if @api_client.config.client_side_validation && discount_lines_id.nil?
    fail ArgumentError, "Missing the required parameter 'discount_lines_id' when calling DiscountsApi.orders_delete_discount_lines"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/orders/{id}/discount_lines/{discount_lines_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'discount_lines_id' + '}', CGI.escape(discount_lines_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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"DiscountsApi.orders_delete_discount_lines",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DiscountsApi#orders_delete_discount_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_get_discount_line(id, discount_lines_id, opts = {}) ⇒ DiscountLinesResponse

Get Discount Get an existing discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • discount_lines_id (String)

    discount line id identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



193
194
195
196
# File 'lib/conekta/api/discounts_api.rb', line 193

def orders_get_discount_line(id, discount_lines_id, opts = {})
  data, _status_code, _headers = orders_get_discount_line_with_http_info(id, discount_lines_id, opts)
  data
end

#orders_get_discount_line_with_http_info(id, discount_lines_id, opts = {}) ⇒ Array<(DiscountLinesResponse, Integer, Hash)>

Get Discount Get an existing discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • discount_lines_id (String)

    discount line id identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:

  • (Array<(DiscountLinesResponse, Integer, Hash)>)

    DiscountLinesResponse data, response status code and response headers



206
207
208
209
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
253
254
255
256
257
258
259
260
261
262
# File 'lib/conekta/api/discounts_api.rb', line 206

def orders_get_discount_line_with_http_info(id, discount_lines_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.orders_get_discount_line ...'
  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 DiscountsApi.orders_get_discount_line"
  end
  # verify the required parameter 'discount_lines_id' is set
  if @api_client.config.client_side_validation && discount_lines_id.nil?
    fail ArgumentError, "Missing the required parameter 'discount_lines_id' when calling DiscountsApi.orders_get_discount_line"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/orders/{id}/discount_lines/{discount_lines_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'discount_lines_id' + '}', CGI.escape(discount_lines_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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"DiscountsApi.orders_get_discount_line",
    :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: DiscountsApi#orders_get_discount_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_get_discount_lines(id, opts = {}) ⇒ GetOrderDiscountLinesResponse

Get a List of Discount Get discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

  • :limit (Integer)

    The numbers of items to return, the maximum value is 250 (default to 20)

  • :search (String)

    General order search, e.g. by mail, reference etc.

  • :_next (String)

    next page

  • :previous (String)

    previous page

Returns:



275
276
277
278
# File 'lib/conekta/api/discounts_api.rb', line 275

def orders_get_discount_lines(id, opts = {})
  data, _status_code, _headers = orders_get_discount_lines_with_http_info(id, opts)
  data
end

#orders_get_discount_lines_with_http_info(id, opts = {}) ⇒ Array<(GetOrderDiscountLinesResponse, Integer, Hash)>

Get a List of Discount Get discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

  • :limit (Integer)

    The numbers of items to return, the maximum value is 250 (default to 20)

  • :search (String)

    General order search, e.g. by mail, reference etc.

  • :_next (String)

    next page

  • :previous (String)

    previous page

Returns:



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
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
# File 'lib/conekta/api/discounts_api.rb', line 291

def orders_get_discount_lines_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.orders_get_discount_lines ...'
  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 DiscountsApi.orders_get_discount_lines"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DiscountsApi.orders_get_discount_lines, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DiscountsApi.orders_get_discount_lines, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/orders/{id}/discount_lines'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
  query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"DiscountsApi.orders_get_discount_lines",
    :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: DiscountsApi#orders_get_discount_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_update_discount_lines(id, discount_lines_id, update_order_discount_lines_request, opts = {}) ⇒ DiscountLinesResponse

Update Discount Update an existing discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • discount_lines_id (String)

    discount line id identifier

  • update_order_discount_lines_request (UpdateOrderDiscountLinesRequest)

    requested field for a discount lines

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



366
367
368
369
# File 'lib/conekta/api/discounts_api.rb', line 366

def orders_update_discount_lines(id, discount_lines_id, update_order_discount_lines_request, opts = {})
  data, _status_code, _headers = orders_update_discount_lines_with_http_info(id, discount_lines_id, update_order_discount_lines_request, opts)
  data
end

#orders_update_discount_lines_with_http_info(id, discount_lines_id, update_order_discount_lines_request, opts = {}) ⇒ Array<(DiscountLinesResponse, Integer, Hash)>

Update Discount Update an existing discount lines for an existing orden

Parameters:

  • id (String)

    Identifier of the resource

  • discount_lines_id (String)

    discount line id identifier

  • update_order_discount_lines_request (UpdateOrderDiscountLinesRequest)

    requested field for a discount lines

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String)

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:

  • (Array<(DiscountLinesResponse, Integer, Hash)>)

    DiscountLinesResponse data, response status code and response headers



380
381
382
383
384
385
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
# File 'lib/conekta/api/discounts_api.rb', line 380

def orders_update_discount_lines_with_http_info(id, discount_lines_id, update_order_discount_lines_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiscountsApi.orders_update_discount_lines ...'
  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 DiscountsApi.orders_update_discount_lines"
  end
  # verify the required parameter 'discount_lines_id' is set
  if @api_client.config.client_side_validation && discount_lines_id.nil?
    fail ArgumentError, "Missing the required parameter 'discount_lines_id' when calling DiscountsApi.orders_update_discount_lines"
  end
  # verify the required parameter 'update_order_discount_lines_request' is set
  if @api_client.config.client_side_validation && update_order_discount_lines_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_order_discount_lines_request' when calling DiscountsApi.orders_update_discount_lines"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/orders/{id}/discount_lines/{discount_lines_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'discount_lines_id' + '}', CGI.escape(discount_lines_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/vnd.conekta-v2.1.0+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"DiscountsApi.orders_update_discount_lines",
    :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: DiscountsApi#orders_update_discount_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end