Class: OpenapiClient::RatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/rates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RatesApi

Returns a new instance of RatesApi.



19
20
21
 
# File 'lib/openapi_client/api/rates_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/openapi_client/api/rates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#calculate_rates(calculate_rates_request_body, opts = {}) ⇒ CalculateRatesResponseBody

Get Shipping Rates It’s not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don’t solely ship things using a single shipping option; so we provide functionality to show you all your options!

Parameters:

Returns:



27
28
29
30
 
# File 'lib/openapi_client/api/rates_api.rb', line 27

def calculate_rates(calculate_rates_request_body, opts = {})
  data, _status_code, _headers = calculate_rates_with_http_info(calculate_rates_request_body, opts)
  data
end

#calculate_rates_with_http_info(calculate_rates_request_body, opts = {}) ⇒ Array<(CalculateRatesResponseBody, Integer, Hash)>

Get Shipping Rates It&#39;s not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don&#39;t solely ship things using a single shipping option; so we provide functionality to show you all your options!

Parameters:

Returns:

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

    CalculateRatesResponseBody data, response status code and response headers



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
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/openapi_client/api/rates_api.rb', line 37

def calculate_rates_with_http_info(calculate_rates_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RatesApi.calculate_rates ...'
  end
  # verify the required parameter 'calculate_rates_request_body' is set
  if @api_client.config.client_side_validation && calculate_rates_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'calculate_rates_request_body' when calling RatesApi.calculate_rates"
  end
  # resource path
  local_var_path = '/v1/rates'

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

  # return_type
  return_type = opts[:return_type] || 'CalculateRatesResponseBody' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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

#compare_bulk_rates(compare_bulk_rates_request_body, opts = {}) ⇒ Array<BulkRate>

Get Bulk Rates Get Bulk Shipment Rates

Parameters:

Returns:



91
92
93
94
 
# File 'lib/openapi_client/api/rates_api.rb', line 91

def compare_bulk_rates(compare_bulk_rates_request_body, opts = {})
  data, _status_code, _headers = compare_bulk_rates_with_http_info(compare_bulk_rates_request_body, opts)
  data
end

#compare_bulk_rates_with_http_info(compare_bulk_rates_request_body, opts = {}) ⇒ Array<(Array<BulkRate>, Integer, Hash)>

Get Bulk Rates Get Bulk Shipment Rates

Parameters:

Returns:

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

    Array<BulkRate> data, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/openapi_client/api/rates_api.rb', line 101

def compare_bulk_rates_with_http_info(compare_bulk_rates_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RatesApi.compare_bulk_rates ...'
  end
  # verify the required parameter 'compare_bulk_rates_request_body' is set
  if @api_client.config.client_side_validation && compare_bulk_rates_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'compare_bulk_rates_request_body' when calling RatesApi.compare_bulk_rates"
  end
  # resource path
  local_var_path = '/v1/rates/bulk'

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

  # return_type
  return_type = opts[:return_type] || 'Array<BulkRate>' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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

#estimate_rates(estimate_rates_request_body, opts = {}) ⇒ Array<Rate>

Estimate Rates Get Rate Estimates

Parameters:

Returns:



155
156
157
158
 
# File 'lib/openapi_client/api/rates_api.rb', line 155

def estimate_rates(estimate_rates_request_body, opts = {})
  data, _status_code, _headers = estimate_rates_with_http_info(estimate_rates_request_body, opts)
  data
end

#estimate_rates_with_http_info(estimate_rates_request_body, opts = {}) ⇒ Array<(Array<Rate>, Integer, Hash)>

Estimate Rates Get Rate Estimates

Parameters:

Returns:

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

    Array<Rate> data, response status code and response headers



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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/openapi_client/api/rates_api.rb', line 165

def estimate_rates_with_http_info(estimate_rates_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RatesApi.estimate_rates ...'
  end
  # verify the required parameter 'estimate_rates_request_body' is set
  if @api_client.config.client_side_validation && estimate_rates_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'estimate_rates_request_body' when calling RatesApi.estimate_rates"
  end
  # resource path
  local_var_path = '/v1/rates/estimate'

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

  # return_type
  return_type = opts[:return_type] || 'Array<Rate>' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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

#get_rate_by_id(rate_id, opts = {}) ⇒ GetRateByIdResponseBody

Get Rate By ID Retrieve a previously queried rate by its ID

Parameters:

  • rate_id (String) —

    Rate ID

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/openapi_client/api/rates_api.rb', line 219

def get_rate_by_id(rate_id, opts = {})
  data, _status_code, _headers = get_rate_by_id_with_http_info(rate_id, opts)
  data
end

#get_rate_by_id_with_http_info(rate_id, opts = {}) ⇒ Array<(GetRateByIdResponseBody, Integer, Hash)>

Get Rate By ID Retrieve a previously queried rate by its ID

Parameters:

  • rate_id (String) —

    Rate ID

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

    the optional parameters

Returns:

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

    GetRateByIdResponseBody data, response status code and response headers



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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/openapi_client/api/rates_api.rb', line 229

def get_rate_by_id_with_http_info(rate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RatesApi.get_rate_by_id ...'
  end
  # verify the required parameter 'rate_id' is set
  if @api_client.config.client_side_validation && rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'rate_id' when calling RatesApi.get_rate_by_id"
  end
  if @api_client.config.client_side_validation && rate_id.to_s.length > 25
    fail ArgumentError, 'invalid value for "rate_id" when calling RatesApi.get_rate_by_id, the character length must be smaller than or equal to 25.'
  end

  if @api_client.config.client_side_validation && rate_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "rate_id" when calling RatesApi.get_rate_by_id, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
  if @api_client.config.client_side_validation && rate_id !~ pattern
    fail ArgumentError, "invalid value for 'rate_id' when calling RatesApi.get_rate_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/rates/{rate_id}'.sub('{' + 'rate_id' + '}', CGI.escape(rate_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/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'GetRateByIdResponseBody' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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