avatax 18.1.2 → 18.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457c4dafa0d29a7d825c3d1277ca28a49a0168f86f5c9d643392f1e4900a8609
-  data.tar.gz: e7ea4c2f210a60e04ffe4b4313e6a6127a58a1ce9bae38054b88276eeb8d3752
+  metadata.gz: 355cf5ee71fbeb8b960cf1944d959ca8dc81a59d2f1917dc0021b38e939dccc8
+  data.tar.gz: f5599aa2d9cf2307f3e09ee6a006e0da035a5fe1681ed50699ab85bf7a07c074
 SHA512:
-  metadata.gz: 298f0645027870cd7f6e3730a79852d23b78646b5befa0850b3108ff572bc629b41215e5ffae24cdb50a0e085bdcb06d7548d14083d3cdeef1923503cd2ed6e0
-  data.tar.gz: d8ef94982822bb32bdb210cb3057f4b14dee22a610cf92c88ce99f45391255ab5da2b375210e6c9724712bc81a89e0faedad15bf4a990028e481e2af9a1f4242
+  metadata.gz: 8a5efe0d12112e77085d9831a02051c65e76786e8d6846249ff0f81b78b28e3ea95935b38e4f98600968a2b5bbf340ebaf419aab30483c44f30a9a3c5d2c3ab2
+  data.tar.gz: cec459683d2a5431a1a3b8fe5fe4b442a85c1e8504d74c0ae1d935f27ac01fca5f58dfcbcb792bff883e17f3251fc7ce818ba11a90e3f6d4239fe2dc075a6dc4

data/lib/avatax/client/certexpressinvites.rb

@@ -16,8 +16,10 @@ module AvaTax
       # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
       # your company so that they can be used for tax exemptions.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that will record certificates
       # @param customerCode [String] The number of the customer where the request is sent to
       # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
@@ -41,8 +43,10 @@ module AvaTax
       # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
       # your company so that they can be used for tax exemptions.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that issued this invitation
       # @param customerCode [String] The number of the customer where the request is sent to
       # @param id [Integer] The unique ID number of this CertExpress invitation
@@ -67,8 +71,10 @@ module AvaTax
       # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
       # your company so that they can be used for tax exemptions.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that issued this invitation
       # @param include [String] OPTIONAL: A comma separated list of special fetch options.       No options are defined at this time.
       # @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/) .

data/lib/avatax/client/certificates.rb

@@ -20,8 +20,10 @@ module AvaTax
       # * A link to the customer that is allowed to use this certificate
       # * Your tax transaction must contain the correct customer code
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The ID number of the company recording this certificate
       # @param model [CertificateModel[]] Certificates to be created
       # @return [CertificateModel[]]
@@ -42,8 +44,10 @@ module AvaTax
       #
       # Revoked certificates can no longer be used.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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 [Object]
@@ -65,8 +69,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.
@@ -93,8 +99,10 @@ module AvaTax
       # * PoNumbers - Retrieves all PO numbers tied to the certificate.
       # * Attributes - Retrieves all attributes applied to the certificate.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.   * PoNumbers - Retrieves all PO numbers tied to the certificate.   * Attributes - Retrieves all attributes applied to the certificate.
@@ -105,6 +113,23 @@ module AvaTax
       end
 
 
+      # Check a company's exemption certificate status.
+      #
+      # Checks whether this company is configured to use exemption certificates in AvaTax.
+      #
+      # Exemption certificates are tracked through a different auditable data store than the one that
+      # holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call
+      # `GetCertificateSetup` to see if your company is configured to use the exemption certificate
+      # document store. To request setup, please call `RequestCertificateSetup` and your company will
+      # be configured with data storage in the auditable certificate system.
+      # @param companyId [Integer] The company ID to check
+      # @return [Object]
+      def get_certificate_setup(companyId)
+        path = "/api/v2/companies/#{companyId}/certificates/setup"
+        get(path)
+      end
+
+
       # Link attributes to a certificate
       #
       # Link one or many attributes to a certificate.
@@ -117,8 +142,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.
@@ -142,8 +169,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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
@@ -166,8 +195,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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]
@@ -189,8 +220,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.
@@ -216,8 +249,10 @@ module AvaTax
       # * PoNumbers - Retrieves all PO numbers tied to the certificate.
       # * Attributes - Retrieves all attributes applied to the certificate.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.   * PoNumbers - 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/) .
@@ -231,6 +266,25 @@ module AvaTax
       end
 
 
+      # Request setup of exemption certificates for this company.
+      #
+      # Requests the setup of exemption certificates for this company.
+      #
+      # Exemption certificates are tracked through a different auditable data store than the one that
+      # holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call
+      # `GetCertificateSetup` to see if your company is configured to use the exemption certificate
+      # document store. To request setup, please call `RequestCertificateSetup` and your company will
+      # be configured with data storage in the auditable certificate system.
+      #
+      # This API will return the current status of exemption certificate setup for this company.
+      # @param companyId [Integer] 
+      # @return [Object]
+      def request_certificate_setup(companyId)
+        path = "/api/v2/companies/#{companyId}/certificates/setup"
+        post(path)
+      end
+
+
       # Unlink attributes from a certificate
       #
       # Unlink one or many attributes from a certificate.
@@ -243,8 +297,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.
@@ -269,8 +325,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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
@@ -290,8 +348,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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
@@ -314,8 +374,10 @@ module AvaTax
       # criteria you specify when you store the certificate. To view or manage your certificates directly, please
       # log onto the administrative website for the product you purchased.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @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.

data/lib/avatax/client/customers.rb

@@ -13,8 +13,10 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param model [CustomerModel[]] The list of customer objects to be created
       # @return [CustomerModel[]]
@@ -34,8 +36,10 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @return [Object]
@@ -59,8 +63,10 @@ module AvaTax
       #
       # * Certificates - Fetch a list of certificates linked to this customer.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param include [String] Specify optional additional objects to include in this fetch request
@@ -81,8 +87,10 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The list of certificates to link to this customer
@@ -103,8 +111,10 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @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.   * PoNumbers - Retrieves all PO numbers tied to the certificate.   * Attributes - Retrieves all attributes applied to the certificate.
@@ -132,8 +142,10 @@ module AvaTax
       # a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please
       # see the `CreateCertExpressInvitation` API to create an invitation link for this customer.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
@@ -159,8 +171,10 @@ module AvaTax
       #
       # * Certificates - Fetch a list of certificates linked to this customer.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
       # @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/) .
@@ -184,8 +198,10 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The list of certificates to link to this customer
@@ -206,8 +222,10 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
+      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
+      # storage for this company, call `RequestCertificateSetup`.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The new customer model that will replace the existing record at this URL

data/lib/avatax/client/definitions.rb

@@ -66,8 +66,8 @@ module AvaTax
       # A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
       # certificate at any time.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
+      # check and provision account.
       # @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/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -86,8 +86,8 @@ module AvaTax
       # An exemption reason defines why a certificate allows a customer to be exempt
       # for purposes of tax calculation.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
+      # check and provision account.
       # @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/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -106,8 +106,8 @@ module AvaTax
       # An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
       # authority or other legal entity to which a certificate may apply.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
+      # check and provision account.
       # @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/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -189,8 +189,8 @@ module AvaTax
       # upload certificates. An invitation allows customers to use CertExpress to upload their exemption
       # certificates directly; this cover letter explains why the invitation was sent.
       #
-      # You may experience up to a three minute delay on your very first call to the exemption related endpoints
-      # (as your account gets provisioned). Thank you for your patience.
+      # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
+      # check and provision account.
       # @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/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -236,6 +236,23 @@ module AvaTax
       end
 
 
+      # List all ISO 4217 currencies supported by AvaTax.
+      #
+      # Lists all ISO 4217 currencies supported by AvaTax.
+      #
+      # This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the
+      # `currencyCode` field in a `CreateTransactionModel`.
+      # @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/) .
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
+      def list_currencies(options={})
+        path = "/api/v2/definitions/currencies"
+        get(path, options)
+      end
+
+
       # Retrieve the full list of Avalara-supported entity use codes
       #
       # Returns the full list of Avalara-supported entity use codes.
@@ -653,6 +670,28 @@ module AvaTax
       end
 
 
+      # List all customs duty programs recognized by AvaTax
+      #
+      # List all preferred customs duty programs recognized by AvaTax.
+      #
+      # A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
+      # An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring
+      # countries.
+      #
+      # To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
+      # preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
+      # the program.
+      # @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/) .
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
+      def list_preferred_programs(options={})
+        path = "/api/v2/definitions/preferredprograms"
+        get(path, options)
+      end
+
+
       # Retrieve the full list of rate types for each country
       #
       # Returns the full list of Avalara-supported rate type file types

data/lib/avatax/client/distancethresholds.rb

@@ -73,7 +73,7 @@ module AvaTax
 
       # Retrieve all DistanceThreshold objects
       #
-      # Lists all DistanceThreshold objects that belong to this company.
+      # Lists all DistanceThreshold objects that belong to this account.
       #
       # A company-distance-threshold model indicates the distance between a company
       # and the taxing borders of various countries. Distance thresholds are necessary

data/lib/avatax/client/taxcontent.rb

@@ -63,7 +63,7 @@ module AvaTax
       # call the `CreateTransaction` API call. When using this file, your software will be unable to
       # handle complex tax rules such as:
       #
-      # * Zip+9 - This tax file does not contain
+      # * Zip+4 - This tax file contains five digit zip codes only.
       # * Different product types - This tax file contains tangible personal property tax rates only.
       # * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes.
       # * Threshold-based taxes - This tax file does not contain information about thresholds.
@@ -71,6 +71,8 @@ module AvaTax
       # If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction`
       # to reconcile the actual transaction and determine the difference between the estimated general tax
       # rate and the final transaction tax.
+      #
+      # For more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations.
       # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
       # @return [Object]
       def download_tax_rates_by_zip_code(date)

data/lib/avatax/client/transactions.rb

@@ -49,11 +49,12 @@ module AvaTax
       # no longer available for adjustments.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to adjust
+      # @param documentType [String] (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)
       # @param model [Object] The adjustment you wish to make
       # @return [Object]
-      def adjust_transaction(companyCode, transactionCode, model)
+      def adjust_transaction(companyCode, transactionCode, model, options={})
         path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
-        post(path, model)
+        post(path, model, options)
       end
 
 

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '18.1.2'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '18.2.0'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 18.1.2
+  version: 18.2.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake