avatax 21.7.1 → 21.12.0

data/lib/avatax/client/upcs.rb

@@ -1,54 +1,57 @@
-module AvaTax
-  class Client
-    module Upcs 
-
-
-      # Create a new UPC
-      #
+module AvaTax
+  class Client
+    module Upcs 
+
+
+      # Create a new UPC
+      #
       # Create one or more new UPC objects attached to this company.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this UPC.
       # @param model [UPCModel[]] The UPC you wish to create.
-      # @return [UPCModel[]]
-      def create_u_p_cs(companyId, model)        path = "/api/v2/companies/#{companyId}/upcs"
-        post(path, model)      end
-
-      # Delete a single UPC
-      #
+      # @return [UPCModel[]]
+      def create_u_p_cs(companyId, model)        path = "/api/v2/companies/#{companyId}/upcs"
+        post(path, model, {}, "21.12.0")      end
+
+      # Delete a single UPC
+      #
       # Marks the UPC object identified by this URL as deleted.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this UPC.
       # @param id [Integer] The ID of the UPC you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        delete(path)      end
-
-      # Retrieve a single UPC
-      #
+      # @return [ErrorDetail[]]
+      def delete_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        delete(path, {}, "21.12.0")      end
+
+      # Retrieve a single UPC
+      #
       # Get the UPC object identified by this URL.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this UPC
       # @param id [Integer] The primary key of this UPC
-      # @return [Object]
-      def get_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        get(path)      end
-
-      # Retrieve UPCs for this company
-      #
+      # @return [Object]
+      def get_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        get(path, {}, "21.12.0")      end
+
+      # Retrieve UPCs for this company
+      #
       # List all UPC objects attached to this company.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
       #
@@ -58,19 +61,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 depends on the following active services:*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these UPCs
       # @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_u_p_cs_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/upcs"
-        get(path, options)      end
-
-      # Retrieve all UPCs
-      #
+      # @return [FetchResult]
+      def list_u_p_cs_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/upcs"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve all UPCs
+      #
       # Get multiple UPC objects across all companies.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
       #
@@ -80,18 +84,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 depends on the following active services:*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # 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_u_p_cs(options={})        path = "/api/v2/upcs"
-        get(path, options)      end
-
-      # Update a single UPC
-      #
+      # @return [FetchResult]
+      def query_u_p_cs(options={})        path = "/api/v2/upcs"
+        get(path, options, "21.12.0")      end
+
+      # Update a single UPC
+      #
       # Replace the existing UPC object at this URL with an updated object.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
       # All data from the existing object will be replaced with data in the object you PUT.
@@ -100,13 +105,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # * This API depends on the following active services:*Required* (all): AvaUpc.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that this UPC belongs to.
       # @param id [Integer] The ID of the UPC you wish to update
       # @param model [Object] The UPC you wish to update.
-      # @return [Object]
-      def update_u_p_c(companyId, id, model)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_u_p_c(companyId, id, model)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        put(path, model, {}, "21.12.0")      end
+    end
+  end
 end

data/lib/avatax/client/userdefinedfields.rb

@@ -0,0 +1,52 @@
+module AvaTax
+  class Client
+    module UserDefinedFields 
+
+
+      # Delete a User Defined Field by User Defined Field id for a company.
+      #
+      # Marks the existing user defined field for a company as deleted.
+      #
+      # ### 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:*Required* (all): AvaTaxPro, BasicReturns.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The id of the company the User Defined Field belongs to.
+      # @param id [Integer] The id of the User Defined Field you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_user_defined_field(companyId, id)        path = "/api/v2/companies/#{companyId}/userdefinedfields/#{id}"
+        delete(path, {}, "21.12.0")      end
+
+      # 
+      #
+      # ### 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, BasicReturns.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] 
+      # @param udfType [String] Document or Line level UDF (See UserDefinedFieldType::* for a list of allowable values)
+      # @param allowDefaults [Boolean] If true this will add defaulted UDFs to the list that are not named yet
+      # @return [FetchResult]
+      def list_user_defined_fields_by_company_id(companyId, options={})        path = "/api/v2/companies/#{companyId}/userdefinedfields"
+        get(path, options, "21.12.0")      end
+
+      # Update a User Defined Field identified by id for a company
+      #
+      # Updates a User Defined Field for a company.
+      #
+      # ### 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:*Required* (all): AvaTaxPro, BasicReturns.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The id of the company the user defined field belongs to.
+      # @param id [Integer] 
+      # @param model [Object] 
+      # @return [Object]
+      def update_user_defined_field(companyId, model, options={})        path = "/api/v2/companies/#{companyId}/userdefinedfields"
+        post(path, model, options, "21.12.0")      end
+    end
+  end
+end

data/lib/avatax/client/users.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Users 
-
-
-      # Change Password
-      #
+module AvaTax
+  class Client
+    module Users 
+
+
+      # Change Password
+      #
       # Allows a user to change their password via an API call.
       #
       # This API allows an authenticated user to change their password via an API call. This feature is only available
@@ -15,14 +15,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * 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 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.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] An object containing your current password and the new password.
-      # @return [String]
-      def change_password(model)        path = "/api/v2/passwords"
-        put(path, model)      end
-
-      # Create new users
-      #
+      # @return [String]
+      def change_password(model)        path = "/api/v2/passwords"
+        put(path, model, {}, "21.12.0")      end
+
+      # Create new users
+      #
       # Create one or more new user objects attached to this account.
       #
       # A user represents one person with access privileges to make API calls and work with a specific account.
@@ -35,15 +36,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * 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 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.
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The unique ID number of the account where these users will be created.
       # @param model [UserModel[]] The user or array of users you wish to create.
-      # @return [UserModel[]]
-      def create_users(accountId, model)        path = "/api/v2/accounts/#{accountId}/users"
-        post(path, model)      end
-
-      # Delete a single user
-      #
+      # @return [UserModel[]]
+      def create_users(accountId, model)        path = "/api/v2/accounts/#{accountId}/users"
+        post(path, model, {}, "21.12.0")      end
+
+      # Delete a single user
+      #
       # Mark the user object identified by this URL as deleted.
       #
       # This API is available for use by account and company administrators only.
@@ -53,15 +55,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the user you wish to delete.
       # @param accountId [Integer] The accountID of the user you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_user(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        delete(path)      end
-
-      # Retrieve a single user
-      #
+      # @return [ErrorDetail[]]
+      def delete_user(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        delete(path, {}, "21.12.0")      end
+
+      # Retrieve a single user
+      #
       # Get the user object identified by this URL.
       # A user represents one person with access privileges to make API calls and work with a specific account.
       #
@@ -71,16 +74,17 @@ 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, SystemOperator, 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the user to retrieve.
       # @param accountId [Integer] The accountID of the user you wish to get.
       # @param include [String] Optional fetch commands.
-      # @return [Object]
-      def get_user(id, accountId, options={})        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        get(path, options)      end
-
-      # Retrieve all entitlements for a single user
-      #
+      # @return [Object]
+      def get_user(id, accountId, options={})        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve all entitlements for a single user
+      #
       # Return a list of all entitlements to which this user has rights to access.
       # Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is
       # allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use.
@@ -99,15 +103,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, SystemOperator, 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the user to retrieve.
       # @param accountId [Integer] The accountID of the user you wish to get.
-      # @return [Object]
-      def get_user_entitlements(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
-        get(path)      end
-
-      # Retrieve users for this account
-      #
+      # @return [Object]
+      def get_user_entitlements(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
+        get(path, {}, "21.12.0")      end
+
+      # Retrieve users for this account
+      #
       # List all user objects attached to this account.
       # A user represents one person with access privileges to make API calls and work with a specific account.
       #
@@ -123,19 +128,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, SystemOperator, 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The accountID of the user you wish to list.
       # @param include [String] Optional fetch commands.
       # @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:* SuppressNewUserEmail
       # @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_users_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/users"
-        get(path, options)      end
-
-      # Retrieve all users
-      #
+      # @return [FetchResult]
+      def list_users_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/users"
+        get(path, options, "21.12.0")      end
+
+      # Retrieve all users
+      #
       # Get multiple user objects across all accounts.
       #
       # A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated
@@ -153,18 +159,19 @@ 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, SystemOperator, 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param include [String] Optional fetch commands.
       # @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:* SuppressNewUserEmail
       # @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_users(options={})        path = "/api/v2/users"
-        get(path, options)      end
-
-      # Update a single user
-      #
+      # @return [FetchResult]
+      def query_users(options={})        path = "/api/v2/users"
+        get(path, options, "21.12.0")      end
+
+      # Update a single user
+      #
       # Replace the existing user object at this URL with an updated object.
       # A user represents one person with access privileges to make API calls and work with a specific account.
       # All data from the existing object will be replaced with data in the object you PUT.
@@ -172,13 +179,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * 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 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the user you wish to update.
       # @param accountId [Integer] The accountID of the user you wish to update.
       # @param model [Object] The user object you wish to update.
-      # @return [Object]
-      def update_user(id, accountId, model)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_user(id, accountId, model)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        put(path, model, {}, "21.12.0")      end
+    end
+  end
 end

data/lib/avatax/client/utilities.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Utilities 
-
-
-      # Checks if the current user is subscribed to a specific service
-      #
+module AvaTax
+  class Client
+    module Utilities 
+
+
+      # Checks if the current user is subscribed to a specific service
+      #
       # Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
       #
       # This API will return an error if it is called with invalid authentication credentials.
@@ -12,14 +12,15 @@ module AvaTax
       # This API is intended to help you determine whether you have the necessary subscription to use certain API calls
       # within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product
       # or subscription to provide useful information to the current user as to whether they are entitled to use
-      # specific features of AvaTax.
+      # specific features of AvaTax.
+      # Swagger Name: AvaTaxClient	  
       # @param serviceTypeId [String] The service to check
-      # @return [Object]
-      def get_my_subscription(serviceTypeId)        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
-        get(path)      end
-
-      # List all services to which the current user is subscribed
-      #
+      # @return [Object]
+      def get_my_subscription(serviceTypeId)        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
+        get(path, {}, "21.12.0")      end
+
+      # List all services to which the current user is subscribed
+      #
       # Returns the list of all subscriptions enabled for the currently logged in user.
       #
       # This API will return an error if it is called with invalid authentication credentials.
@@ -27,13 +28,14 @@ module AvaTax
       # This API is intended to help you determine whether you have the necessary subscription to use certain API calls
       # within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product
       # or subscription to provide useful information to the current user as to whether they are entitled to use
-      # specific features of AvaTax.
-      # @return [FetchResult]
-      def list_my_subscriptions()        path = "/api/v2/utilities/subscriptions"
-        get(path)      end
-
-      # Tests connectivity and version of the service
-      #
+      # specific features of AvaTax.
+      # Swagger Name: AvaTaxClient	  
+      # @return [FetchResult]
+      def list_my_subscriptions()        path = "/api/v2/utilities/subscriptions"
+        get(path, {}, "21.12.0")      end
+
+      # Tests connectivity and version of the service
+      #
       # Check connectivity to AvaTax and return information about the AvaTax API server.
       #
       # This API is intended to help you verify that your connection is working. This API will always succeed and will
@@ -53,10 +55,11 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API may be called without providing authentication credentials.
-      # @return [Object]
-      def ping()        path = "/api/v2/utilities/ping"
-        get(path)      end
-    end
-  end
+      # * This API may be called without providing authentication credentials.
+      # Swagger Name: AvaTaxClient	  
+      # @return [Object]
+      def ping()        path = "/api/v2/utilities/ping"
+        get(path, {}, "21.12.0")      end
+    end
+  end
 end

data/lib/avatax/client.rb

@@ -31,5 +31,7 @@ module AvaTax
     include AvaTax::Client::Upcs
     include AvaTax::Client::Users
     include AvaTax::Client::Utilities
+    include AvaTax::Client::ShippingVerification
+    include AvaTax::Client::AgeVerification
   end
 end

data/lib/avatax/connection.rb

@@ -8,7 +8,7 @@ module AvaTax
     REMOVED_LABEL = '\1[REMOVED]'
 
     def connection
-      client_id = "#{app_name};#{app_version};RubySdk;#{AvaTax::VERSION.dup};#{machine_name}"
+      client_id = "#{app_name};#{app_version};RubySdk;API_VERSION;#{machine_name}"
       options = {
         :headers =>
           {

data/lib/avatax/request.rb

@@ -1,32 +1,35 @@
 require 'faraday'
 require 'json'
+require "erb"
+
 
 module AvaTax
   module Request
 
-    def get(path, options={})
-      request(:get, path, nil, options)
+    def get(path, options={}, apiversion="")
+      request(:get, path, nil, options, apiversion)
     end
 
-    def post(path, model, options={})
-      request(:post, path, model, options)
+    def post(path, model, options={}, apiversion="")
+      request(:post, path, model, options, apiversion)
     end
 
-    def put(path, model, options={})
-      request(:put, path, model, options)
+    def put(path, model, options={}, apiversion="")
+      request(:put, path, model, options, apiversion)
     end
 
-    def delete(path, options={})
-      request(:delete, path, nil, options)
+    def delete(path, options={}, apiversion="")
+      request(:delete, path, nil, options, apiversion)
     end
 
-    def request(method, path, model, options={})
+    def request(method, path, model, options={}, apiversion="")
       response = connection.send(method) do |request|
+        request.headers['X-Avalara-Client'] = request.headers['X-Avalara-Client'].gsub("API_VERSION", apiversion)
         case method
         when :get, :delete
-          request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")
+          request.url("#{encode_path(path)}?#{URI.encode_www_form(options)}")
         when :post, :put
-          request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")
+          request.url("#{encode_path(path)}?#{URI.encode_www_form(options)}")
           request.headers['Content-Type'] = 'application/json'
           request.body = model.to_json unless model.empty?
         end
@@ -38,5 +41,11 @@ module AvaTax
         response.body
       end
     end
+
+    private
+
+    def encode_path(path)
+      path.split('/').map { |part| ERB::Util.url_encode(part) }.join('/')
+    end
   end
-end
+end

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '21.7.1'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '21.12.0'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 21.7.1
+  version: 21.12.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -121,6 +121,7 @@ files:
 - lib/avatax/client/accounts.rb
 - lib/avatax/client/addresses.rb
 - lib/avatax/client/advancedrules.rb
+- lib/avatax/client/ageverification.rb
 - lib/avatax/client/avafileforms.rb
 - lib/avatax/client/batches.rb
 - lib/avatax/client/certexpressinvites.rb
@@ -153,6 +154,7 @@ files:
 - lib/avatax/client/registrar.rb
 - lib/avatax/client/reports.rb
 - lib/avatax/client/settings.rb
+- lib/avatax/client/shippingverification.rb
 - lib/avatax/client/subscriptions.rb
 - lib/avatax/client/taxContent/README.txt
 - lib/avatax/client/taxRatesByZip/README.txt
@@ -162,6 +164,7 @@ files:
 - lib/avatax/client/taxrules.rb
 - lib/avatax/client/transactions.rb
 - lib/avatax/client/upcs.rb
+- lib/avatax/client/userdefinedfields.rb
 - lib/avatax/client/users.rb
 - lib/avatax/client/utilities.rb
 - lib/avatax/configuration.rb
@@ -206,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the AvaTax API