class VericredClient::CarriersApi
Attributes
Public Class Methods
# File lib/vericred_client/api/carriers_api.rb, line 1018 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete a Carrier
. Delete a Carrier
from the database. @param vericred_id The unique Vericred id @param [Hash] opts the optional parameters @return [nil]
# File lib/vericred_client/api/carriers_api.rb, line 1027 def delete_carrier(vericred_id, opts = {}) delete_carrier_with_http_info(vericred_id, opts) return nil end
Delete a Carrier
. Delete a Carrier
from the database. @param vericred_id The unique Vericred id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vericred_client/api/carriers_api.rb, line 1037 def delete_carrier_with_http_info(vericred_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CarriersApi.delete_carrier ..." end # verify the required parameter 'vericred_id' is set fail ArgumentError, "Missing the required parameter 'vericred_id' when calling CarriersApi.delete_carrier" if vericred_id.nil? # resource path local_var_path = "/carriers/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: CarriersApi#delete_carrier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create/update a Carrier
Add or update a Carrier
to the database. @param vericred_id The unique Vericred id @param body Carrier
Record @param [Hash] opts the optional parameters @return [nil]
# File lib/vericred_client/api/carriers_api.rb, line 1084 def put_carrier(vericred_id, body, opts = {}) put_carrier_with_http_info(vericred_id, body, opts) return nil end
Create/update a Carrier
Add or update a Carrier
to the database. @param vericred_id The unique Vericred id @param body Carrier
Record @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vericred_client/api/carriers_api.rb, line 1095 def put_carrier_with_http_info(vericred_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CarriersApi.put_carrier ..." end # verify the required parameter 'vericred_id' is set fail ArgumentError, "Missing the required parameter 'vericred_id' when calling CarriersApi.put_carrier" if vericred_id.nil? # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling CarriersApi.put_carrier" if body.nil? # resource path local_var_path = "/carriers/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: CarriersApi#put_carrier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end