Class: Conekta::CustomersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomersApi

Returns a new instance of CustomersApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_customer(customer, opts = {}) ⇒ CustomerResponse

Create customer The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. Remember the credit and debit card tokenization process: [developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer)

Parameters:

  • customer (Customer) —

    requested field for customer

  • 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:



29
30
31
32
 
# File 'lib/conekta/api/customers_api.rb', line 29

def create_customer(customer, opts = {})
  data, _status_code, _headers = create_customer_with_http_info(customer, opts)
  data
end

#create_customer_fiscal_entities(id, customer_fiscal_entities_request, opts = {}) ⇒ CreateCustomerFiscalEntitiesResponse

Create Fiscal Entity Create Fiscal entity resource that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • customer_fiscal_entities_request (CustomerFiscalEntitiesRequest) —

    requested field for customer fiscal entities

  • 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:



108
109
110
111
 
# File 'lib/conekta/api/customers_api.rb', line 108

def create_customer_fiscal_entities(id, customer_fiscal_entities_request, opts = {})
  data, _status_code, _headers = create_customer_fiscal_entities_with_http_info(id, customer_fiscal_entities_request, opts)
  data
end

#create_customer_fiscal_entities_with_http_info(id, customer_fiscal_entities_request, opts = {}) ⇒ Array<(CreateCustomerFiscalEntitiesResponse, Integer, Hash)>

Create Fiscal Entity Create Fiscal entity resource that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • customer_fiscal_entities_request (CustomerFiscalEntitiesRequest) —

    requested field for customer fiscal entities

  • 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:



121
122
123
124
125
126
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
 
# File 'lib/conekta/api/customers_api.rb', line 121

def create_customer_fiscal_entities_with_http_info(id, customer_fiscal_entities_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.create_customer_fiscal_entities ...'
  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 CustomersApi.create_customer_fiscal_entities"
  end
  # verify the required parameter 'customer_fiscal_entities_request' is set
  if @api_client.config.client_side_validation && customer_fiscal_entities_request.nil?
    fail ArgumentError, "Missing the required parameter 'customer_fiscal_entities_request' when calling CustomersApi.create_customer_fiscal_entities"
  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 = '/customers/{id}/fiscal_entities'.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(customer_fiscal_entities_request)

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

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

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

#create_customer_with_http_info(customer, opts = {}) ⇒ Array<(CustomerResponse, Integer, Hash)>

Create customer The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. Remember the credit and debit card tokenization process: [developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer)

Parameters:

  • customer (Customer) —

    requested field for customer

  • 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<(CustomerResponse, Integer, Hash)>) —

    CustomerResponse data, response status code and response headers



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
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
 
# File 'lib/conekta/api/customers_api.rb', line 41

def create_customer_with_http_info(customer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.create_customer ...'
  end
  # verify the required parameter 'customer' is set
  if @api_client.config.client_side_validation && customer.nil?
    fail ArgumentError, "Missing the required parameter 'customer' when calling CustomersApi.create_customer"
  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 = '/customers'

  # 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(customer)

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

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

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

#delete_customer_by_id(id, opts = {}) ⇒ CustomerResponse

Delete Customer Deleted a customer resource that corresponds to a customer ID.

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.

Returns:



191
192
193
194
 
# File 'lib/conekta/api/customers_api.rb', line 191

def delete_customer_by_id(id, opts = {})
  data, _status_code, _headers = delete_customer_by_id_with_http_info(id, opts)
  data
end

#delete_customer_by_id_with_http_info(id, opts = {}) ⇒ Array<(CustomerResponse, Integer, Hash)>

Delete Customer Deleted a customer resource that corresponds to a customer ID.

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.

Returns:

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

    CustomerResponse data, response status code and response headers



203
204
205
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
 
# File 'lib/conekta/api/customers_api.rb', line 203

def delete_customer_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.delete_customer_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 CustomersApi.delete_customer_by_id"
  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 = '/customers/{id}'.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'])
  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] || 'CustomerResponse'

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

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

#get_customer_by_id(id, opts = {}) ⇒ CustomerResponse

Get Customer Gets a customer resource that corresponds to a customer ID.

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.

Returns:



264
265
266
267
 
# File 'lib/conekta/api/customers_api.rb', line 264

def get_customer_by_id(id, opts = {})
  data, _status_code, _headers = get_customer_by_id_with_http_info(id, opts)
  data
end

#get_customer_by_id_with_http_info(id, opts = {}) ⇒ Array<(CustomerResponse, Integer, Hash)>

Get Customer Gets a customer resource that corresponds to a customer ID.

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.

Returns:

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

    CustomerResponse data, response status code and response headers



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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/conekta/api/customers_api.rb', line 276

def get_customer_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.get_customer_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 CustomersApi.get_customer_by_id"
  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 = '/customers/{id}'.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'])
  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] || 'CustomerResponse'

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

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

#get_customers(opts = {}) ⇒ CustomersResponse

Get a list of customers The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.

Parameters:

  • 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:



340
341
342
343
 
# File 'lib/conekta/api/customers_api.rb', line 340

def get_customers(opts = {})
  data, _status_code, _headers = get_customers_with_http_info(opts)
  data
end

#get_customers_with_http_info(opts = {}) ⇒ Array<(CustomersResponse, Integer, Hash)>

Get a list of customers The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.

Parameters:

  • 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:

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

    CustomersResponse data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
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
 
# File 'lib/conekta/api/customers_api.rb', line 355

def get_customers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.get_customers ...'
  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 CustomersApi.get_customers, 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 CustomersApi.get_customers, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/customers'

  # 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] || 'CustomersResponse'

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

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

#update_customer(id, update_customer, opts = {}) ⇒ CustomerResponse

Update customer You can update customer-related data

Parameters:

  • id (String) —

    Identifier of the resource

  • update_customer (UpdateCustomer) —

    requested field for customer

  • 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:



425
426
427
428
 
# File 'lib/conekta/api/customers_api.rb', line 425

def update_customer(id, update_customer, opts = {})
  data, _status_code, _headers = update_customer_with_http_info(id, update_customer, opts)
  data
end

#update_customer_fiscal_entities(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts = {}) ⇒ UpdateCustomerFiscalEntitiesResponse

Update Fiscal Entity Update Fiscal Entity resource that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • fiscal_entities_id (String) —

    identifier

  • customer_update_fiscal_entities_request (CustomerUpdateFiscalEntitiesRequest) —

    requested field for customer update fiscal entities

  • 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:



510
511
512
513
 
# File 'lib/conekta/api/customers_api.rb', line 510

def update_customer_fiscal_entities(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts = {})
  data, _status_code, _headers = update_customer_fiscal_entities_with_http_info(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts)
  data
end

#update_customer_fiscal_entities_with_http_info(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts = {}) ⇒ Array<(UpdateCustomerFiscalEntitiesResponse, Integer, Hash)>

Update Fiscal Entity Update Fiscal Entity resource that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • fiscal_entities_id (String) —

    identifier

  • customer_update_fiscal_entities_request (CustomerUpdateFiscalEntitiesRequest) —

    requested field for customer update fiscal entities

  • 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:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/conekta/api/customers_api.rb', line 524

def update_customer_fiscal_entities_with_http_info(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.update_customer_fiscal_entities ...'
  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 CustomersApi.update_customer_fiscal_entities"
  end
  # verify the required parameter 'fiscal_entities_id' is set
  if @api_client.config.client_side_validation && fiscal_entities_id.nil?
    fail ArgumentError, "Missing the required parameter 'fiscal_entities_id' when calling CustomersApi.update_customer_fiscal_entities"
  end
  # verify the required parameter 'customer_update_fiscal_entities_request' is set
  if @api_client.config.client_side_validation && customer_update_fiscal_entities_request.nil?
    fail ArgumentError, "Missing the required parameter 'customer_update_fiscal_entities_request' when calling CustomersApi.update_customer_fiscal_entities"
  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 = '/customers/{id}/fiscal_entities/{fiscal_entities_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'fiscal_entities_id' + '}', CGI.escape(fiscal_entities_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(customer_update_fiscal_entities_request)

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

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

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

#update_customer_with_http_info(id, update_customer, opts = {}) ⇒ Array<(CustomerResponse, Integer, Hash)>

Update customer You can update customer-related data

Parameters:

  • id (String) —

    Identifier of the resource

  • update_customer (UpdateCustomer) —

    requested field for customer

  • 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<(CustomerResponse, Integer, Hash)>) —

    CustomerResponse data, response status code and response headers



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/conekta/api/customers_api.rb', line 438

def update_customer_with_http_info(id, update_customer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.update_customer ...'
  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 CustomersApi.update_customer"
  end
  # verify the required parameter 'update_customer' is set
  if @api_client.config.client_side_validation && update_customer.nil?
    fail ArgumentError, "Missing the required parameter 'update_customer' when calling CustomersApi.update_customer"
  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 = '/customers/{id}'.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(update_customer)

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

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

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