Skip to content

Commit 18859a8

Browse files
svc-developersvc-developer
authored
Merge pull request #176 from avadev/25.3.2
25.3.2
2 parents 4870e20 + 6bb00f1 commit 18859a8

File tree

5 files changed

+149
-3
lines changed

5 files changed

+149
-3
lines changed

‎lib/avatax/client/batches.rb

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,30 @@ module Batches
2828
def cancel_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
2929
post(path, {}, {}, AvaTax::VERSION) end
3030

31+
# Create a new Advanced Rules batch
32+
#
33+
# Create a new Advanced Rules batch objects attached to this company.
34+
#
35+
# When an Advanced Rules batch is created, it is added to the AvaTax Batch v2 Queue and will be
36+
# processed as quickly as possible in the order it was received. To check the
37+
# status of a batch, fetch the batch and retrieve the results of the batch
38+
# operation.
39+
#
40+
# The maximum content length of the request body is limited to 28.6 MB. If this limit
41+
# is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
42+
# the API is called from a browser). In this situation, please split the request into
43+
# smaller batches.
44+
#
45+
# ### Security Policies
46+
#
47+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
48+
# Swagger Name: AvaTaxClient
49+
# @param companyId [Integer] The ID of the company that owns this batch.
50+
# @param model [Object] The Advanced Rules batch you wish to create.
51+
# @return [Object]
52+
def create_advanced_rules_batch(companyId, model) path = "/api/v2/companies/#{companyId}/batches/advancedrules"
53+
post(path, model, {}, AvaTax::VERSION) end
54+
3155
# Create a new batch
3256
#
3357
# Create one or more new batch objects attached to this company.

‎lib/avatax/client/certificates.rb

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,27 @@ def create_certificates(companyId, model, options={}) path = "/api/v2/com
6666
def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
6767
delete(path, {}, AvaTax::VERSION) end
6868

69+
# Delete Certificate Custom Fields
70+
#
71+
# Deletes custom fields for a specified certificate.
72+
#
73+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
74+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
75+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
76+
# certificate storage for this company, call `RequestCertificateSetup`.
77+
#
78+
# ### Security Policies
79+
#
80+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
81+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
82+
# Swagger Name: AvaTaxClient
83+
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
84+
# @param id [Integer] The unique ID number of this certificate
85+
# @param model [DeleteCustomFields[]] Delete custom fields request model
86+
# @return []
87+
def delete_certificate_custom_fields(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
88+
delete(path, model, {}, AvaTax::VERSION) end
89+
6990
# Download an image for this certificate
7091
#
7192
# Download an image or PDF file for this certificate.
@@ -269,6 +290,25 @@ def list_attributes_for_certificate(companyId, id) path = "/api/v2/compan
269290
def list_customers_for_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
270291
get(path, options, AvaTax::VERSION) end
271292

293+
# Retrieve Certificate Custom Fields
294+
#
295+
# This API is used to retrieve custom fields for a certificate.
296+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
297+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
298+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
299+
# certificate storage for this company, call `RequestCertificateSetup`.
300+
#
301+
# ### Security Policies
302+
#
303+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
304+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
305+
# Swagger Name: AvaTaxClient
306+
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
307+
# @param id [Integer] The unique ID number of this certificate
308+
# @return [Object]
309+
def list_custom_fields_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
310+
get(path, {}, AvaTax::VERSION) end
311+
272312
# List all certificates for a company
273313
#
274314
# List all certificates recorded by a company
@@ -417,6 +457,27 @@ def unlink_customers_from_certificate(companyId, id, model) path = "/api/
417457
def update_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
418458
put(path, model, {}, AvaTax::VERSION) end
419459

460+
# Update Certificate Custom Fields
461+
#
462+
# Updates the values of custom fields for a certificate
463+
#
464+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
465+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
466+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
467+
# certificate storage for this company, call `RequestCertificateSetup`.
468+
#
469+
# ### Security Policies
470+
#
471+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
472+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
473+
# Swagger Name: AvaTaxClient
474+
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
475+
# @param id [Integer] The unique ID number of this certificate
476+
# @param model [Object] The request model containing updated custom field values
477+
# @return []
478+
def update_certificate_custom_fields(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
479+
put(path, model, {}, AvaTax::VERSION) end
480+
420481
# Upload an image or PDF attachment for this certificate
421482
#
422483
# Upload an image or PDF attachment for this certificate.

‎lib/avatax/client/customers.rb

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,27 @@ def create_customers(companyId, model) path = "/api/v2/companies/#{compan
5858
def delete_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
5959
delete(path, {}, AvaTax::VERSION) end
6060

61+
# Delete custom fields
62+
#
63+
# Deletes the value of the custom field.
64+
#
65+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
66+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
67+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
68+
# certificate storage for this company, call `RequestCertificateSetup`.
69+
#
70+
# ### Security Policies
71+
#
72+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
73+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
74+
# Swagger Name: AvaTaxClient
75+
# @param companyId [Integer] The unique ID number of the company that recorded this customer
76+
# @param customerCode [String] The unique code representing this customer
77+
# @param model [DeleteCustomFields[]] Delete custom fields request model
78+
# @return []
79+
def delete_custom_fields(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/custom-fields"
80+
delete(path, model, {}, AvaTax::VERSION) end
81+
6182
# Retrieve a single customer
6283
#
6384
# Retrieve the customer identified by this URL.
@@ -263,6 +284,25 @@ def list_attributes_for_customer(companyId, customerCode) path = "/api/v2
263284
def list_certificates_for_customer(companyId, customerCode, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
264285
get(path, options, AvaTax::VERSION) end
265286

287+
# Retrieves a list of custom fields for a specified customer within a company.
288+
#
289+
# This API is used to retrieve custom field for a customer.
290+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
291+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
292+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
293+
# certificate storage for this company, call `RequestCertificateSetup`.
294+
#
295+
# ### Security Policies
296+
#
297+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
298+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
299+
# Swagger Name: AvaTaxClient
300+
# @param companyId [Integer] The unique ID number of the company that recorded this customer
301+
# @param customerCode [String] The unique code representing this customer
302+
# @return [Object]
303+
def list_custom_fields_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/custom-fields"
304+
get(path, {}, AvaTax::VERSION) end
305+
266306
# Retrieves a list of inactive certificates for a specified customer within a company.
267307
#
268308
# This API is used to retrieve inactive certificates for a customer. Inactive certificates may include expired,
@@ -441,6 +481,27 @@ def unlink_certificates_from_customer(companyId, customerCode, model) pat
441481
# @return [Object]
442482
def update_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
443483
put(path, model, {}, AvaTax::VERSION) end
484+
485+
# Update custom fields
486+
#
487+
# Update the value of the custom field.
488+
#
489+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
490+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
491+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
492+
# certificate storage for this company, call `RequestCertificateSetup`.
493+
#
494+
# ### Security Policies
495+
#
496+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
497+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
498+
# Swagger Name: AvaTaxClient
499+
# @param companyId [Integer] The unique ID number of the company that recorded this customer
500+
# @param customerCode [String] The unique code representing this customer
501+
# @param model [Object] Update custom fields request model
502+
# @return []
503+
def update_custom_fields(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/custom-fields"
504+
put(path, model, {}, AvaTax::VERSION) end
444505
end
445506
end
446507
end

‎lib/avatax/client/taxcontent.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module TaxContent
2727
# This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
2828
# file for a single location at a time, please use `BuildTaxContentFileForLocation`.
2929
#
30-
# NOTE: This API does not work for Tennessee tax holiday scenarios.
30+
# NOTE: This API does not work for sales tax holiday scenarios.
3131
#
3232
# ### Security Policies
3333
#
@@ -63,7 +63,7 @@ def build_tax_content_file(model) path = "/api/v2/pointofsaledata/build"
6363
# This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
6464
# file for a multiple locations in a single file, please use `BuildTaxContentFile`.
6565
#
66-
# NOTE: This API does not work for Tennessee tax holiday scenarios.
66+
# NOTE: This API does not work for sales tax holiday scenarios.
6767
#
6868
# ### Security Policies
6969
#

‎lib/avatax/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module AvaTax
2-
VERSION = '25.3.0'.freeze unless defined?(::AvaTax::VERSION)
2+
VERSION = '25.3.2'.freeze unless defined?(::AvaTax::VERSION)
33
end

0 commit comments

Comments
 (0)