lib/avatax/client/certificates.rb in avatax-23.11.0 vs lib/avatax/client/certificates.rb in avatax-24.2.0
- old
+ new
@@ -28,11 +28,11 @@
# If the users specified in the certificates do not exist, the API will create the user and link them to the certificate
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The ID number of the company recording this certificate
# @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
# @param model [CertificateModel[]] Certificates to be created
# @return [CertificateModel[]]
@@ -56,11 +56,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @return [ErrorDetail[]]
def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
@@ -84,11 +84,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
# @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
@@ -117,11 +117,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
# @return [Object]
@@ -139,11 +139,11 @@
# be configured with data storage in the auditable certificate system.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The company ID to check
# @return [Object]
def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
get(path, {}, AvaTax::VERSION) end
@@ -166,11 +166,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
# @return [FetchResult]
@@ -196,11 +196,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param model [Object] The list of customers needed be added to the Certificate for exemption
# @return [FetchResult]
@@ -225,11 +225,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @return [FetchResult]
def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
@@ -253,11 +253,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
# @return [FetchResult]
@@ -285,11 +285,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The ID number of the company to search
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
@@ -312,11 +312,11 @@
# This API will return the current status of exemption certificate setup for this company.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer]
# @return [Object]
def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
post(path, {}, {}, AvaTax::VERSION) end
@@ -339,11 +339,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
# @return [FetchResult]
@@ -370,11 +370,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param model [Object] The list of customers to unlink from this certificate
# @return [FetchResult]
@@ -396,11 +396,11 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param model [Object] The new certificate object that will replace the existing one
# @return [Object]
@@ -425,10 +425,10 @@
# certificate storage for this company, call `RequestCertificateSetup`.
#
# ### Security Policies
#
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
# Swagger Name: AvaTaxClient
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
# @param id [Integer] The unique ID number of this certificate
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
# @return [String]
\ No newline at end of file