class OpenapiClient::PackageTypesApi
Attributes
Public Class Methods
# File lib/openapi_client/api/package_types_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create Custom Package
Type Create a custom package type to better assist in getting accurate rate estimates @param create_package_type_request_body [CreatePackageTypeRequestBody] @param [Hash] opts the optional parameters @return [CreatePackageTypeResponseBody]
# 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 Custom Package
Type Create a custom package type to better assist in getting accurate rate estimates @param create_package_type_request_body [CreatePackageTypeRequestBody] @param [Hash] opts the optional parameters @return [Array<(CreatePackageTypeResponseBody
, Integer, Hash)>] CreatePackageTypeResponseBody
data, response status code and response headers
# 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 A Custom Package
By ID Delete a custom package using the ID @param package_id [String] Package
ID @param [Hash] opts the optional parameters @return [String]
# 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 A Custom Package
By ID Delete a custom package using the ID @param package_id [String] Package
ID @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
# 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 Custom Package
Type By ID Get Custom Package
Type by ID @param package_id [String] Package
ID @param [Hash] opts the optional parameters @return [GetPackageTypeByIdResponseBody]
# 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 Custom Package
Type By ID Get Custom Package
Type by ID @param package_id [String] Package
ID @param [Hash] opts the optional parameters @return [Array<(GetPackageTypeByIdResponseBody
, Integer, Hash)>] GetPackageTypeByIdResponseBody
data, response status code and response headers
# 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 Custom Package
Types List the custom package types associated with the account @param [Hash] opts the optional parameters @return [ListPackageTypesResponseBody]
# 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 Custom Package
Types List the custom package types associated with the account @param [Hash] opts the optional parameters @return [Array<(ListPackageTypesResponseBody
, Integer, Hash)>] ListPackageTypesResponseBody
data, response status code and response headers
# 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 Custom Package
Type By ID Update the custom package type object by ID @param package_id [String] Package
ID @param update_package_type_request_body [UpdatePackageTypeRequestBody] @param [Hash] opts the optional parameters @return [String]
# 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 Custom Package
Type By ID Update the custom package type object by ID @param package_id [String] Package
ID @param update_package_type_request_body [UpdatePackageTypeRequestBody] @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
# 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