avatax 21.8.0 → 22.2.0

data/lib/avatax/client/taxprofiles.rb

@@ -1,43 +1,43 @@
-module AvaTax
-  class Client
-    module TaxProfiles 
-
-
-      # Export the tax profile of this company to a backup file
-      #
-      # Exports the tax profile of a company to a file, containing all information that affects tax calculation for this company.
-      #
-      # A tax profile is a series of decisions and configuration choices that affect your company's tax calculation. These decisions
-      # include your nexus declarations, your item catalog, your custom tax rules, and so on.
-      #
-      # This API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this
-      # profile to a different company or compare it over time to see if your profile has been changed.
-      #
-      # ### 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 depends on the following active services<br />*Required* (all): AvaTaxPro.
-      # @param companyId [Integer] The unique ID number of the company whose profile you wish to retrieve.
-      # @return [Object]
-      def export_tax_profile(companyId)        path = "/api/v2/companies/#{companyId}/taxprofile"
-        get(path)      end
-
-      # Import a tax profile.
-      #
-      # Imports a tax profile to a new company, along with the option to import account settings.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
-      # @param accountId [Integer] The account id of the account to which the tax profile will be imported.
-      # @param newCompanyCode [String] The companyCode to use for the imported company.
-      # @param replaceAccountSettings [Boolean] Replace the current account settings with the ones in the tax profile.
-      # @param bypassNexusValidation [Boolean] Enable invalid nexus to be imported.
-      # @param taxProfile [Object] The taxProfile
-      # @return [Object]
-      def import_tax_profile()        path = "/api/v2/taxprofile"
-        post(path)      end
-    end
-  end
+module AvaTax
+  class Client
+    module TaxProfiles 
+
+
+      # Export the tax profile of this company to a backup file
+      #
+      # Exports the tax profile of a company to a file, containing all information that affects tax calculation for this company.
+      #
+      # A tax profile is a series of decisions and configuration choices that affect your company's tax calculation. These decisions
+      # include your nexus declarations, your item catalog, your custom tax rules, and so on.
+      #
+      # This API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this
+      # profile to a different company or compare it over time to see if your profile has been changed.
+      #
+      # ### 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 depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # @param companyId [Integer] The unique ID number of the company whose profile you wish to retrieve.
+      # @return [Object]
+      def export_tax_profile(companyId)        path = "/api/v2/companies/#{companyId}/taxprofile"
+        get(path)      end
+
+      # Import a tax profile.
+      #
+      # Imports a tax profile to a new company, along with the option to import account settings.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # @param accountId [Integer] The account id of the account to which the tax profile will be imported.
+      # @param newCompanyCode [String] The companyCode to use for the imported company.
+      # @param replaceAccountSettings [Boolean] Replace the current account settings with the ones in the tax profile.
+      # @param bypassNexusValidation [Boolean] Enable invalid nexus to be imported.
+      # @param taxProfile [Object] The taxProfile
+      # @return [Object]
+      def import_tax_profile()        path = "/api/v2/taxprofile"
+        post(path)      end
+    end
+  end
 end

data/lib/avatax/client/taxrules.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module TaxRules 
-
-
-      # Create a new tax rule
-      #
+module AvaTax
+  class Client
+    module TaxRules 
+
+
+      # Create a new tax rule
+      #
       # Create one or more custom tax rules attached to this company.
       #
       # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -21,15 +21,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 tax rule.
       # @param model [TaxRuleModel[]] The tax rule you wish to create.
-      # @return [TaxRuleModel[]]
-      def create_tax_rules(companyId, model)        path = "/api/v2/companies/#{companyId}/taxrules"
-        post(path, model)      end
-
-      # Delete a single tax rule
-      #
+      # @return [TaxRuleModel[]]
+      def create_tax_rules(companyId, model)        path = "/api/v2/companies/#{companyId}/taxrules"
+        post(path, model, {}, "22.2.0")      end
+
+      # Delete a single tax rule
+      #
       # Mark the custom tax rule identified by this URL as deleted.
       #
       # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -46,15 +47,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 tax rule.
       # @param id [Integer] The ID of the tax rule you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        delete(path)      end
-
-      # Retrieve a single tax rule
-      #
+      # @return [ErrorDetail[]]
+      def delete_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        delete(path, {}, "22.2.0")      end
+
+      # Retrieve a single tax rule
+      #
       # Get the taxrule object identified by this URL.
       #
       # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -71,15 +73,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this tax rule
       # @param id [Integer] The primary key of this tax rule
-      # @return [Object]
-      def get_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        get(path)      end
-
-      # Retrieve tax rules for this company
-      #
+      # @return [Object]
+      def get_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        get(path, {}, "22.2.0")      end
+
+      # Retrieve tax rules for this company
+      #
       # List all taxrule objects attached to this company.
       #
       # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -99,19 +102,20 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these tax rules
-      # @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:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
+      # @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:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis
       # @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_tax_rules(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxrules"
-        get(path, options)      end
-
-      # Retrieve all tax rules
-      #
+      # @return [FetchResult]
+      def list_tax_rules(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxrules"
+        get(path, options, "22.2.0")      end
+
+      # Retrieve all tax rules
+      #
       # Get multiple taxrule objects across all companies.
       #
       # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -131,18 +135,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis
       # @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_tax_rules(options={})        path = "/api/v2/taxrules"
-        get(path, options)      end
-
-      # Update a single tax rule
-      #
+      # @return [FetchResult]
+      def query_tax_rules(options={})        path = "/api/v2/taxrules"
+        get(path, options, "22.2.0")      end
+
+      # Update a single tax rule
+      #
       # Replace the existing custom tax rule object at this URL with an updated object.
       #
       # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -159,13 +164,14 @@ 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 tax rule belongs to.
       # @param id [Integer] The ID of the tax rule you wish to update
       # @param model [Object] The tax rule you wish to update.
-      # @return [Object]
-      def update_tax_rule(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_tax_rule(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        put(path, model, {}, "22.2.0")      end
+    end
+  end
 end