Class: Conekta::ShippingContactsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShippingContactsApi

Returns a new instance of ShippingContactsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_customer_shipping_contacts(id, customer_shipping_contacts, opts = {}) ⇒ CustomerShippingContactsResponse

Create a shipping contacts Create a shipping contacts for a customer.

Parameters:

  • id (String) —

    Identifier of the resource

  • customer_shipping_contacts (CustomerShippingContacts) —

    requested field for customer shippings contacts

  • 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/shipping_contacts_api.rb', line 30

def create_customer_shipping_contacts(id, customer_shipping_contacts, opts = {})
  data, _status_code, _headers = create_customer_shipping_contacts_with_http_info(id, customer_shipping_contacts, opts)
  data
end

#create_customer_shipping_contacts_with_http_info(id, customer_shipping_contacts, opts = {}) ⇒ Array<(CustomerShippingContactsResponse, Integer, Hash)>

Create a shipping contacts Create a shipping contacts for a customer.

Parameters:

  • id (String) —

    Identifier of the resource

  • customer_shipping_contacts (CustomerShippingContacts) —

    requested field for customer shippings contacts

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



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/shipping_contacts_api.rb', line 43

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

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

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

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

#delete_customer_shipping_contacts(id, shipping_contacts_id, opts = {}) ⇒ CustomerShippingContactsResponse

Delete shipping contacts Delete shipping contact that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_contacts_id (String) —

    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/shipping_contacts_api.rb', line 114

def delete_customer_shipping_contacts(id, shipping_contacts_id, opts = {})
  data, _status_code, _headers = delete_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, opts)
  data
end

#delete_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, opts = {}) ⇒ Array<(CustomerShippingContactsResponse, Integer, Hash)>

Delete shipping contacts Delete shipping contact that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_contacts_id (String) —

    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:



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/shipping_contacts_api.rb', line 127

def delete_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingContactsApi.delete_customer_shipping_contacts ...'
  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 ShippingContactsApi.delete_customer_shipping_contacts"
  end
  # verify the required parameter 'shipping_contacts_id' is set
  if @api_client.config.client_side_validation && shipping_contacts_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_contacts_id' when calling ShippingContactsApi.delete_customer_shipping_contacts"
  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}/shipping_contacts/{shipping_contacts_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'shipping_contacts_id' + '}', CGI.escape(shipping_contacts_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] || 'CustomerShippingContactsResponse'

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

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

#update_customer_shipping_contacts(id, shipping_contacts_id, customer_update_shipping_contacts, opts = {}) ⇒ CustomerShippingContactsResponse

Update shipping contacts Update shipping contact that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_contacts_id (String) —

    identifier

  • customer_update_shipping_contacts (CustomerUpdateShippingContacts) —

    requested field for customer update shippings contacts

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



194
195
196
197
 
# File 'lib/conekta/api/shipping_contacts_api.rb', line 194

def update_customer_shipping_contacts(id, shipping_contacts_id, customer_update_shipping_contacts, opts = {})
  data, _status_code, _headers = update_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, customer_update_shipping_contacts, opts)
  data
end

#update_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, customer_update_shipping_contacts, opts = {}) ⇒ Array<(CustomerShippingContactsResponse, Integer, Hash)>

Update shipping contacts Update shipping contact that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_contacts_id (String) —

    identifier

  • customer_update_shipping_contacts (CustomerUpdateShippingContacts) —

    requested field for customer update shippings contacts

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



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
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/conekta/api/shipping_contacts_api.rb', line 208

def update_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, customer_update_shipping_contacts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingContactsApi.update_customer_shipping_contacts ...'
  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 ShippingContactsApi.update_customer_shipping_contacts"
  end
  # verify the required parameter 'shipping_contacts_id' is set
  if @api_client.config.client_side_validation && shipping_contacts_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_contacts_id' when calling ShippingContactsApi.update_customer_shipping_contacts"
  end
  # verify the required parameter 'customer_update_shipping_contacts' is set
  if @api_client.config.client_side_validation && customer_update_shipping_contacts.nil?
    fail ArgumentError, "Missing the required parameter 'customer_update_shipping_contacts' when calling ShippingContactsApi.update_customer_shipping_contacts"
  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}/shipping_contacts/{shipping_contacts_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'shipping_contacts_id' + '}', CGI.escape(shipping_contacts_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_shipping_contacts)

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

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

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