avatax 21.9.0 → 22.2.0

data/lib/avatax/client/taxcodes.rb

@@ -14,11 +14,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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 code.
       # @param model [TaxCodeModel[]] The tax code you wish to create.
       # @return [TaxCodeModel[]]
       def create_tax_codes(companyId, model)        path = "/api/v2/companies/#{companyId}/taxcodes"
-        post(path, model)      end
+        post(path, model, {}, "22.2.0")      end
 
       # Delete a single tax code
       #
@@ -27,11 +28,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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 code.
       # @param id [Integer] The ID of the tax code you wish to delete.
       # @return [ErrorDetail[]]
       def delete_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        delete(path)      end
+        delete(path, {}, "22.2.0")      end
 
       # Retrieve a single tax code
       #
@@ -44,11 +46,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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 code
       # @param id [Integer] The primary key of this tax code
       # @return [Object]
       def get_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        get(path)      end
+        get(path, {}, "22.2.0")      end
 
       # Retrieve tax codes for this company
       #
@@ -64,6 +67,7 @@ module AvaTax
       # ### Security Policies
       #
       # * 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 codes
       # @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 include [String] A comma separated list of additional data to retrieve.
@@ -72,7 +76,7 @@ module AvaTax
       # @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_codes_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxcodes"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Retrieve all tax codes
       #
@@ -88,6 +92,7 @@ module AvaTax
       # ### Security Policies
       #
       # * 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/).
       # @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.
@@ -95,7 +100,7 @@ module AvaTax
       # @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_codes(options={})        path = "/api/v2/taxcodes"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Update a single tax code
       #
@@ -110,12 +115,13 @@ module AvaTax
       # ### Security Policies
       #
       # * 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 code belongs to.
       # @param id [Integer] The ID of the tax code you wish to update
       # @param model [Object] The tax code you wish to update.
       # @return [Object]
       def update_tax_code(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        put(path, model)      end
+        put(path, model, {}, "22.2.0")      end
     end
   end
 end

data/lib/avatax/client/taxcontent.rb

@@ -33,10 +33,11 @@ module AvaTax
       #
       # * 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:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
       # @return [Object]
       def build_tax_content_file(model)        path = "/api/v2/pointofsaledata/build"
-        post(path, model)      end
+        post(path, model, {}, "22.2.0")      end
 
       # Build a tax content file for a single location
       #
@@ -68,6 +69,7 @@ module AvaTax
       #
       # * 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:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID number of the company that owns this location.
       # @param id [Integer] The ID number of the location to retrieve point-of-sale data.
       # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default)
@@ -76,7 +78,7 @@ module AvaTax
       # @param includeJurisCodes [Boolean] When true, the file will include jurisdiction codes in the result.
       # @return [Object]
       def build_tax_content_file_for_location(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Download a file listing tax rates by postal code
       #
@@ -124,11 +126,12 @@ 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.
+      # Swagger Name: AvaTaxClient	  
       # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
       # @param region [String] A two character region code which limits results to a specific region.
       # @return [Object]
       def download_tax_rates_by_zip_code(date, options={})        path = "/api/v2/taxratesbyzipcode/download/#{date}"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Sales tax rates for a specified address
       #
@@ -152,6 +155,7 @@ module AvaTax
       #
       # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
+      # Swagger Name: AvaTaxClient	  
       # @param line1 [String] The street address of the location.
       # @param line2 [String] The street address of the location.
       # @param line3 [String] The street address of the location.
@@ -161,7 +165,7 @@ module AvaTax
       # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @return [Object]
       def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
       #
@@ -187,11 +191,12 @@ module AvaTax
       #
       # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
+      # Swagger Name: AvaTaxClient	  
       # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @param postalCode [String] The postal code of the location.
       # @return [Object]
       def tax_rates_by_postal_code(options={})        path = "/api/v2/taxrates/bypostalcode"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
     end
   end
 end

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

@@ -22,11 +22,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, model, {}, "22.2.0")      end
 
       # Delete a single tax rule
       #
@@ -47,11 +48,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        delete(path, {}, "22.2.0")      end
 
       # Retrieve a single tax rule
       #
@@ -72,11 +74,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        get(path, {}, "22.2.0")      end
 
       # Retrieve tax rules for this company
       #
@@ -100,6 +103,7 @@ module AvaTax
       # ### Security Policies
       #
       # * 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, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis
       # @param include [String] A comma separated list of additional data to retrieve.
@@ -108,7 +112,7 @@ module AvaTax
       # @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
+        get(path, options, "22.2.0")      end
 
       # Retrieve all tax rules
       #
@@ -132,6 +136,7 @@ module AvaTax
       # ### Security Policies
       #
       # * 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.
@@ -139,7 +144,7 @@ module AvaTax
       # @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
+        get(path, options, "22.2.0")      end
 
       # Update a single tax rule
       #
@@ -160,12 +165,13 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        put(path, model, {}, "22.2.0")      end
     end
   end
 end