Class: Printful::ShippingRateAPIClient

Inherits:
Object
  • Object
show all
Defined in:
lib/printful_client/api/shipping_rate_api_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShippingRateAPIClient

Returns a new instance of ShippingRateAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#calculate_shipping_rates(calculate_shipping_rates, opts = {}) ⇒ CalculateShippingRates200Response

Calculate shipping rates Returns available shipping options and rates for the given list of products.

Parameters:

  • calculate_shipping_rates (CalculateShippingRates) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



28
29
30
31
 
# File 'lib/printful_client/api/shipping_rate_api_client.rb', line 28

def calculate_shipping_rates(calculate_shipping_rates, opts = {})
  data, _status_code, _headers = calculate_shipping_rates_with_http_info(calculate_shipping_rates, opts)
  data
end

#calculate_shipping_rates_with_http_info(calculate_shipping_rates, opts = {}) ⇒ Array<(CalculateShippingRates200Response, Integer, Hash)>

Calculate shipping rates Returns available shipping options and rates for the given list of products.

Parameters:

  • calculate_shipping_rates (CalculateShippingRates) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



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
85
86
87
88
89
90
91
 
# File 'lib/printful_client/api/shipping_rate_api_client.rb', line 39

def calculate_shipping_rates_with_http_info(calculate_shipping_rates, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingRateAPIClient.calculate_shipping_rates ...'
  end
  # verify the required parameter 'calculate_shipping_rates' is set
  if @api_client.config.client_side_validation && calculate_shipping_rates.nil?
    fail ArgumentError, "Missing the required parameter 'calculate_shipping_rates' when calling ShippingRateAPIClient.calculate_shipping_rates"
  end
  # resource path
  local_var_path = '/shipping/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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-PF-Store-Id'] = opts[:'x_pf_store_id'] if !opts[:'x_pf_store_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(calculate_shipping_rates)

  # return_type
  return_type = opts[:debug_return_type] || 'CalculateShippingRates200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth']

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