Class: Printful::TaxRateAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TaxRateAPIClient

Returns a new instance of TaxRateAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#calculate_tax_rates(tax_request, opts = {}) ⇒ CalculateTaxRates200Response

Calculate tax rate Calculates sales tax rate for given address if required

Parameters:

  • tax_request (TaxRequest) —

    POST request body

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/printful_client/api/tax_rate_api_client.rb', line 27

def calculate_tax_rates(tax_request, opts = {})
  data, _status_code, _headers = calculate_tax_rates_with_http_info(tax_request, opts)
  data
end

#calculate_tax_rates_with_http_info(tax_request, opts = {}) ⇒ Array<(CalculateTaxRates200Response, Integer, Hash)>

Calculate tax rate Calculates sales tax rate for given address if required

Parameters:

  • tax_request (TaxRequest) —

    POST request body

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

    the optional 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
85
86
87
88
 
# File 'lib/printful_client/api/tax_rate_api_client.rb', line 37

def calculate_tax_rates_with_http_info(tax_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxRateAPIClient.calculate_tax_rates ...'
  end
  # verify the required parameter 'tax_request' is set
  if @api_client.config.client_side_validation && tax_request.nil?
    fail ArgumentError, "Missing the required parameter 'tax_request' when calling TaxRateAPIClient.calculate_tax_rates"
  end
  # resource path
  local_var_path = '/tax/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

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

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

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

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

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

#get_tax_countries(opts = {}) ⇒ GetTaxCountries200Response

Get a list of countries for tax calculation Retrieve state list that requires sales tax calculation

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/printful_client/api/tax_rate_api_client.rb', line 94

def get_tax_countries(opts = {})
  data, _status_code, _headers = get_tax_countries_with_http_info(opts)
  data
end

#get_tax_countries_with_http_info(opts = {}) ⇒ Array<(GetTaxCountries200Response, Integer, Hash)>

Get a list of countries for tax calculation Retrieve state list that requires sales tax calculation

Parameters:

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

    the optional parameters

Returns:

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

    GetTaxCountries200Response data, response status code and response headers



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
 
# File 'lib/printful_client/api/tax_rate_api_client.rb', line 103

def get_tax_countries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxRateAPIClient.get_tax_countries ...'
  end
  # resource path
  local_var_path = '/tax/countries'

  # 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[:debug_body]

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

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

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