Merge pull request #114 from avadev/21.12.0

Update for 21.12.0

Author: svc-developer

lib/avatax/client.rb

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

lib/avatax/client/accounts.rb

@@ -23,11 +23,12 @@ module Accounts
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] A request confirming that you wish to reset the license key of this account.
       # @return [Object]
       def account_reset_license_key(id, model)        path = "/api/v2/accounts/#{id}/resetlicensekey"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Activate an account by accepting terms and conditions
       #
@@ -45,11 +46,12 @@ def account_reset_license_key(id, model)        path = "/api/v2/accounts/#{id}/r
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the account to activate
       # @param model [Object] The activation request
       # @return [Object]
       def activate_account(id, model)        path = "/api/v2/accounts/#{id}/activate"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Retrieve audit history for an account.
       #
@@ -71,14 +73,15 @@ def activate_account(id, model)        path = "/api/v2/accounts/#{id}/activate"
       # ### 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 id [Integer] The ID of the account you wish to audit.
       # @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
       # @param end [DateTime] The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
       # @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.
       # @return [FetchResult]
       def audit_account(id, options={})        path = "/api/v2/accounts/#{id}/audit"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
 
       # Create license key for this account
       #
@@ -96,11 +99,12 @@ def audit_account(id, options={})        path = "/api/v2/accounts/#{id}/audit"
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] 
       # @return [Object]
       def create_license_key(id, model)        path = "/api/v2/accounts/#{id}/licensekey"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Delete license key for this account by license key name
       #
@@ -113,11 +117,12 @@ def create_license_key(id, model)        path = "/api/v2/accounts/#{id}/licensek
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the account you wish to update.
       # @param licensekeyname [String] The license key name you wish to update.
       # @return [ErrorDetail[]]
       def delete_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
-        delete(path)      end
+        delete(path, {}, "21.12.0")      end
 
       # Retrieve a single account
       #
@@ -130,11 +135,12 @@ def delete_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}
       # ### 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 id [Integer] The ID of the account to retrieve
       # @param include [String] A comma separated list of special fetch options
       # @return [Object]
       def get_account(id, options={})        path = "/api/v2/accounts/#{id}"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
 
       # Get configuration settings for this account
       #
@@ -154,21 +160,23 @@ def get_account(id, options={})        path = "/api/v2/accounts/#{id}"
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
       # @return [AccountConfigurationModel[]]
       def get_account_configuration(id)        path = "/api/v2/accounts/#{id}/configuration"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # Retrieve license key by license key name
       #
       # ### 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 id [Integer] The ID of the account to retrieve
       # @param licensekeyname [String] The ID of the account to retrieve
       # @return [Object]
       def get_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # Retrieve all license keys for this account
       #
@@ -177,10 +185,11 @@ def get_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/li
       # ### 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 id [Integer] The ID of the account to retrieve
       # @return [AccountLicenseKeyModel[]]
       def get_license_keys(id)        path = "/api/v2/accounts/#{id}/licensekeys"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # Retrieve all accounts
       #
@@ -200,14 +209,15 @@ def get_license_keys(id)        path = "/api/v2/accounts/#{id}/licensekeys"
       # ### 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 include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
       # @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:* subscriptions, users
       # @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_accounts(options={})        path = "/api/v2/accounts"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
 
       # Change configuration settings for this account
       #
@@ -227,11 +237,12 @@ def query_accounts(options={})        path = "/api/v2/accounts"
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
       # @param model [AccountConfigurationModel[]] 
       # @return [AccountConfigurationModel[]]
       def set_account_configuration(id, model)        path = "/api/v2/accounts/#{id}/configuration"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
     end
   end
 end

lib/avatax/client/addresses.rb

@@ -21,6 +21,7 @@ module Addresses
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # * This API depends on the following active services:*Required* (all): AutoAddress.
+      # Swagger Name: AvaTaxClient	  
       # @param line1 [String] Line 1
       # @param line2 [String] Line 2
       # @param line3 [String] Line 3
@@ -31,7 +32,7 @@ module Addresses
       # @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
       # @return [Object]
       def resolve_address(options={})        path = "/api/v2/addresses/resolve"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
 
       # Retrieve geolocation information for a specified address
       #
@@ -46,10 +47,11 @@ def resolve_address(options={})        path = "/api/v2/addresses/resolve"
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # * This API depends on the following active services:*Required* (all): AutoAddress.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] The address to resolve
       # @return [Object]
       def resolve_address_post(model)        path = "/api/v2/addresses/resolve"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
     end
   end
 end

lib/avatax/client/advancedrules.rb

@@ -6,49 +6,54 @@ module AdvancedRules
       # Create a lookup file for a company
       #
       # 
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account for the company
       # @param companyId [Integer] The ID of the company for which the lookup file is to be created
       # @param model [Object] The lookup file you wish to create
       # @return [Object]
       def create_company_lookup_file(accountId, companyId, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Delete a lookup file
       #
       # 
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account for the company the lookup file is for
       # @param id [String] The unique ID/GUID for the company lookup file to be deleted
       # @return [ErrorDetail[]]
       def delete_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
-        delete(path)      end
+        delete(path, {}, "21.12.0")      end
 
       # Get the lookup files for a company
       #
       # 
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The account ID for the company
       # @param companyId [Integer] The ID of the company for which to retrieve lookup files
       # @return [FetchResult]
       def get_company_lookup_files(accountId, companyId)        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # Get a lookup file for an accountId and companyLookupFileId
       #
       # 
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account for the lookup file
       # @param id [String] The unique ID/GUID of the company lookup file to return
       # @return [Object]
       def get_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # Update a lookup file
       #
       # 
+      # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The ID of the account for the company the lookup file is for
       # @param id [String] The unique ID/GUID of the company lookup file to be updated
       # @param model [Object] The new values to update the lookup file
       # @return [Object]
       def update_lookup_file(accountId, id, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
-        put(path, model)      end
+        put(path, model, {}, "21.12.0")      end
     end
   end
 end

lib/avatax/client/ageverification.rb

@@ -0,0 +1,29 @@
+module AvaTax
+  class Client
+    module AgeVerification 
+
+
+      # Determines whether an individual meets or exceeds the minimum legal drinking age.
+      #
+      # The request must meet the following criteria in order to be evaluated:
+      # * *firstName*, *lastName*, and *address* are required fields.
+      # * One of the following sets of attributes are required for the *address*:
+      #  * *line1, city, region*
+      #  * *line1, postalCode*
+      #
+      # Optionally, the transaction and its lines may use the following parameters:
+      # * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21).
+      # * Beyond the required *address* fields above, a *country* field is permitted
+      #  * The valid values for this attribute are [*US, USA*]
+      #
+      # **Security Policies**
+      # This API depends on the active subscription *AgeVerification*
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param simulatedFailureCode [String] (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.
+      # @param model [Object] Information about the individual whose age is being verified.
+      # @return [Object]
+      def verify_age(model, options={})        path = "/api/v2/ageverification/verify"
+        post(path, model, options, "")      end
+    end
+  end
+end