avatax 21.7.1 → 21.12.0

data/lib/avatax/client/nexus.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Nexus 
-
-
-      # Create a new nexus
-      #
+module AvaTax
+  class Client
+    module Nexus 
+
+
+      # Create a new nexus
+      #
       # Creates one or more new nexus declarations attached to this company.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -27,15 +27,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param model [NexusModel[]] The nexus you wish to create.
-      # @return [NexusModel[]]
-      def create_nexus(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus"
-        post(path, model)      end
-
-      # Add parameters to a nexus.
-      #
+      # @return [NexusModel[]]
+      def create_nexus(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus"
+        post(path, model, {}, "21.12.0")      end
+
+      # Add parameters to a nexus.
+      #
       # Add parameters to the nexus.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -49,16 +50,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this nexus parameter.
       # @param nexusId [Integer] The nexus id.
       # @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
-      # @return [NexusParameterDetailModel[]]
-      def create_nexus_parameters(companyId, nexusId, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
-        post(path, model)      end
-
-      # Creates nexus for a list of addresses.
-      #
+      # @return [NexusParameterDetailModel[]]
+      def create_nexus_parameters(companyId, nexusId, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        post(path, model, {}, "21.12.0")      end
+
+      # Creates nexus for a list of addresses.
+      #
       # This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
       # API declares nexus for this company, for the list of addresses provided,
       # for the date range provided. You may also use this API to extend effective date on an already-declared nexus.
@@ -77,15 +79,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that will own this nexus.
       # @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
-      # @return [NexusByAddressModel[]]
-      def declare_nexus_by_address(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
-        post(path, model)      end
-
-      # Delete a single nexus
-      #
+      # @return [NexusByAddressModel[]]
+      def declare_nexus_by_address(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
+        post(path, model, {}, "21.12.0")      end
+
+      # Delete a single nexus
+      #
       # Marks the existing nexus object at this URL as deleted.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -97,16 +100,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param id [Integer] The ID of the nexus you wish to delete.
       # @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
-      # @return [ErrorDetail[]]
-      def delete_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        delete(path, options)      end
-
-      # Delete a single nexus parameter
-      #
+      # @return [ErrorDetail[]]
+      def delete_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        delete(path, options, "21.12.0")      end
+
+      # Delete a single nexus parameter
+      #
       # Delete a single nexus parameter.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -116,16 +120,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company id
       # @param nexusId [Integer] The nexus id
       # @param id [Integer] The parameter id
-      # @return [ErrorDetail[]]
-      def delete_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
-        delete(path)      end
-
-      # Delete all parameters for an nexus
-      #
+      # @return [ErrorDetail[]]
+      def delete_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        delete(path, {}, "21.12.0")      end
+
+      # Delete all parameters for an nexus
+      #
       # Delete all the parameters for a given nexus.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -135,15 +140,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
-      # @return [ErrorDetail[]]
-      def delete_nexus_parameters(companyId, nexusId)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
-        delete(path)      end
-
-      # Retrieve a single nexus
-      #
+      # @return [ErrorDetail[]]
+      def delete_nexus_parameters(companyId, nexusId)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        delete(path, {}, "21.12.0")      end
+
+      # Retrieve a single nexus
+      #
       # Get the nexus object identified by this URL.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -155,16 +161,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this nexus object
       # @param id [Integer] The primary key of this nexus
       # @param include [String] 
-      # @return [Object]
-      def get_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        get(path, options)      end
-
-      # List company nexus related to a tax form
-      #
+      # @return [Object]
+      def get_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        get(path, options, "21.12.0")      end
+
+      # List company nexus related to a tax form
+      #
       # Retrieves a list of nexus related to a tax form.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -180,16 +187,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this nexus object
       # @param formCode [String] The form code that we are looking up the nexus for
       # @param include [String] 
-      # @return [Object]
-      def get_nexus_by_form_code(companyId, formCode, options={})        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
-        get(path, options)      end
-
-      # Retrieve a single nexus parameter
-      #
+      # @return [Object]
+      def get_nexus_by_form_code(companyId, formCode, options={})        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve a single nexus parameter
+      #
       # Retrieve a single nexus parameter.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -199,16 +207,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company id
       # @param nexusId [Integer] The nexus id
       # @param id [Integer] The parameter id
-      # @return [Object]
-      def get_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
-        get(path)      end
-
-      # Retrieve nexus for this company
-      #
+      # @return [Object]
+      def get_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        get(path, {}, "21.12.0")      end
+
+      # Retrieve nexus for this company
+      #
       # List all nexus objects defined for this company.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -223,19 +232,49 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these nexus objects
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
+      # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
       # @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_nexus_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/nexus"
-        get(path, options)      end
-
-      # Retrieve parameters for a nexus
+      # @return [FetchResult]
+      def list_nexus_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/nexus"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve nexus for this company By TaxTypeGroup
+      #
+      # List all nexus objects defined for this company filtered by TaxTypeGroup.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
+      #
+      # 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.
+      # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
+      #
+      #  * Parameters
+      #
+      # ### Security Policies
       #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The ID of the company that owns these nexus objects
+      # @param taxTypeGroup [String] Name of TaxTypeGroup to filter by
+      # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
+      # @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_nexus_by_company_and_tax_type_group(companyId, taxTypeGroup, options={})        path = "/api/v2/companies/#{companyId}/nexus/byTaxTypeGroup/#{taxTypeGroup}"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve parameters for a nexus
+      #
       # List parameters for a nexus.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -248,19 +287,20 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company id
       # @param nexusId [Integer] The nexus id
       # @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:* name, unit
       # @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_nexus_parameters(companyId, nexusId, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
-        get(path, options)      end
-
-      # Retrieve all nexus
-      #
+      # @return [FetchResult]
+      def list_nexus_parameters(companyId, nexusId, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve all nexus
+      #
       # Get multiple nexus objects across all companies.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -275,18 +315,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, 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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
+      # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
       # @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_nexus(options={})        path = "/api/v2/nexus"
-        get(path, options)      end
-
-      # Update a single nexus
-      #
+      # @return [FetchResult]
+      def query_nexus(options={})        path = "/api/v2/nexus"
+        get(path, options, "21.12.0")      end
+
+      # Update a single nexus
+      #
       # Replace the existing nexus declaration object at this URL with an updated object.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -309,16 +350,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that this nexus belongs to.
       # @param id [Integer] The ID of the nexus you wish to update
       # @param model [Object] The nexus object you wish to update.
-      # @return [Object]
-      def update_nexus(companyId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        put(path, model)      end
-
-      # Update an nexus parameter
-      #
+      # @return [Object]
+      def update_nexus(companyId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        put(path, model, {}, "21.12.0")      end
+
+      # Update an nexus parameter
+      #
       # Update an nexus parameter.
       #
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
@@ -329,14 +371,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company id.
       # @param nexusId [Integer] The nexus id
       # @param id [Integer] The nexus parameter id
       # @param model [Object] The nexus object you wish to update.
-      # @return [Object]
-      def update_nexus_parameter(companyId, nexusId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_nexus_parameter(companyId, nexusId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        put(path, model, {}, "21.12.0")      end
+    end
+  end
 end

data/lib/avatax/client/notices.rb

@@ -5,53 +5,57 @@ module AvaTax
 
       # Creates a new tax notice responsibility type.
       #
-      # This API is available by invitation only and only available for users with Compliance admin access.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # This API is available by invitation only and only available for users with Compliance admin access.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param model [Object] The responsibility type to create
+      # Swagger Name: AvaTaxClient	  
+      # @param model [Object] The responsibility type to create
       # @return [Object]
       def create_notice_responsibility_type(model)        path = "/api/v2/notices/responsibilities"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Creates a new tax notice root cause type.
       #
-      # This API is available by invitation only and only available for users with Compliance admin access.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # This API is available by invitation only and only available for users with Compliance admin access.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param model [Object] The root cause type to create
+      # Swagger Name: AvaTaxClient	  
+      # @param model [Object] The root cause type to create
       # @return [Object]
       def create_notice_root_cause_type(model)        path = "/api/v2/notices/rootcauses"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Delete a tax notice responsibility type.
       #
-      # This API is available by invitation only and only available for users with Compliance admin access.
-      #
-      # ### Security Policies
-      #
+      # This API is available by invitation only and only available for users with Compliance admin access.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param responsibilityId [Integer] The unique ID of the responsibility type
+      # Swagger Name: AvaTaxClient	  
+      # @param responsibilityId [Integer] The unique ID of the responsibility type
       # @return [ErrorDetail[]]
       def delete_notice_responsibility_type(responsibilityId)        path = "/api/v2/notices/responsibilities/#{responsibilityId}"
-        delete(path)      end
+        delete(path, {}, "21.12.0")      end
 
       # Delete a tax notice root cause type.
       #
-      # This API is available by invitation only and only available for users with Compliance admin access.
-      #
-      # ### Security Policies
-      #
+      # This API is available by invitation only and only available for users with Compliance admin access.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param rootCauseId [Integer] The unique ID of the root cause type
+      # Swagger Name: AvaTaxClient	  
+      # @param rootCauseId [Integer] The unique ID of the root cause type
       # @return [ErrorDetail[]]
       def delete_notice_root_cause_type(rootCauseId)        path = "/api/v2/notices/rootcauses/#{rootCauseId}"
-        delete(path)      end
+        delete(path, {}, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/notifications.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Notifications 
-
-
-      # Mark a single notification as dismissed.
-      #
+module AvaTax
+  class Client
+    module Notifications 
+
+
+      # Mark a single notification as dismissed.
+      #
       # Marks the notification identified by this URL as dismissed.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -22,14 +22,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The id of the notification you wish to mark as dismissed.
-      # @return [Object]
-      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
-        put(path)      end
-
-      # Retrieve a single notification.
-      #
+      # @return [Object]
+      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
+        put(path, {}, "21.12.0")      end
+
+      # Retrieve a single notification.
+      #
       # Retrieve a single notification by its unique ID number.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -41,14 +42,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The id of the notification to retrieve.
-      # @return [Object]
-      def get_notification(id)        path = "/api/v2/notifications/#{id}"
-        get(path)      end
-
-      # List all notifications.
-      #
+      # @return [Object]
+      def get_notification(id)        path = "/api/v2/notifications/#{id}"
+        get(path, {}, "21.12.0")      end
+
+      # List all notifications.
+      #
       # List all notifications.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -63,14 +65,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @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. 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_notifications(options={})        path = "/api/v2/notifications"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def list_notifications(options={})        path = "/api/v2/notifications"
+        get(path, options, "21.12.0")      end
+    end
+  end
 end

data/lib/avatax/client/provisioning.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Provisioning 
-
-
-      # Request a new Avalara account
-      #
+module AvaTax
+  class Client
+    module Provisioning 
+
+
+      # Request a new Avalara account
+      #
       # This API is for use by partner provisioning services customers only.
       #
       # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
@@ -24,14 +24,15 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] Information about the account you wish to create and the selected product offerings.
-      # @return [Object]
-      def request_new_account(model)        path = "/api/v2/accounts/request"
-        post(path, model)      end
-
-      # Request a new entitilement to an existing customer
-      #
+      # @return [Object]
+      def request_new_account(model)        path = "/api/v2/accounts/request"
+        post(path, model, {}, "21.12.0")      end
+
+      # Request a new entitilement to an existing customer
+      #
       # This API is for use by partner provisioning services customers only. This will allow the partners to allow
       # the add new entitlement to an existing customer
       #
@@ -39,12 +40,13 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The avatax account id of the customer
       # @param offer [String] The offer to be added to an already existing customer
-      # @return [Object]
-      def request_new_entitlement(id, offer)        path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
-        post(path)      end
-    end
-  end
+      # @return [Object]
+      def request_new_entitlement(id, offer)        path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
+        post(path, {}, "21.12.0")      end
+    end
+  end
 end