avatax 21.8.0 → 22.2.0

data/lib/avatax/client/settings.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Settings 
-
-
-      # Create a new setting
-      #
+module AvaTax
+  class Client
+    module Settings 
+
+
+      # Create a new setting
+      #
       # Create one or more new setting objects attached to this company.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -23,15 +23,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param model [SettingModel[]] The setting you wish to create.
-      # @return [SettingModel[]]
-      def create_settings(companyId, model)        path = "/api/v2/companies/#{companyId}/settings"
-        post(path, model)      end
-
-      # Delete a single setting
-      #
+      # @return [SettingModel[]]
+      def create_settings(companyId, model)        path = "/api/v2/companies/#{companyId}/settings"
+        post(path, model, {}, "22.2.0")      end
+
+      # Delete a single setting
+      #
       # Mark the setting object at this URL as deleted.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -45,15 +46,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param id [Integer] The ID of the setting you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        delete(path)      end
-
-      # Retrieve a single setting
-      #
+      # @return [ErrorDetail[]]
+      def delete_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        delete(path, {}, "22.2.0")      end
+
+      # Retrieve a single setting
+      #
       # Get a single setting object by its unique ID.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -67,15 +69,16 @@ 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, ProStoresOperator, 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, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this setting
       # @param id [Integer] The primary key of this setting
-      # @return [Object]
-      def get_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        get(path)      end
-
-      # Retrieve all settings for this company
-      #
+      # @return [Object]
+      def get_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        get(path, {}, "22.2.0")      end
+
+      # Retrieve all settings for this company
+      #
       # List all setting objects attached to this company.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -92,19 +95,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, ProStoresOperator, 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, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these settings
       # @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:* modifiedDate, ModifiedUserId
       # @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_settings_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/settings"
-        get(path, options)      end
-
-      # Retrieve all settings
-      #
+      # @return [FetchResult]
+      def list_settings_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/settings"
+        get(path, options, "22.2.0")      end
+
+      # Retrieve all settings
+      #
       # Get multiple setting objects across all companies.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -121,18 +125,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, ProStoresOperator, 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, ProStoresOperator, 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:* modifiedDate, ModifiedUserId
       # @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_settings(options={})        path = "/api/v2/settings"
-        get(path, options)      end
-
-      # Update a single setting
-      #
+      # @return [FetchResult]
+      def query_settings(options={})        path = "/api/v2/settings"
+        get(path, options, "22.2.0")      end
+
+      # Update a single setting
+      #
       # Replace the existing setting object at this URL with an updated object.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -150,13 +155,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that this setting belongs to.
       # @param id [Integer] The ID of the setting you wish to update
       # @param model [Object] The setting you wish to update.
-      # @return [Object]
-      def update_setting(companyId, id, model)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_setting(companyId, id, model)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        put(path, model, {}, "22.2.0")      end
+    end
+  end
 end

data/lib/avatax/client/shippingverification.rb

@@ -0,0 +1,66 @@
+module AvaTax
+  class Client
+    module ShippingVerification 
+
+
+      # Removes the transaction from consideration when evaluating regulations that span multiple transactions.
+      #
+      # 
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param companyCode [String] The company code of the company that recorded the transaction
+      # @param transactionCode [String] The transaction code to retrieve
+      # @param documentType [String] (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"
+      # @return []
+      def deregister_shipment(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registration"
+        delete(path, options, "")      end
+
+      # Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+      #
+      # 
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param companyCode [String] The company code of the company that recorded the transaction
+      # @param transactionCode [String] The transaction code to retrieve
+      # @param documentType [String] (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"
+      # @return []
+      def register_shipment(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registration"
+        put(path, options, "")      end
+
+      # Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+      #
+      # 
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param companyCode [String] The company code of the company that recorded the transaction
+      # @param transactionCode [String] The transaction code to retrieve
+      # @param documentType [String] (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"
+      # @return [Object]
+      def register_shipment_if_compliant(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registerIfCompliant"
+        put(path, options, "")      end
+
+      # Evaluates a transaction against a set of direct-to-consumer shipping regulations.
+      #
+      # The transaction and its lines must meet the following criteria in order to be evaluated:
+      # * The transaction must be recorded. Using a type of *SalesInvoice* is recommended.
+      # * A parameter with the name *AlcoholRouteType* must be specified and the value must be one of the following: '*DTC*', '*Retailer DTC*'
+      # * A parameter with the name *RecipientName* must be specified and the value must be the name of the recipient.
+      # * Each alcohol line must include a *ContainerSize* parameter that describes the volume of a single container. Use the *unit* field to specify one of the following units: '*Litre*', '*Millilitre*', '*gallon (US fluid)*', '*quart (US fluid)*', '*ounce (fluid US customary)*'
+      # * Each alcohol line must include a *PackSize* parameter that describes the number of containers in a pack. Specify *Count* in the *unit* field.
+      #
+      # Optionally, the transaction and its lines may use the following parameters:
+      # * The *ShipDate* parameter may be used if the date of shipment is different than the date of the transaction. The value should be ISO-8601 compliant (e.g. 2020-07-21).
+      # * The *RecipientDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21).
+      # * The *PurchaserDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21).
+      # * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value.
+      # * The *AlcoholContent* parameter may be used to describe the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field.
+      #
+      # **Security Policies**
+      # This API depends on all of the following active subscriptions: *AvaAlcohol, AutoAddress, AvaTaxPro*
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param companyCode [String] The company code of the company that recorded the transaction
+      # @param transactionCode [String] The transaction code to retrieve
+      # @param documentType [String] (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"
+      # @return [Object]
+      def verify_shipment(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/verify"
+        get(path, options, "")      end
+    end
+  end
+end

data/lib/avatax/client/subscriptions.rb

@@ -1,25 +1,26 @@
-module AvaTax
-  class Client
-    module Subscriptions 
-
-
-      # Retrieve a single subscription
-      #
+module AvaTax
+  class Client
+    module Subscriptions 
+
+
+      # Retrieve a single subscription
+      #
       # Get the subscription object identified by this URL.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
       #
       # ### 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 accountId [Integer] The ID of the account that owns this subscription
       # @param id [Integer] The primary key of this subscription
-      # @return [Object]
-      def get_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        get(path)      end
-
-      # Retrieve subscriptions for this account
-      #
+      # @return [Object]
+      def get_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
+        get(path, {}, "22.2.0")      end
+
+      # Retrieve subscriptions for this account
+      #
       # List all subscription objects attached to this account.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
@@ -29,18 +30,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, 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 accountId [Integer] The ID of the account that owns these subscriptions
       # @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:* subscriptionDescription
       # @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_subscriptions_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/subscriptions"
-        get(path, options)      end
-
-      # Retrieve all subscriptions
-      #
+      # @return [FetchResult]
+      def list_subscriptions_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/subscriptions"
+        get(path, options, "22.2.0")      end
+
+      # Retrieve all subscriptions
+      #
       # Get multiple subscription objects across all accounts.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
@@ -50,14 +52,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 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:* subscriptionDescription
       # @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_subscriptions(options={})        path = "/api/v2/subscriptions"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def query_subscriptions(options={})        path = "/api/v2/subscriptions"
+        get(path, options, "22.2.0")      end
+    end
+  end
 end

data/lib/avatax/client/taxcodes.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module TaxCodes 
-
-
-      # Create a new tax code
-      #
+module AvaTax
+  class Client
+    module TaxCodes 
+
+
+      # Create a new tax code
+      #
       # Create one or more new taxcode objects attached to this company.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
@@ -13,28 +13,30 @@ 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 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
-
-      # Delete a single tax code
-      #
+      # @return [TaxCodeModel[]]
+      def create_tax_codes(companyId, model)        path = "/api/v2/companies/#{companyId}/taxcodes"
+        post(path, model, {}, "22.2.0")      end
+
+      # Delete a single tax code
+      #
       # Marks the existing TaxCode object at this URL as deleted.
       #
       # ### 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 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
-
-      # Retrieve a single tax code
-      #
+      # @return [ErrorDetail[]]
+      def delete_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        delete(path, {}, "22.2.0")      end
+
+      # Retrieve a single tax code
+      #
       # Get the taxcode object identified by this URL.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
@@ -43,15 +45,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 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
-
-      # Retrieve tax codes for this company
-      #
+      # @return [Object]
+      def get_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        get(path, {}, "22.2.0")      end
+
+      # Retrieve tax codes for this company
+      #
       # List all taxcode objects attached to this company.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
@@ -63,19 +66,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 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.
       # @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_codes_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxcodes"
-        get(path, options)      end
-
-      # Retrieve all tax codes
-      #
+      # @return [FetchResult]
+      def list_tax_codes_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxcodes"
+        get(path, options, "22.2.0")      end
+
+      # Retrieve all tax codes
+      #
       # Get multiple taxcode objects across all companies.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
@@ -87,18 +91,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.
+      # * 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.
       # @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_codes(options={})        path = "/api/v2/taxcodes"
-        get(path, options)      end
-
-      # Update a single tax code
-      #
+      # @return [FetchResult]
+      def query_tax_codes(options={})        path = "/api/v2/taxcodes"
+        get(path, options, "22.2.0")      end
+
+      # Update a single tax code
+      #
       # Replace the existing taxcode object at this URL with an updated object.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
@@ -109,13 +114,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 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
-    end
-  end
+      # @return [Object]
+      def update_tax_code(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        put(path, model, {}, "22.2.0")      end
+    end
+  end
 end

data/lib/avatax/client/taxcontent.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module TaxContent 
-
-
-      # Build a multi-location tax content file
-      #
+module AvaTax
+  class Client
+    module TaxContent 
+
+
+      # Build a multi-location tax content file
+      #
       # Builds a tax content file containing information useful for a retail point-of-sale solution.
       #
       # Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
@@ -32,14 +32,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 depends on the following active services:*Required* (all): AvaTaxPro.
+      # * 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
-
-      # Build a tax content file for a single location
-      #
+      # @return [Object]
+      def build_tax_content_file(model)        path = "/api/v2/pointofsaledata/build"
+        post(path, model, {}, "22.2.0")      end
+
+      # Build a tax content file for a single location
+      #
       # Builds a tax content file containing information useful for a retail point-of-sale solution.
       #
       # Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
@@ -67,19 +68,20 @@ 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 depends on the following active services:*Required* (all): AvaTaxPro.
+      # * 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)
       # @param format [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
       # @param partnerId [String] If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)
       # @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
-
-      # Download a file listing tax rates by postal code
-      #
+      # @return [Object]
+      def build_tax_content_file_for_location(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
+        get(path, options, "22.2.0")      end
+
+      # Download a file listing tax rates by postal code
+      #
       # Download a CSV file containing all five digit postal codes in the United States and their sales
       # and use tax rates for tangible personal property.
       #
@@ -123,15 +125,16 @@ 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 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
-
-      # Sales tax rates for a specified address
-      #
+      # @return [Object]
+      def download_tax_rates_by_zip_code(date, options={})        path = "/api/v2/taxratesbyzipcode/download/#{date}"
+        get(path, options, "22.2.0")      end
+
+      # Sales tax rates for a specified address
+      #
       # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
       # response code 429 - `Too Many Requests`.
       #
@@ -151,7 +154,8 @@ module AvaTax
       # * And more!
       #
       # 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.
+      # 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.
@@ -159,12 +163,12 @@ module AvaTax
       # @param region [String] Name or ISO 3166 code identifying the region within the country.     This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions     For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
       # @param postalCode [String] The postal code of the location.
       # @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
-
-      # Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
-      #
+      # @return [Object]
+      def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
+        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.
+      #
       # This API is only available for a US postal codes.
       #
       # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
@@ -186,12 +190,13 @@ module AvaTax
       # * And more!
       #
       # 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.
+      # 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
-    end
-  end
+      # @return [Object]
+      def tax_rates_by_postal_code(options={})        path = "/api/v2/taxrates/bypostalcode"
+        get(path, options, "22.2.0")      end
+    end
+  end
 end