avatax 20.1.0 → 20.9.0

data/lib/avatax/client/advancedrules.rb

@@ -1,163 +1,64 @@
-module AvaTax
-  class Client
-    module AdvancedRules 
-
-
-      # Approve an advanced rule script to run.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @return [Object]
-      def approve_advanced_rule_script(accountId, scriptType)
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/approve"
-        post(path)
-      end
-
-
-      # Create an advanced rule.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that will own the Advanced Rule.
-      # @param scriptType [String] The script transform type, Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @param crashBehavior [String] The behavior the script should take if it crashes: Fail or Proceed. (See AdvancedRuleCrashBehavior::* for a list of allowable values)
-      # @param file [Object] The JavaScript file containing the advanced rule.
-      # @return [String]
-      def create_advanced_rule_script(accountId, scriptType, options={})
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}"
-        post(path, options)
-      end
-
-
-      # Create a lookup table for an advanced rule
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param csvTableName [String] The name to assign the CSV lookup table.
-      # @param file [Object] A CSV file containing lookup data for an advanced rule.
-      # @return [String]
-      def create_advanced_rule_table(accountId, csvTableName)
-        path = "/api/v2/accounts/#{accountId}/advancedruletables/#{csvTableName}"
-        post(path)
-      end
-
-
-      # Delete an account's active advanced rule
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @return [ErrorDetail[]]
-      def delete_advanced_rule_script(accountId, scriptType)
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}"
-        delete(path)
-      end
-
-
-      # Delete a lookup table for an advanced rule.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param csvTableName [String] The name of the CSV lookup table to delete.
-      # @return [ErrorDetail[]]
-      def delete_advanced_rule_table(accountId, csvTableName)
-        path = "/api/v2/accounts/#{accountId}/advancedruletables/#{csvTableName}"
-        delete(path)
-      end
-
-
-      # Disable an advanced rule so that it cannot be run.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration. ///
-      # @param accountId [Integer] 
-      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @return [Object]
-      def disable_advanced_rule_script(accountId, scriptType)
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/disable"
-        post(path)
-      end
-
-
-      # Enable an approved advanced rule so that it can be run.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] 
-      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @return [Object]
-      def enable_advanced_rule_script(accountId, scriptType)
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/enable"
-        post(path)
-      end
-
-
-      # Get an account's advanced rule script.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @return [Object]
-      def get_advanced_rule_script(accountId, scriptType)
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}"
-        get(path)
-      end
-
-
-      # Get an advanced rule lookup table for an account
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param csvTableName [String] The name of the CSV lookup table to get.
-      # @return [Object]
-      def get_advanced_rule_table(accountId, csvTableName)
-        path = "/api/v2/accounts/#{accountId}/advancedruletables/#{csvTableName}"
-        get(path)
-      end
-
-
-      # Get all advanced rule lookup tables for an account
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @return [Object]
-      def get_advanced_rule_tables(accountId)
-        path = "/api/v2/accounts/#{accountId}/advancedruletables"
-        get(path)
-      end
-
-
-      # Unapprove an advanced rule script so that it cannot be run.
-      #
-      # This API is available by invite only and implementation support is required.
-      # Please contact your Customer Account Manager if you are interested in using
-      # Advanced Rules in your AvaTax integration.
-      # @param accountId [Integer] The ID of the account that owns the Advanced Rule.
-      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
-      # @return [Object]
-      def unapprove_advanced_rule_script(accountId, scriptType)
-        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/unapprove"
-        post(path)
-      end
-
-    end
-  end
+module AvaTax
+  class Client
+    module AdvancedRules 
+
+
+      # Create a lookup file for a company
+      #
+      # 
+      # @param accountId [Integer] The ID of the account for the company
+      # @param companyId [Integer] The ID of the company for which the lookup file is to be created
+      # @param model [Object] The lookup file you wish to create
+      # @return [Object]
+      def create_company_lookup_file(accountId, companyId, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
+        post(path, model)      end
+
+      # Delete a lookup file
+      #
+      # 
+      # @param accountId [Integer] The ID of the account for the company the lookup file is for
+      # @param id [String] The unique ID/GUID for the company lookup file to be deleted
+      # @return [ErrorDetail[]]
+      def delete_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        delete(path)      end
+
+      # Get audit records by account id and date range.
+      #
+      # 
+      # @param accountId [Integer] The ID of the account
+      # @param fromDate [String] Date
+      # @param toDate [String] Date
+      # @return [Object]
+      def get_audit_records(accountId, fromDate, toDate)        path = "/api/v2/advancedrules/audits/accounts/#{accountId}/from/#{fromDate}/to/#{toDate}"
+        get(path)      end
+
+      # Get the lookup files for a company
+      #
+      # 
+      # @param accountId [Integer] The account ID for the company
+      # @param companyId [Integer] The ID of the company for which to retrieve lookup files
+      # @return [FetchResult]
+      def get_company_lookup_files(accountId, companyId)        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
+        get(path)      end
+
+      # Get a lookup file for an accountId and companyLookupFileId
+      #
+      # 
+      # @param accountId [Integer] The ID of the account for the lookup file
+      # @param id [String] The unique ID/GUID of the company lookup file to return
+      # @return [Object]
+      def get_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        get(path)      end
+
+      # Update a lookup file
+      #
+      # 
+      # @param accountId [Integer] The ID of the account for the company the lookup file is for
+      # @param id [String] The unique ID/GUID of the company lookup file to be updated
+      # @param model [Object] The new values to update the lookup file
+      # @return [Object]
+      def update_lookup_file(accountId, id, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/avafileforms.rb

@@ -1,79 +1,79 @@
-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.
-      # @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
-      #
-      # 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.
-      # @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
-      #
-      # 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.
-      # @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
-      #
-      # 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.
-      # @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
-      #
-      # 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.
-      # @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
+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.
+      # @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
+      #
+      # 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.
+      # @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
+      #
+      # 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.
+      # @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
+      #
+      # 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.
+      # @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
+      #
+      # 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.
+      # @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
 end

data/lib/avatax/client/batches.rb

@@ -1,171 +1,224 @@
-module AvaTax
-  class Client
-    module Batches 
-
-
-      # 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).
-      #
-      # When a batch is created, it is added to the AvaTax Batch 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 [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
-      #
-      # 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.
-      # Deleting a batch does not delete any transactions that were created by importing the batch.
-      #
-      # 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: 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
-      #
-      # 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.
-      # @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
-      #
-      # Get the batch object identified by this URL. A batch object is a large
-      # collection of API calls stored in a compact file.
-      #
-      # Use this endpoint to retrieve the results or check the status of a batch.
-      #
-      # When a batch is created, it is added to the AvaTax Batch 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/).
-      #
-      # ### Security Policies
-      #
-      # * 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
-      #
-      # List all batch objects attached to the specified company.
-      #
-      # A batch object is a large collection of API calls stored in a compact file.
-      #
-      # 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 results using the `$top`, `$skip`, and `$orderby` parameters.
-      #
-      # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
-      # to retrieve the results, or check the status, of an individual batch.
-      #
-      # When a batch is created, it is added to the AvaTax Batch 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/).
-      #
-      # ### Security Policies
-      #
-      # * 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
-      #
-      # Get multiple batch objects across all companies.
-      #
-      # A batch object is a large collection of API calls stored in a compact file.
-      #
-      # 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 results using the `$top`, `$skip`, and `$orderby` parameters.
-      #
-      # When a batch is created, it is added to the AvaTax Batch 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/).
-      #
-      # ### Security Policies
-      #
-      # * 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
+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).
+      #
+      # When a batch is created, it is added to the AvaTax Batch 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 [BatchModel[]] The batch you wish to create.
+      # @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.
+      # Deleting a batch does not delete any transactions that were created by importing the batch.
+      #
+      # 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: 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
+      #
+      # 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.
+      # @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
+      #
+      # Get the batch object identified by this URL. A batch object is a large
+      # collection of API calls stored in a compact file.
+      #
+      # Use this endpoint to retrieve the results or check the status of a batch.
+      #
+      # When a batch is created, it is added to the AvaTax Batch 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/).
+      #
+      # ### Security Policies
+      #
+      # * 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
+      #
+      # List all batch objects attached to the specified company.
+      #
+      # A batch object is a large collection of API calls stored in a compact file.
+      #
+      # 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 results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
+      # to retrieve the results, or check the status, of an individual batch.
+      #
+      # When a batch is created, it is added to the AvaTax Batch 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/).
+      #
+      # ### Security Policies
+      #
+      # * 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
+      #
+      # Get multiple batch objects across all companies.
+      #
+      # A batch object is a large collection of API calls stored in a compact file.
+      #
+      # 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 results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # When a batch is created, it is added to the AvaTax Batch 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/).
+      #
+      # ### Security Policies
+      #
+      # * 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
 end