avatax 21.9.0 → 22.2.0

data/lib/avatax/client/onboarding.rb

@@ -1,56 +1,56 @@
-module AvaTax
-  class Client
-    module Onboarding 
-
-
-      # Request a new Avalara account
-      #
-      # This API is for use by partner onboarding services customers only.
-      #
-      # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
-      # of AvaTax. These partners can create accounts for new customers using this API.
-      #
-      # Calling this API creates an account with the specified product subscriptions, but does not configure billing.
-      # The customer will receive information from Avalara about how to configure billing for their account.
-      # You should call this API when a customer has requested to begin using Avalara services.
-      #
-      # If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara
-      # terms and conditions. If they do so, they can receive a license key as part of this API and their
-      # API will be created in `Active` status. If the customer has not yet read and accepted these terms and
-      # conditions, the account will be created in `New` status and they can receive a license key by logging
-      # onto the AvaTax website and reviewing terms and conditions online.
-      #
-      # ### Security Policies
-      #
-      # * 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 [Onboarding:RequestNewAccount].
-      # @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
-      #
-      # This API is for use by partner onboarding services customers only. This will allow the partners to allow
-      # the add new entitlement to an existing customer
-      #
-      # ### Security Policies
-      #
-      # * 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 [Onboarding:RequestNewAccount].
-      # @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
+module AvaTax
+  class Client
+    module Onboarding 
+
+
+      # Request a new Avalara account
+      #
+      # This API is for use by partner onboarding services customers only.
+      #
+      # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
+      # of AvaTax. These partners can create accounts for new customers using this API.
+      #
+      # Calling this API creates an account with the specified product subscriptions, but does not configure billing.
+      # The customer will receive information from Avalara about how to configure billing for their account.
+      # You should call this API when a customer has requested to begin using Avalara services.
+      #
+      # If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara
+      # terms and conditions. If they do so, they can receive a license key as part of this API and their
+      # API will be created in `Active` status. If the customer has not yet read and accepted these terms and
+      # conditions, the account will be created in `New` status and they can receive a license key by logging
+      # onto the AvaTax website and reviewing terms and conditions online.
+      #
+      # ### Security Policies
+      #
+      # * 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 [Onboarding:RequestNewAccount].
+      # @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
+      #
+      # This API is for use by partner onboarding services customers only. This will allow the partners to allow
+      # the add new entitlement to an existing customer
+      #
+      # ### Security Policies
+      #
+      # * 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 [Onboarding:RequestNewAccount].
+      # @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
 end

data/lib/avatax/client/pointofsale.rb

@@ -1,22 +1,22 @@
-module AvaTax
-  class Client
-    module PointOfSale 
-
-
-      # Point of sale data file generation
-      #
-      # Builds a point-of-sale data file containing tax rates and rules for items and locations that can be used
-      # to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
-      # This data file can be customized for specific partner devices and usage conditions.
-      # The result of this API is the file you requested in the format you requested using the 'responseType' field.
-      # This API builds the file on demand, and is limited to files with no more than 7500 scenarios.
-      # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
-      # @return [Object]
-      def build_point_of_sale_data_file(model)
-        path = "/api/v2/pointofsaledata/build"
-        post(path, model)
-      end
-
-    end
-  end
+module AvaTax
+  class Client
+    module PointOfSale 
+
+
+      # Point of sale data file generation
+      #
+      # Builds a point-of-sale data file containing tax rates and rules for items and locations that can be used
+      # to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
+      # This data file can be customized for specific partner devices and usage conditions.
+      # The result of this API is the file you requested in the format you requested using the 'responseType' field.
+      # This API builds the file on demand, and is limited to files with no more than 7500 scenarios.
+      # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
+      # @return [Object]
+      def build_point_of_sale_data_file(model)
+        path = "/api/v2/pointofsaledata/build"
+        post(path, model)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/provisioning.rb

@@ -25,10 +25,11 @@ 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].
+      # 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
+        post(path, model, {}, "22.2.0")      end
 
       # Request a new entitilement to an existing customer
       #
@@ -40,11 +41,12 @@ 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].
+      # 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
+        post(path, {}, "22.2.0")      end
     end
   end
 end

data/lib/avatax/client/registrar.rb

@@ -14,10 +14,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] The account you wish to create.
       # @return [AccountModel[]]
       def create_account(model)        path = "/api/v2/accounts"
-        post(path, model)      end
+        post(path, model, {}, "22.2.0")      end
 
       # Create new notifications.
       #
@@ -39,10 +40,11 @@ module AvaTax
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
+      # Swagger Name: AvaTaxClient	  
       # @param model [NotificationModel[]] The notifications you wish to create.
       # @return [NotificationModel[]]
       def create_notifications(model)        path = "/api/v2/notifications"
-        post(path, model)      end
+        post(path, model, {}, "22.2.0")      end
 
       # Create a new subscription
       #
@@ -55,11 +57,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account that owns this subscription.
       # @param model [SubscriptionModel[]] The subscription you wish to create.
       # @return [SubscriptionModel[]]
       def create_subscriptions(accountId, model)        path = "/api/v2/accounts/#{accountId}/subscriptions"
-        post(path, model)      end
+        post(path, model, {}, "22.2.0")      end
 
       # Delete a single account
       #
@@ -72,10 +75,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role SystemAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the account you wish to delete.
       # @return [ErrorDetail[]]
       def delete_account(id)        path = "/api/v2/accounts/#{id}"
-        delete(path)      end
+        delete(path, {}, "22.2.0")      end
 
       # Delete a single notification.
       #
@@ -94,10 +98,11 @@ module AvaTax
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The id of the notification you wish to delete.
       # @return [ErrorDetail[]]
       def delete_notification(id)        path = "/api/v2/notifications/#{id}"
-        delete(path)      end
+        delete(path, {}, "22.2.0")      end
 
       # Delete a single subscription
       #
@@ -109,21 +114,23 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account that owns this subscription.
       # @param id [Integer] The ID of the subscription you wish to delete.
       # @return [ErrorDetail[]]
       def delete_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        delete(path)      end
+        delete(path, {}, "22.2.0")      end
 
       # Retrieve List of Accounts by Account Migration Status
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param writeMode [String]  (See TssAccountMigrationId::* for a list of allowable values)
       # @return [Object]
       def list_accounts_by_tss_write_mode(writeMode)        path = "/api/v2/accounts/ListAccountsByTssWriteMode/#{writeMode}"
-        get(path)      end
+        get(path, {}, "22.2.0")      end
 
       # Reset a user's password programmatically
       #
@@ -138,12 +145,13 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # * This API is available to Avalara system-level (registrar-level) users only.
+      # Swagger Name: AvaTaxClient	  
       # @param userId [Integer] The unique ID of the user whose password will be changed
       # @param unmigrateFromAi [Boolean] If user's password was migrated to AI, undo this.
       # @param model [Object] The new password for this user
       # @return [String]
       def reset_password(userId, model, options={})        path = "/api/v2/passwords/#{userId}/reset"
-        post(path, model, options)      end
+        post(path, model, options, "22.2.0")      end
 
       # Update a single account
       #
@@ -155,11 +163,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] The account object you wish to update.
       # @return [Object]
       def update_account(id, model)        path = "/api/v2/accounts/#{id}"
-        put(path, model)      end
+        put(path, model, {}, "22.2.0")      end
 
       # Update a single notification.
       #
@@ -178,11 +187,12 @@ module AvaTax
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The id of the notification you wish to update.
       # @param model [Object] The notification object you wish to update.
       # @return [Object]
       def update_notification(id, model)        path = "/api/v2/notifications/#{id}"
-        put(path, model)      end
+        put(path, model, {}, "22.2.0")      end
 
       # Update a single subscription
       #
@@ -198,12 +208,13 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account that this subscription belongs to.
       # @param id [Integer] The ID of the subscription you wish to update
       # @param model [Object] The subscription you wish to update.
       # @return [Object]
       def update_subscription(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        put(path, model)      end
+        put(path, model, {}, "22.2.0")      end
     end
   end
 end

data/lib/avatax/client/reports.rb

@@ -23,10 +23,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The unique ID number of this report
       # @return [Object]
       def download_report(id)        path = "/api/v2/reports/#{id}/attachment"
-        get(path)      end
+        get(path, {}, "22.2.0")      end
 
       # Retrieve a single report
       #
@@ -41,10 +42,11 @@ module AvaTax
       # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
       #
       # This API call returns information about any report type.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The unique ID number of the report to retrieve
       # @return [Object]
       def get_report(id)        path = "/api/v2/reports/#{id}"
-        get(path)      end
+        get(path, {}, "22.2.0")      end
 
       # Initiate an ExportDocumentLine report task
       #
@@ -72,11 +74,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company to report on.
       # @param model [Object] Options that may be configured to customize the report.
       # @return [ReportModel[]]
       def initiate_export_document_line_report(companyId, model)        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
-        post(path, model)      end
+        post(path, model, {}, "22.2.0")      end
 
       # List all report tasks for account
       #
@@ -95,13 +98,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The id of the company for which to get reports.
       # @param pageKey [String] Provide a page key to retrieve the next page of results.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @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.
       # @return [FetchResult]
       def list_reports(options={})        path = "/api/v2/reports"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
     end
   end
 end

data/lib/avatax/client/settings.rb

@@ -24,11 +24,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, model, {}, "22.2.0")      end
 
       # Delete a single setting
       #
@@ -46,11 +47,12 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        delete(path, {}, "22.2.0")      end
 
       # Retrieve a single setting
       #
@@ -68,11 +70,12 @@ 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.
+      # 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
+        get(path, {}, "22.2.0")      end
 
       # Retrieve all settings for this company
       #
@@ -93,6 +96,7 @@ 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.
+      # 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.
@@ -101,7 +105,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_settings_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/settings"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Retrieve all settings
       #
@@ -122,6 +126,7 @@ 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.
+      # 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.
@@ -129,7 +134,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_settings(options={})        path = "/api/v2/settings"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Update a single setting
       #
@@ -151,12 +156,13 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        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

@@ -12,11 +12,12 @@ 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.
+      # 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
+        get(path, {}, "22.2.0")      end
 
       # Retrieve subscriptions for this account
       #
@@ -30,6 +31,7 @@ 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.
+      # 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.
@@ -37,7 +39,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_subscriptions_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/subscriptions"
-        get(path, options)      end
+        get(path, options, "22.2.0")      end
 
       # Retrieve all subscriptions
       #
@@ -51,13 +53,14 @@ 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.
+      # 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
+        get(path, options, "22.2.0")      end
     end
   end
 end