avatax 20.5.0 → 20.6.0

data/lib/avatax/client/avafileforms.rb

@@ -1,79 +1,94 @@
-module AvaTax
-  class Client
-    module AvaFileForms 
-
-
-      # Create a new AvaFileForm
-      #
+module AvaTax
+  class Client
+    module AvaFileForms 
+
+
+      # Create a new AvaFileForm
+      #
       # Create one or more AvaFileForms
       # A 'AvaFileForm' represents a form supported by our returns team
       #
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
-      # @return [AvaFileFormModel[]]
-      def create_ava_file_forms(model)        path = "/api/v2/avafileforms"
-        post(path, model)      end
-
-      # Delete a single AvaFileForm
-      #
+      # @return [AvaFileFormModel[]]
+      def create_ava_file_forms(model)
+        path = "/api/v2/avafileforms"
+        post(path, model)
+      end
+
+
+      # Delete a single AvaFileForm
+      #
       # Marks the existing AvaFileForm object at this URL as deleted.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param id [Integer] The ID of the AvaFileForm you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_ava_file_form(id)        path = "/api/v2/avafileforms/#{id}"
-        delete(path)      end
-
-      # Retrieve a single AvaFileForm
-      #
+      # @return [ErrorDetail[]]
+      def delete_ava_file_form(id)
+        path = "/api/v2/avafileforms/#{id}"
+        delete(path)
+      end
+
+
+      # Retrieve a single AvaFileForm
+      #
       # Get the AvaFileForm object identified by this URL.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param id [Integer] The primary key of this AvaFileForm
-      # @return [Object]
-      def get_ava_file_form(id)        path = "/api/v2/avafileforms/#{id}"
-        get(path)      end
-
-      # Retrieve all AvaFileForms
-      #
+      # @return [Object]
+      def get_ava_file_form(id)
+        path = "/api/v2/avafileforms/#{id}"
+        get(path)
+      end
+
+
+      # Retrieve all AvaFileForms
+      #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @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:* outletTypeId
       # @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.
       # @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 query_ava_file_forms(options={})        path = "/api/v2/avafileforms"
-        get(path, options)      end
-
-      # Update a AvaFileForm
-      #
+      # @return [FetchResult]
+      def query_ava_file_forms(options={})
+        path = "/api/v2/avafileforms"
+        get(path, options)
+      end
+
+
+      # Update a AvaFileForm
+      #
       # All data from the existing object will be replaced with data in the object you PUT.
       # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
       #
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param id [Integer] The ID of the AvaFileForm you wish to update
       # @param model [Object] The AvaFileForm model you wish to update.
-      # @return [Object]
-      def update_ava_file_form(id, model)        path = "/api/v2/avafileforms/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_ava_file_form(id, model)
+        path = "/api/v2/avafileforms/#{id}"
+        put(path, model)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/batches.rb

@@ -1,10 +1,37 @@
-module AvaTax
-  class Client
-    module Batches 
-
-
-      # Create a new batch
-      #
+module AvaTax
+  class Client
+    module Batches 
+
+
+      # Cancel an in progress batch
+      #
+      # Marks the in progress batch identified by this URL as cancelled.
+      #
+      # Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message.
+      #
+      # Only in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message.
+      # Cancelling an in progress batch does not delete any transactions that were created before the cancellation.
+      #
+      # Because the batch system processes with a degree of concurrency, and
+      # because of batch sizes in the queue vary, AvaTax API is unable to accurately
+      # predict when a batch will complete. If high performance processing is
+      # required, please use the
+      # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this batch.
+      # @param id [Integer] The ID of the batch to cancel.
+      # @return [Object]
+      def cancel_batch(companyId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
+        post(path)
+      end
+
+
+      # Create a new batch
+      #
       # Create one or more new batch objects attached to this company.
       #
       # Each batch object may have one or more file objects (currently only one file is supported).
@@ -27,15 +54,50 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param model [BatchModel[]] The batch you wish to create.
-      # @return [BatchModel[]]
-      def create_batches(companyId, model)        path = "/api/v2/companies/#{companyId}/batches"
-        post(path, model)      end
-
-      # Delete a single batch
-      #
+      # @return [BatchModel[]]
+      def create_batches(companyId, model)
+        path = "/api/v2/companies/#{companyId}/batches"
+        post(path, model)
+      end
+
+
+      # Create a new transaction batch
+      #
+      # Create a new transaction batch objects attached to this company.
+      #
+      # When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be
+      # processed as quickly as possible in the order it was received. To check the
+      # status of a batch, fetch the batch and retrieve the results of the batch
+      # operation.
+      #
+      # Because the batch system processes with a degree of concurrency, and
+      # because of batch sizes in the queue vary, AvaTax API is unable to accurately
+      # predict when a batch will complete. If high performance processing is
+      # required, please use the
+      # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
+      #
+      # The maximum content length of the request body is limited to 28.6 MB. If this limit
+      # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
+      # the API is called from a browser). In this situation, please split the request into
+      # smaller batches.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this batch.
+      # @param model [Object] The transaction batch you wish to create.
+      # @return [Object]
+      def create_transaction_batch(companyId, model)
+        path = "/api/v2/companies/#{companyId}/batches/transactions"
+        post(path, model)
+      end
+
+
+      # Delete a single batch
+      #
       # Marks the batch identified by this URL as deleted.
       #
       # If you attempt to delete a batch that is being processed, you will receive an error message.
@@ -49,29 +111,35 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param id [Integer] The ID of the batch to delete.
-      # @return [ErrorDetail[]]
-      def delete_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        delete(path)      end
-
-      # Download a single batch file
-      #
+      # @return [ErrorDetail[]]
+      def delete_batch(companyId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        delete(path)
+      end
+
+
+      # Download a single batch file
+      #
       # Download a single batch file identified by this URL.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns this batch
       # @param batchId [Integer] The ID of the batch object
       # @param id [Integer] The primary key of this batch file object
-      # @return [Object]
-      def download_batch(companyId, batchId, id)        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
-        get(path)      end
-
-      # Retrieve a single batch
-      #
+      # @return [Object]
+      def download_batch(companyId, batchId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
+        get(path)
+      end
+
+
+      # Retrieve a single batch
+      #
       # Get the batch object identified by this URL. A batch object is a large
       # collection of API calls stored in a compact file.
       #
@@ -90,15 +158,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns this batch
       # @param id [Integer] The primary key of this batch
-      # @return [Object]
-      def get_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        get(path)      end
-
-      # Retrieve all batches for this company
-      #
+      # @return [Object]
+      def get_batch(companyId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        get(path)
+      end
+
+
+      # Retrieve all batches for this company
+      #
       # List all batch objects attached to the specified company.
       #
       # A batch object is a large collection of API calls stored in a compact file.
@@ -123,19 +194,22 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns these batches
       # @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:* files
       # @param include [String] A comma separated list of additional data to retrieve.
       # @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.
       # @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_batches_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/batches"
-        get(path, options)      end
-
-      # Retrieve all batches
-      #
+      # @return [FetchResult]
+      def list_batches_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/batches"
+        get(path, options)
+      end
+
+
+      # Retrieve all batches
+      #
       # Get multiple batch objects across all companies.
       #
       # A batch object is a large collection of API calls stored in a compact file.
@@ -157,15 +231,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
       # @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:* files
       # @param include [String] A comma separated list of additional data to retrieve.
       # @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.
       # @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 query_batches(options={})        path = "/api/v2/batches"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def query_batches(options={})
+        path = "/api/v2/batches"
+        get(path, options)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/certexpressinvites.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module CertExpressInvites 
-
-
-      # Create a CertExpress invitation
-      #
+module AvaTax
+  class Client
+    module CertExpressInvites 
+
+
+      # Create a CertExpress invitation
+      #
       # Creates an invitation for a customer to self-report certificates using the CertExpress website.
       #
       # This invitation is delivered by your choice of method, or you can present a hyperlink to the user
@@ -24,16 +24,19 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @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
-      # @return [CertExpressInvitationStatusModel[]]
-      def create_cert_express_invitation(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
-        post(path, model)      end
-
-      # Retrieve a single CertExpress invitation
-      #
+      # @return [CertExpressInvitationStatusModel[]]
+      def create_cert_express_invitation(companyId, customerCode, model)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
+        post(path, model)
+      end
+
+
+      # Retrieve a single CertExpress invitation
+      #
       # Retrieve an existing CertExpress invitation sent to a customer.
       #
       # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
@@ -53,17 +56,20 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @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
       # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
-      # @return [Object]
-      def get_cert_express_invitation(companyId, customerCode, id, options={})        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
-        get(path, options)      end
-
-      # List CertExpress invitations
-      #
+      # @return [Object]
+      def get_cert_express_invitation(companyId, customerCode, id, options={})
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
+        get(path, options)
+      end
+
+
+      # List CertExpress invitations
+      #
       # Retrieve CertExpress invitations sent by this company.
       #
       # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
@@ -83,16 +89,19 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @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/).<br />*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink
       # @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.
       # @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_cert_express_invitations(companyId, options={})        path = "/api/v2/companies/#{companyId}/certexpressinvites"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def list_cert_express_invitations(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/certexpressinvites"
+        get(path, options)
+      end
+
+    end
+  end
 end