Class: Devdraft::TaxesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TaxesApi

Returns a new instance of TaxesApi.



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

def api_client
  @api_client
end

Instance Method Details

#tax_controller_create(create_tax_dto, opts = {}) ⇒ TaxControllerCreate201Response

Create a new tax Creates a new tax rate that can be applied to products, invoices, and payment links. ## Use Cases - Set up sales tax for different regions - Create VAT rates for international customers - Configure state and local tax rates - Manage tax compliance requirements ## Example: Create Basic Sales Tax “‘json { "name": "Sales Tax", "description": "Standard sales tax for retail transactions", "percentage": 8.5, "active": true } “` ## Required Fields - `name`: Tax name for identification (1-100 characters) - `percentage`: Tax rate percentage (0-100) ## Optional Fields - `description`: Explanation of what this tax covers (max 255 characters) - `active`: Whether this tax is currently active (default: true) - `appIds`: Array of app IDs where this tax should be available

Parameters:

  • create_tax_dto (CreateTaxDto) —

    Tax creation data

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/devdraft/api/taxes_api.rb', line 27

def tax_controller_create(create_tax_dto, opts = {})
  data, _status_code, _headers = tax_controller_create_with_http_info(create_tax_dto, opts)
  data
end

#tax_controller_create_with_http_info(create_tax_dto, opts = {}) ⇒ Array<(TaxControllerCreate201Response, Integer, Hash)>

Create a new tax Creates a new tax rate that can be applied to products, invoices, and payment links. ## Use Cases - Set up sales tax for different regions - Create VAT rates for international customers - Configure state and local tax rates - Manage tax compliance requirements ## Example: Create Basic Sales Tax &#x60;&#x60;&#x60;json { &quot;name&quot;: &quot;Sales Tax&quot;, &quot;description&quot;: &quot;Standard sales tax for retail transactions&quot;, &quot;percentage&quot;: 8.5, &quot;active&quot;: true } &#x60;&#x60;&#x60; ## Required Fields - &#x60;name&#x60;: Tax name for identification (1-100 characters) - &#x60;percentage&#x60;: Tax rate percentage (0-100) ## Optional Fields - &#x60;description&#x60;: Explanation of what this tax covers (max 255 characters) - &#x60;active&#x60;: Whether this tax is currently active (default: true) - &#x60;appIds&#x60;: Array of app IDs where this tax should be available

Parameters:

  • create_tax_dto (CreateTaxDto) —

    Tax creation data

  • 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/devdraft/api/taxes_api.rb', line 37

def tax_controller_create_with_http_info(create_tax_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_create ...'
  end
  # verify the required parameter 'create_tax_dto' is set
  if @api_client.config.client_side_validation && create_tax_dto.nil?
    fail ArgumentError, "Missing the required parameter 'create_tax_dto' when calling TaxesApi.tax_controller_create"
  end
  # resource path
  local_var_path = '/api/v0/taxes'

  # 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']) unless header_params['Accept']
  # 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(create_tax_dto)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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

#tax_controller_delete_without_id(opts = {}) ⇒ nil

Tax ID required for deletion This endpoint requires a tax ID in the URL path. Use DELETE /api/v0/taxes/id instead.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/devdraft/api/taxes_api.rb', line 94

def tax_controller_delete_without_id(opts = {})
  tax_controller_delete_without_id_with_http_info(opts)
  nil
end

#tax_controller_delete_without_id_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Tax ID required for deletion This endpoint requires a tax ID in the URL path. Use DELETE /api/v0/taxes/id instead.

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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/devdraft/api/taxes_api.rb', line 103

def tax_controller_delete_without_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_delete_without_id ...'
  end
  # resource path
  local_var_path = '/api/v0/taxes'

  # 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']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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

#tax_controller_find_all(opts = {}) ⇒ nil

Get all taxes with filters Retrieves a list of taxes with optional filtering and pagination. ## Use Cases - List all available tax rates - Search taxes by name - Filter active/inactive taxes - Export tax configuration ## Query Parameters - ‘skip`: Number of records to skip (default: 0, min: 0) - `take`: Number of records to return (default: 10, min: 1, max: 100) - `name`: Filter taxes by name (partial match, case-insensitive) - `active`: Filter by active status (true/false) ## Example Request `GET /api/v0/taxes?skip=0&take=20&active=true&name=Sales` ## Example Response “`json [ { "id": "tax_123456", "name": "Sales Tax", "description": "Standard sales tax for retail transactions", "percentage": 8.5, "active": true, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z" } ] “`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Float) —

    Number of records to skip for pagination (default to 0)

  • :take (Float) —

    Number of records to return (max 100) (default to 10)

  • :name (String) —

    Filter taxes by name (partial match, case-insensitive)

  • :active (Boolean) —

    Filter by active status

Returns:

  • (nil) 


155
156
157
158
 
# File 'lib/devdraft/api/taxes_api.rb', line 155

def tax_controller_find_all(opts = {})
  tax_controller_find_all_with_http_info(opts)
  nil
end

#tax_controller_find_all_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get all taxes with filters Retrieves a list of taxes with optional filtering and pagination. ## Use Cases - List all available tax rates - Search taxes by name - Filter active/inactive taxes - Export tax configuration ## Query Parameters - &#x60;skip&#x60;: Number of records to skip (default: 0, min: 0) - &#x60;take&#x60;: Number of records to return (default: 10, min: 1, max: 100) - &#x60;name&#x60;: Filter taxes by name (partial match, case-insensitive) - &#x60;active&#x60;: Filter by active status (true/false) ## Example Request &#x60;GET /api/v0/taxes?skip&#x3D;0&amp;take&#x3D;20&amp;active&#x3D;true&amp;name&#x3D;Sales&#x60; ## Example Response &#x60;&#x60;&#x60;json [ { &quot;id&quot;: &quot;tax_123456&quot;, &quot;name&quot;: &quot;Sales Tax&quot;, &quot;description&quot;: &quot;Standard sales tax for retail transactions&quot;, &quot;percentage&quot;: 8.5, &quot;active&quot;: true, &quot;created_at&quot;: &quot;2024-03-20T10:00:00Z&quot;, &quot;updated_at&quot;: &quot;2024-03-20T10:00:00Z&quot; } ] &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Float) —

    Number of records to skip for pagination (default to 0)

  • :take (Float) —

    Number of records to return (max 100) (default to 10)

  • :name (String) —

    Filter taxes by name (partial match, case-insensitive)

  • :active (Boolean) —

    Filter by active status

Returns:

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

    nil, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/devdraft/api/taxes_api.rb', line 168

def tax_controller_find_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_find_all ...'
  end
  if @api_client.config.client_side_validation && !opts[:'skip'].nil? && opts[:'skip'] < 0
    fail ArgumentError, 'invalid value for "opts[:"skip"]" when calling TaxesApi.tax_controller_find_all, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'take'].nil? && opts[:'take'] > 100
    fail ArgumentError, 'invalid value for "opts[:"take"]" when calling TaxesApi.tax_controller_find_all, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'take'].nil? && opts[:'take'] < 1
    fail ArgumentError, 'invalid value for "opts[:"take"]" when calling TaxesApi.tax_controller_find_all, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'name'].nil? && opts[:'name'].to_s.length > 100
    fail ArgumentError, 'invalid value for "opts[:"name"]" when calling TaxesApi.tax_controller_find_all, the character length must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/api/v0/taxes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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

#tax_controller_find_one(id, opts = {}) ⇒ nil

Get a tax by ID Retrieves detailed information about a specific tax. ## Use Cases - View tax details - Verify tax configuration - Check tax status before applying to products ## Path Parameters - ‘id`: Tax UUID (required) - Must be a valid UUID format ## Example Request `GET /api/v0/taxes/123e4567-e89b-12d3-a456-426614174000` ## Example Response “`json { "id": "tax_123456", "name": "Sales Tax", "description": "Standard sales tax for retail transactions", "percentage": 8.5, "active": true, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z" } “`

Parameters:

  • id (String) —

    Tax unique identifier (UUID)

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

    the optional parameters

Returns:

  • (nil) 


235
236
237
238
 
# File 'lib/devdraft/api/taxes_api.rb', line 235

def tax_controller_find_one(id, opts = {})
  tax_controller_find_one_with_http_info(id, opts)
  nil
end

#tax_controller_find_one_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get a tax by ID Retrieves detailed information about a specific tax. ## Use Cases - View tax details - Verify tax configuration - Check tax status before applying to products ## Path Parameters - &#x60;id&#x60;: Tax UUID (required) - Must be a valid UUID format ## Example Request &#x60;GET /api/v0/taxes/123e4567-e89b-12d3-a456-426614174000&#x60; ## Example Response &#x60;&#x60;&#x60;json { &quot;id&quot;: &quot;tax_123456&quot;, &quot;name&quot;: &quot;Sales Tax&quot;, &quot;description&quot;: &quot;Standard sales tax for retail transactions&quot;, &quot;percentage&quot;: 8.5, &quot;active&quot;: true, &quot;created_at&quot;: &quot;2024-03-20T10:00:00Z&quot;, &quot;updated_at&quot;: &quot;2024-03-20T10:00:00Z&quot; } &#x60;&#x60;&#x60;

Parameters:

  • id (String) —

    Tax unique identifier (UUID)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/devdraft/api/taxes_api.rb', line 245

def tax_controller_find_one_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_find_one ...'
  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.tax_controller_find_one"
  end
  # resource path
  local_var_path = '/api/v0/taxes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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

#tax_controller_remove(id, opts = {}) ⇒ nil

Delete a tax Deletes an existing tax. ## Use Cases - Remove obsolete tax rates - Clean up unused taxes - Comply with regulatory changes ## Path Parameters - ‘id`: Tax UUID (required) - Must be a valid UUID format ## Example Request `DELETE /api/v0/taxes/123e4567-e89b-12d3-a456-426614174000` ## Warning This action cannot be undone. Consider deactivating the tax instead of deleting it if it has been used in transactions.

Parameters:

  • id (String) —

    Tax unique identifier (UUID)

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

    the optional parameters

Returns:

  • (nil) 


296
297
298
299
 
# File 'lib/devdraft/api/taxes_api.rb', line 296

def tax_controller_remove(id, opts = {})
  tax_controller_remove_with_http_info(id, opts)
  nil
end

#tax_controller_remove_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a tax Deletes an existing tax. ## Use Cases - Remove obsolete tax rates - Clean up unused taxes - Comply with regulatory changes ## Path Parameters - &#x60;id&#x60;: Tax UUID (required) - Must be a valid UUID format ## Example Request &#x60;DELETE /api/v0/taxes/123e4567-e89b-12d3-a456-426614174000&#x60; ## Warning This action cannot be undone. Consider deactivating the tax instead of deleting it if it has been used in transactions.

Parameters:

  • id (String) —

    Tax unique identifier (UUID)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/devdraft/api/taxes_api.rb', line 306

def tax_controller_remove_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_remove ...'
  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.tax_controller_remove"
  end
  # resource path
  local_var_path = '/api/v0/taxes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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

#tax_controller_update(id, update_tax_dto, opts = {}) ⇒ nil

Update a tax Updates an existing tax’s information. ## Use Cases - Modify tax percentage rates - Update tax descriptions - Activate/deactivate taxes - Change tax names ## Path Parameters - ‘id`: Tax UUID (required) - Must be a valid UUID format ## Example Request `PUT /api/v0/taxes/123e4567-e89b-12d3-a456-426614174000` ## Example Request Body “`json { "name": "Updated Sales Tax", "description": "Updated sales tax rate", "percentage": 9.0, "active": true } “` ## Notes - Only include fields that need to be updated - All fields are optional in updates - Percentage changes affect future calculations only

Parameters:

  • id (String) —

    Tax unique identifier (UUID)

  • update_tax_dto (UpdateTaxDto) —

    Tax update data - only include fields you want to update

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

    the optional parameters

Returns:

  • (nil) 


358
359
360
361
 
# File 'lib/devdraft/api/taxes_api.rb', line 358

def tax_controller_update(id, update_tax_dto, opts = {})
  tax_controller_update_with_http_info(id, update_tax_dto, opts)
  nil
end

#tax_controller_update_with_http_info(id, update_tax_dto, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a tax Updates an existing tax&#39;s information. ## Use Cases - Modify tax percentage rates - Update tax descriptions - Activate/deactivate taxes - Change tax names ## Path Parameters - &#x60;id&#x60;: Tax UUID (required) - Must be a valid UUID format ## Example Request &#x60;PUT /api/v0/taxes/123e4567-e89b-12d3-a456-426614174000&#x60; ## Example Request Body &#x60;&#x60;&#x60;json { &quot;name&quot;: &quot;Updated Sales Tax&quot;, &quot;description&quot;: &quot;Updated sales tax rate&quot;, &quot;percentage&quot;: 9.0, &quot;active&quot;: true } &#x60;&#x60;&#x60; ## Notes - Only include fields that need to be updated - All fields are optional in updates - Percentage changes affect future calculations only

Parameters:

  • id (String) —

    Tax unique identifier (UUID)

  • update_tax_dto (UpdateTaxDto) —

    Tax update data - only include fields you want to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/devdraft/api/taxes_api.rb', line 369

def tax_controller_update_with_http_info(id, update_tax_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_update ...'
  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.tax_controller_update"
  end
  # verify the required parameter 'update_tax_dto' is set
  if @api_client.config.client_side_validation && update_tax_dto.nil?
    fail ArgumentError, "Missing the required parameter 'update_tax_dto' when calling TaxesApi.tax_controller_update"
  end
  # resource path
  local_var_path = '/api/v0/taxes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(update_tax_dto)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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

#tax_controller_update_without_id(opts = {}) ⇒ nil

Tax ID required for updates This endpoint requires a tax ID in the URL path. Use PUT /api/v0/taxes/id instead.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


428
429
430
431
 
# File 'lib/devdraft/api/taxes_api.rb', line 428

def tax_controller_update_without_id(opts = {})
  tax_controller_update_without_id_with_http_info(opts)
  nil
end

#tax_controller_update_without_id_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Tax ID required for updates This endpoint requires a tax ID in the URL path. Use PUT /api/v0/taxes/id instead.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/devdraft/api/taxes_api.rb', line 437

def tax_controller_update_without_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxesApi.tax_controller_update_without_id ...'
  end
  # resource path
  local_var_path = '/api/v0/taxes'

  # 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']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

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