class ShipEngine::CarrierAccountsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/ship_engine/api/carrier_accounts_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

connect_carrier(connect_carrier_request_body, carrier_name, opts = {}) click to toggle source

Connect a carrier account Connect a carrier account @param connect_carrier_request_body [ConnectCarrierRequestBody] @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. @param [Hash] opts the optional parameters @return [ConnectCarrierResponseBody]

# File lib/ship_engine/api/carrier_accounts_api.rb, line 28
def connect_carrier(connect_carrier_request_body, carrier_name, opts = {})
  data, _status_code, _headers = connect_carrier_with_http_info(connect_carrier_request_body, carrier_name, opts)
  data
end
connect_carrier_with_http_info(connect_carrier_request_body, carrier_name, opts = {}) click to toggle source

Connect a carrier account Connect a carrier account @param connect_carrier_request_body [ConnectCarrierRequestBody] @param carrier_name [CarrierName] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param [Hash] opts the optional parameters @return [Array<(ConnectCarrierResponseBody, Integer, Hash)>] ConnectCarrierResponseBody data, response status code and response headers

# File lib/ship_engine/api/carrier_accounts_api.rb, line 39
def connect_carrier_with_http_info(connect_carrier_request_body, carrier_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CarrierAccountsApi.connect_carrier ...'
  end
  # verify the required parameter 'connect_carrier_request_body' is set
  if @api_client.config.client_side_validation && connect_carrier_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'connect_carrier_request_body' when calling CarrierAccountsApi.connect_carrier"
  end
  # verify the required parameter 'carrier_name' is set
  if @api_client.config.client_side_validation && carrier_name.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.connect_carrier"
  end
  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.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'])
  # 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(connect_carrier_request_body) 

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

  # 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: CarrierAccountsApi#connect_carrier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
disconnect_carrier(carrier_name, carrier_id, opts = {}) click to toggle source

Disconnect a carrier Disconnect a carrier @param carrier_name [CarrierName] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param carrier_id [String] Carrier ID @param [Hash] opts the optional parameters @return [String]

# File lib/ship_engine/api/carrier_accounts_api.rb, line 98
def disconnect_carrier(carrier_name, carrier_id, opts = {})
  data, _status_code, _headers = disconnect_carrier_with_http_info(carrier_name, carrier_id, opts)
  data
end
disconnect_carrier_with_http_info(carrier_name, carrier_id, opts = {}) click to toggle source

Disconnect a carrier Disconnect a carrier @param carrier_name [CarrierName] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param carrier_id [String] Carrier ID @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers

# File lib/ship_engine/api/carrier_accounts_api.rb, line 109
def disconnect_carrier_with_http_info(carrier_name, carrier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CarrierAccountsApi.disconnect_carrier ...'
  end
  # verify the required parameter 'carrier_name' is set
  if @api_client.config.client_side_validation && carrier_name.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.disconnect_carrier"
  end
  # verify the required parameter 'carrier_id' is set
  if @api_client.config.client_side_validation && carrier_id.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_id' when calling CarrierAccountsApi.disconnect_carrier"
  end
  if @api_client.config.client_side_validation && carrier_id.to_s.length > 25
    fail ArgumentError, 'invalid value for "carrier_id" when calling CarrierAccountsApi.disconnect_carrier, the character length must be smaller than or equal to 25.'
  end

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

  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_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: CarrierAccountsApi#disconnect_carrier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_carrier_settings(carrier_name, carrier_id, opts = {}) click to toggle source

Get carrier settings Get carrier settings @param carrier_name [CarrierNameWithSettings] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param carrier_id [String] Carrier ID @param [Hash] opts the optional parameters @return [GetCarrierSettingsResponseBody]

# File lib/ship_engine/api/carrier_accounts_api.rb, line 179
def get_carrier_settings(carrier_name, carrier_id, opts = {})
  data, _status_code, _headers = get_carrier_settings_with_http_info(carrier_name, carrier_id, opts)
  data
end
get_carrier_settings_with_http_info(carrier_name, carrier_id, opts = {}) click to toggle source

Get carrier settings Get carrier settings @param carrier_name [CarrierNameWithSettings] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param carrier_id [String] Carrier ID @param [Hash] opts the optional parameters @return [Array<(GetCarrierSettingsResponseBody, Integer, Hash)>] GetCarrierSettingsResponseBody data, response status code and response headers

# File lib/ship_engine/api/carrier_accounts_api.rb, line 190
def get_carrier_settings_with_http_info(carrier_name, carrier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CarrierAccountsApi.get_carrier_settings ...'
  end
  # verify the required parameter 'carrier_name' is set
  if @api_client.config.client_side_validation && carrier_name.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.get_carrier_settings"
  end
  # verify the required parameter 'carrier_id' is set
  if @api_client.config.client_side_validation && carrier_id.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_id' when calling CarrierAccountsApi.get_carrier_settings"
  end
  if @api_client.config.client_side_validation && carrier_id.to_s.length > 25
    fail ArgumentError, 'invalid value for "carrier_id" when calling CarrierAccountsApi.get_carrier_settings, the character length must be smaller than or equal to 25.'
  end

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

  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}/settings'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_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] || 'GetCarrierSettingsResponseBody' 

  # 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: CarrierAccountsApi#get_carrier_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id, opts = {}) click to toggle source

Update carrier settings Update carrier settings @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody] @param carrier_name [CarrierNameWithSettings] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param carrier_id [String] Carrier ID @param [Hash] opts the optional parameters @return [String]

# File lib/ship_engine/api/carrier_accounts_api.rb, line 261
def update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id, opts = {})
  data, _status_code, _headers = update_carrier_settings_with_http_info(update_carrier_settings_request_body, carrier_name, carrier_id, opts)
  data
end
update_carrier_settings_with_http_info(update_carrier_settings_request_body, carrier_name, carrier_id, opts = {}) click to toggle source

Update carrier settings Update carrier settings @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody] @param carrier_name [CarrierNameWithSettings] The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;. @param carrier_id [String] Carrier ID @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers

# File lib/ship_engine/api/carrier_accounts_api.rb, line 273
def update_carrier_settings_with_http_info(update_carrier_settings_request_body, carrier_name, carrier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CarrierAccountsApi.update_carrier_settings ...'
  end
  # verify the required parameter 'update_carrier_settings_request_body' is set
  if @api_client.config.client_side_validation && update_carrier_settings_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_carrier_settings_request_body' when calling CarrierAccountsApi.update_carrier_settings"
  end
  # verify the required parameter 'carrier_name' is set
  if @api_client.config.client_side_validation && carrier_name.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.update_carrier_settings"
  end
  # verify the required parameter 'carrier_id' is set
  if @api_client.config.client_side_validation && carrier_id.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_id' when calling CarrierAccountsApi.update_carrier_settings"
  end
  if @api_client.config.client_side_validation && carrier_id.to_s.length > 25
    fail ArgumentError, 'invalid value for "carrier_id" when calling CarrierAccountsApi.update_carrier_settings, the character length must be smaller than or equal to 25.'
  end

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

  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}/settings'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_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_carrier_settings_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: CarrierAccountsApi#update_carrier_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end