Class: OpenapiClient::PackageTypesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PackageTypesApi

Returns a new instance of PackageTypesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_package_type(create_package_type_request_body, opts = {}) ⇒ CreatePackageTypeResponseBody

Create Custom Package Type Create a custom package type to better assist in getting accurate rate estimates

Parameters:

Returns:



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

def create_package_type(create_package_type_request_body, opts = {})
  data, _status_code, _headers = create_package_type_with_http_info(create_package_type_request_body, opts)
  data
end

#create_package_type_with_http_info(create_package_type_request_body, opts = {}) ⇒ Array<(CreatePackageTypeResponseBody, Integer, Hash)>

Create Custom Package Type Create a custom package type to better assist in getting accurate rate estimates

Parameters:

Returns:



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/package_types_api.rb', line 37

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

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

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

  # 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: PackageTypesApi#create_package_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_package_type(package_id, opts = {}) ⇒ String

Delete A Custom Package By ID Delete a custom package using the ID

Parameters:

  • package_id (String) —

    Package ID

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

    the optional parameters

Returns:

  • (String) 


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

def delete_package_type(package_id, opts = {})
  data, _status_code, _headers = delete_package_type_with_http_info(package_id, opts)
  data
end

#delete_package_type_with_http_info(package_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Delete A Custom Package By ID Delete a custom package using the ID

Parameters:

  • package_id (String) —

    Package ID

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

    the optional parameters

Returns:

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

    String 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
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/openapi_client/api/package_types_api.rb', line 101

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

  if @api_client.config.client_side_validation && package_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.delete_package_type, 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 && package_id !~ pattern
    fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.delete_package_type, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_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(['text/plain', 'application/json'])

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

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

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

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

#get_package_type_by_id(package_id, opts = {}) ⇒ GetPackageTypeByIdResponseBody

Get Custom Package Type By ID Get Custom Package Type by ID

Parameters:

  • package_id (String) —

    Package ID

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

    the optional parameters

Returns:



166
167
168
169
 
# File 'lib/openapi_client/api/package_types_api.rb', line 166

def get_package_type_by_id(package_id, opts = {})
  data, _status_code, _headers = get_package_type_by_id_with_http_info(package_id, opts)
  data
end

#get_package_type_by_id_with_http_info(package_id, opts = {}) ⇒ Array<(GetPackageTypeByIdResponseBody, Integer, Hash)>

Get Custom Package Type By ID Get Custom Package Type by ID

Parameters:

  • package_id (String) —

    Package ID

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

    the optional parameters

Returns:



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/openapi_client/api/package_types_api.rb', line 176

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

  if @api_client.config.client_side_validation && package_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.get_package_type_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 && package_id !~ pattern
    fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.get_package_type_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_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] || 'GetPackageTypeByIdResponseBody' 

  # 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: PackageTypesApi#get_package_type_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_package_types(opts = {}) ⇒ ListPackageTypesResponseBody

List Custom Package Types List the custom package types associated with the account

Parameters:

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

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/openapi_client/api/package_types_api.rb', line 240

def list_package_types(opts = {})
  data, _status_code, _headers = list_package_types_with_http_info(opts)
  data
end

#list_package_types_with_http_info(opts = {}) ⇒ Array<(ListPackageTypesResponseBody, Integer, Hash)>

List Custom Package Types List the custom package types associated with the account

Parameters:

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

    the optional parameters

Returns:



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
288
289
290
 
# File 'lib/openapi_client/api/package_types_api.rb', line 249

def list_package_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PackageTypesApi.list_package_types ...'
  end
  # resource path
  local_var_path = '/v1/packages'

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

  # 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: PackageTypesApi#list_package_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_package_type(package_id, update_package_type_request_body, opts = {}) ⇒ String

Update Custom Package Type By ID Update the custom package type object by ID

Parameters:

  • package_id (String) —

    Package ID

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

    the optional parameters

Returns:

  • (String) 


298
299
300
301
 
# File 'lib/openapi_client/api/package_types_api.rb', line 298

def update_package_type(package_id, update_package_type_request_body, opts = {})
  data, _status_code, _headers = update_package_type_with_http_info(package_id, update_package_type_request_body, opts)
  data
end

#update_package_type_with_http_info(package_id, update_package_type_request_body, opts = {}) ⇒ Array<(String, Integer, Hash)>

Update Custom Package Type By ID Update the custom package type object by ID

Parameters:

  • package_id (String) —

    Package ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/openapi_client/api/package_types_api.rb', line 309

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

  if @api_client.config.client_side_validation && package_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.update_package_type, 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 && package_id !~ pattern
    fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.update_package_type, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'update_package_type_request_body' is set
  if @api_client.config.client_side_validation && update_package_type_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_package_type_request_body' when calling PackageTypesApi.update_package_type"
  end
  # resource path
  local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_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(['text/plain', '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(update_package_type_request_body) 

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

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PackageTypesApi#update_package_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end