Class: CyberSource::TaxesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/taxes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ TaxesApi

Returns a new instance of TaxesApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/taxes_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/taxes_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#calculate_tax(tax_request, opts = {}) ⇒ VasV2PaymentsPost201Response

Calculate Taxes The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide. It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation. The service supports product-based tax rules and exemptions for goods and services. The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).

Parameters:

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/cybersource_rest_client/api/taxes_api.rb', line 29

def calculate_tax(tax_request, opts = {})
  data, status_code, headers = calculate_tax_with_http_info(tax_request, opts)
  return data, status_code, headers
end

#calculate_tax_with_http_info(tax_request, opts = {}) ⇒ Array<(VasV2PaymentsPost201Response, Fixnum, Hash)>

Calculate Taxes The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide. It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation. The service supports product-based tax rules and exemptions for goods and services. The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).

Parameters:

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

    the optional parameters

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
 
# File 'lib/cybersource_rest_client/api/taxes_api.rb', line 39

def calculate_tax_with_http_info(tax_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: TaxesApi.calculate_tax ...'
        rescue
            puts 'Cannot write to log'
        end
  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 TaxesApi.calculate_tax"
  end
  # resource path
  local_var_path = 'vas/v2/tax'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(tax_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'TaxRequest', @api_client.config.host)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VasV2PaymentsPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: TaxesApi#calculate_tax\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#void_tax(void_tax_request, id, opts = {}) ⇒ VasV2TaxVoid200Response

Void Taxes Pass the Tax Request ID in the PATCH request to void the committed tax calculation.

Parameters:

  • void_tax_request
  • id —

    The tax ID returned from a previous request.

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

    the optional parameters

Returns:



99
100
101
102
 
# File 'lib/cybersource_rest_client/api/taxes_api.rb', line 99

def void_tax(void_tax_request, id, opts = {})
  data, status_code, headers = void_tax_with_http_info(void_tax_request, id, opts)
  return data, status_code, headers
end

#void_tax_with_http_info(void_tax_request, id, opts = {}) ⇒ Array<(VasV2TaxVoid200Response, Fixnum, Hash)>

Void Taxes Pass the Tax Request ID in the PATCH request to void the committed tax calculation.

Parameters:

  • void_tax_request
  • id —

    The tax ID returned from a previous request.

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

    the optional parameters

Returns:

  • (Array<(VasV2TaxVoid200Response, Fixnum, Hash)>) —

    VasV2TaxVoid200Response data, response status code and response headers



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/cybersource_rest_client/api/taxes_api.rb', line 110

def void_tax_with_http_info(void_tax_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: TaxesApi.void_tax ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'void_tax_request' is set
  if @api_client.config.client_side_validation && void_tax_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_tax_request' when calling TaxesApi.void_tax"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TaxesApi.void_tax"
  end
  # resource path
  local_var_path = 'vas/v2/tax/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(void_tax_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'VoidTaxRequest', @api_client.config.host)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VasV2TaxVoid200Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: TaxesApi#void_tax\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end