Class: DigitalFemsa::ShippingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/digital_femsa/api/shippings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShippingsApi

Returns a new instance of ShippingsApi.



19
20
21
 
# File 'lib/digital_femsa/api/shippings_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/digital_femsa/api/shippings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#orders_create_shipping(id, shipping_request, opts = {}) ⇒ ShippingOrderResponse

Create Shipping Create new shipping for an existing orden

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_request (ShippingRequest) —

    requested field for a shipping

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

def orders_create_shipping(id, shipping_request, opts = {})
  data, _status_code, _headers = orders_create_shipping_with_http_info(id, shipping_request, opts)
  data
end

#orders_create_shipping_with_http_info(id, shipping_request, opts = {}) ⇒ Array<(ShippingOrderResponse, Integer, Hash)>

Create Shipping Create new shipping for an existing orden

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_request (ShippingRequest) —

    requested field for a shipping

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

    ShippingOrderResponse 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/digital_femsa/api/shippings_api.rb', line 43

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

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

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

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

#orders_delete_shipping(id, shipping_id, opts = {}) ⇒ ShippingOrderResponse

Delete Shipping Delete shipping

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_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/digital_femsa/api/shippings_api.rb', line 114

def orders_delete_shipping(id, shipping_id, opts = {})
  data, _status_code, _headers = orders_delete_shipping_with_http_info(id, shipping_id, opts)
  data
end

#orders_delete_shipping_with_http_info(id, shipping_id, opts = {}) ⇒ Array<(ShippingOrderResponse, Integer, Hash)>

Delete Shipping Delete shipping

Parameters:

  • id (String) —

    Identifier of the resource

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

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

    ShippingOrderResponse 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/digital_femsa/api/shippings_api.rb', line 127

def orders_delete_shipping_with_http_info(id, shipping_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingsApi.orders_delete_shipping ...'
  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 ShippingsApi.orders_delete_shipping"
  end
  # verify the required parameter 'shipping_id' is set
  if @api_client.config.client_side_validation && shipping_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_id' when calling ShippingsApi.orders_delete_shipping"
  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}/shipping_lines/{shipping_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'shipping_id' + '}', CGI.escape(shipping_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.app-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] || 'ShippingOrderResponse'

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

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

#orders_update_shipping(id, shipping_id, shipping_request, opts = {}) ⇒ ShippingOrderResponse

Update Shipping Update existing shipping for an existing orden

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_id (String) —

    identifier

  • shipping_request (ShippingRequest) —

    requested field for a shipping

  • 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/digital_femsa/api/shippings_api.rb', line 194

def orders_update_shipping(id, shipping_id, shipping_request, opts = {})
  data, _status_code, _headers = orders_update_shipping_with_http_info(id, shipping_id, shipping_request, opts)
  data
end

#orders_update_shipping_with_http_info(id, shipping_id, shipping_request, opts = {}) ⇒ Array<(ShippingOrderResponse, Integer, Hash)>

Update Shipping Update existing shipping for an existing orden

Parameters:

  • id (String) —

    Identifier of the resource

  • shipping_id (String) —

    identifier

  • shipping_request (ShippingRequest) —

    requested field for a shipping

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

    ShippingOrderResponse data, response status code and response headers



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/digital_femsa/api/shippings_api.rb', line 208

def orders_update_shipping_with_http_info(id, shipping_id, shipping_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingsApi.orders_update_shipping ...'
  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 ShippingsApi.orders_update_shipping"
  end
  # verify the required parameter 'shipping_id' is set
  if @api_client.config.client_side_validation && shipping_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_id' when calling ShippingsApi.orders_update_shipping"
  end
  # verify the required parameter 'shipping_request' is set
  if @api_client.config.client_side_validation && shipping_request.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_request' when calling ShippingsApi.orders_update_shipping"
  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}/shipping_lines/{shipping_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'shipping_id' + '}', CGI.escape(shipping_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.app-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(shipping_request)

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

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

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