avatax 22.2.0 → 22.5.0

data/lib/avatax/client/shippingverification.rb

@@ -10,9 +10,13 @@ module AvaTax
       # @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"
+      # @param api-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2
+      # @param x-avalara-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.
       # @return []
-      def deregister_shipment(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registration"
-        delete(path, options, "")      end
+      def deregister_shipment(companyCode, transactionCode, options={}, x_avalara_version="")        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registration"
+        headers= Hash.new
+        headers["x-avalara-version"]=x_avalara_version if !(x_avalara_version.nil? || x_avalara_version.empty?);
+        delete(path, options, "", headers)      end
 
       # Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
       #
@@ -21,9 +25,13 @@ module AvaTax
       # @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"
+      # @param api-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2
+      # @param x-avalara-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.
       # @return []
-      def register_shipment(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registration"
-        put(path, options, "")      end
+      def register_shipment(companyCode, transactionCode, options={}, x_avalara_version="")        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registration"
+        headers= Hash.new
+        headers["x-avalara-version"]=x_avalara_version if !(x_avalara_version.nil? || x_avalara_version.empty?);
+        put(path, options, "", headers)      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.
       #
@@ -32,9 +40,13 @@ module AvaTax
       # @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"
+      # @param api-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2
+      # @param x-avalara-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.
       # @return [Object]
-      def register_shipment_if_compliant(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registerIfCompliant"
-        put(path, options, "")      end
+      def register_shipment_if_compliant(companyCode, transactionCode, options={}, x_avalara_version="")        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/registerIfCompliant"
+        headers= Hash.new
+        headers["x-avalara-version"]=x_avalara_version if !(x_avalara_version.nil? || x_avalara_version.empty?);
+        put(path, options, "", headers)      end
 
       # Evaluates a transaction against a set of direct-to-consumer shipping regulations.
       #
@@ -44,13 +56,13 @@ module AvaTax
       # * 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.
+      # * Each alcohol line must include a *AlcoholContent* parameter that describes the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field. If unable to provide this parameter, use version 2.1 of the API.
       #
       # 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*
@@ -58,9 +70,13 @@ module AvaTax
       # @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"
+      # @param api-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2
+      # @param x-avalara-version [String] (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.
       # @return [Object]
-      def verify_shipment(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/verify"
-        get(path, options, "")      end
+      def verify_shipment(companyCode, transactionCode, options={}, x_avalara_version="")        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/shipment/verify"
+        headers= Hash.new
+        headers["x-avalara-version"]=x_avalara_version if !(x_avalara_version.nil? || x_avalara_version.empty?);
+        get(path, options, "", headers)      end
     end
   end
 end

data/lib/avatax/client/subscriptions.rb

@@ -17,7 +17,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Retrieve subscriptions for this account
       #
@@ -39,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, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all subscriptions
       #
@@ -60,7 +60,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_subscriptions(options={})        path = "/api/v2/subscriptions"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/taxcodes.rb

@@ -19,7 +19,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        post(path, model, {}, "22.5.0")      end
 
       # Delete a single tax code
       #
@@ -33,7 +33,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        delete(path, {}, "22.5.0")      end
 
       # Retrieve a single tax code
       #
@@ -51,7 +51,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Retrieve tax codes for this company
       #
@@ -76,7 +76,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_tax_codes_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxcodes"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all tax codes
       #
@@ -100,7 +100,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_tax_codes(options={})        path = "/api/v2/taxcodes"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Update a single tax code
       #
@@ -121,7 +121,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        put(path, model, {}, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/taxcontent.rb

@@ -37,7 +37,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        post(path, model, {}, "22.5.0")      end
 
       # Build a tax content file for a single location
       #
@@ -78,7 +78,7 @@ module AvaTax
       # @param includeJurisCodes [Boolean] When true, the file will include jurisdiction codes in the result.
       # @return [Object]
       def build_tax_content_file_for_location(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Download a file listing tax rates by postal code
       #
@@ -131,7 +131,7 @@ module AvaTax
       # @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, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Sales tax rates for a specified address
       #
@@ -165,7 +165,7 @@ module AvaTax
       # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @return [Object]
       def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
       #
@@ -196,7 +196,7 @@ module AvaTax
       # @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, "22.2.0")      end
+        get(path, options, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/taxrules.rb

@@ -27,7 +27,7 @@ module AvaTax
       # @param model [TaxRuleModel[]] The tax rule you wish to create.
       # @return [TaxRuleModel[]]
       def create_tax_rules(companyId, model)        path = "/api/v2/companies/#{companyId}/taxrules"
-        post(path, model, {}, "22.2.0")      end
+        post(path, model, {}, "22.5.0")      end
 
       # Delete a single tax rule
       #
@@ -53,7 +53,7 @@ module AvaTax
       # @param id [Integer] The ID of the tax rule you wish to delete.
       # @return [ErrorDetail[]]
       def delete_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        delete(path, {}, "22.2.0")      end
+        delete(path, {}, "22.5.0")      end
 
       # Retrieve a single tax rule
       #
@@ -79,7 +79,7 @@ module AvaTax
       # @param id [Integer] The primary key of this tax rule
       # @return [Object]
       def get_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        get(path, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Retrieve tax rules for this company
       #
@@ -112,7 +112,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_tax_rules(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxrules"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all tax rules
       #
@@ -144,7 +144,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_tax_rules(options={})        path = "/api/v2/taxrules"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Update a single tax rule
       #
@@ -171,7 +171,7 @@ module AvaTax
       # @param model [Object] The tax rule you wish to update.
       # @return [Object]
       def update_tax_rule(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        put(path, model, {}, "22.2.0")      end
+        put(path, model, {}, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/transactions.rb

@@ -35,7 +35,7 @@ module AvaTax
       # @param model [Object] information about the transaction and lines to be added
       # @return [Object]
       def add_lines(model, options={})        path = "/api/v2/companies/transactions/lines/add"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Correct a previously created transaction
       #
@@ -81,7 +81,7 @@ module AvaTax
       # @param model [Object] The adjustment you wish to make
       # @return [Object]
       def adjust_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Get audit information about a transaction
       #
@@ -118,7 +118,7 @@ module AvaTax
       # @param transactionCode [String] The code identifying the transaction
       # @return [Object]
       def audit_transaction(companyCode, transactionCode)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
-        get(path, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Get audit information about a transaction
       #
@@ -156,7 +156,7 @@ module AvaTax
       # @param documentType [String] The document type of the original transaction (See DocumentType::* for a list of allowable values)
       # @return [Object]
       def audit_transaction_with_type(companyCode, transactionCode, documentType)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
-        get(path, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Lock a set of documents
       #
@@ -176,7 +176,7 @@ module AvaTax
       # @param model [Object] bulk lock request
       # @return [Object]
       def bulk_lock_transaction(model)        path = "/api/v2/transactions/lock"
-        post(path, model, {}, "22.2.0")      end
+        post(path, model, {}, "22.5.0")      end
 
       # Change a transaction's code
       #
@@ -222,7 +222,7 @@ module AvaTax
       # @param model [Object] The code change request you wish to execute
       # @return [Object]
       def change_transaction_code(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Commit a transaction for reporting
       #
@@ -266,7 +266,7 @@ module AvaTax
       # @param model [Object] The commit request you wish to execute
       # @return [Object]
       def commit_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Create or adjust a transaction
       #
@@ -313,7 +313,7 @@ module AvaTax
       # @param model [Object] The transaction you wish to create or adjust
       # @return [Object]
       def create_or_adjust_transaction(model, options={})        path = "/api/v2/transactions/createoradjust"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Create a new transaction
       #
@@ -367,7 +367,7 @@ module AvaTax
       # @param model [Object] The transaction you wish to create
       # @return [Object]
       def create_transaction(model, options={})        path = "/api/v2/transactions/create"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Remove lines from an existing unlocked transaction
       #
@@ -398,7 +398,7 @@ module AvaTax
       # @param model [Object] information about the transaction and lines to be removed
       # @return [Object]
       def delete_lines(model, options={})        path = "/api/v2/companies/transactions/lines/delete"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Retrieve a single transaction by code
       #
@@ -440,7 +440,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve a single transaction by code
       #
@@ -465,14 +465,13 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve a single transaction by ID
       #
       # Get the unique transaction identified by this URL.
       #
-      # This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted
-      # by using the `AdjustTransaction` endpoint.
+      # This endpoint retrieves the exact transaction identified by this ID number, as long as it is the most version of the transaction.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
       # sales, purchases, inventory transfer, and returns (also called refunds).
@@ -496,7 +495,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_id(id, options={})        path = "/api/v2/transactions/#{id}"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all transactions
       #
@@ -544,7 +543,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_transactions_by_company(companyCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Lock a single transaction
       #
@@ -590,7 +589,7 @@ module AvaTax
       # @param model [Object] The lock request you wish to execute
       # @return [Object]
       def lock_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Create a refund for a transaction
       #
@@ -647,7 +646,7 @@ module AvaTax
       # @param model [Object] Information about the refund to create
       # @return [Object]
       def refund_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Perform multiple actions on a transaction
       #
@@ -691,7 +690,7 @@ module AvaTax
       # @param model [Object] The data from an external system to reconcile against AvaTax
       # @return [Object]
       def settle_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Uncommit a transaction for reporting
       #
@@ -729,7 +728,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def uncommit_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
-        post(path, options, "22.2.0")      end
+        post(path, options, "22.5.0")      end
 
       # Unvoids a transaction
       #
@@ -764,7 +763,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def unvoid_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
-        post(path, options, "22.2.0")      end
+        post(path, options, "22.5.0")      end
 
       # Verify a transaction
       #
@@ -807,7 +806,7 @@ module AvaTax
       # @param model [Object] The data from an external system to reconcile against AvaTax
       # @return [Object]
       def verify_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
 
       # Void a transaction
       #
@@ -852,7 +851,7 @@ module AvaTax
       # @param model [Object] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
       # @return [Object]
       def void_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/upcs.rb

@@ -17,7 +17,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        post(path, model, {}, "22.5.0")      end
 
       # Delete a single UPC
       #
@@ -32,7 +32,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        delete(path, {}, "22.5.0")      end
 
       # Retrieve a single UPC
       #
@@ -48,7 +48,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Retrieve UPCs for this company
       #
@@ -71,7 +71,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_u_p_cs_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/upcs"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all UPCs
       #
@@ -93,7 +93,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_u_p_cs(options={})        path = "/api/v2/upcs"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Update a single UPC
       #
@@ -112,7 +112,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        put(path, model, {}, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/userdefinedfields.rb

@@ -16,7 +16,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        delete(path, {}, "22.5.0")      end
 
       # 
       #
@@ -30,7 +30,7 @@ module AvaTax
       # @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, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Update a User Defined Field identified by id for a company
       #
@@ -46,7 +46,7 @@ module AvaTax
       # @param model [Object] 
       # @return [Object]
       def update_user_defined_field(companyId, model, options={})        path = "/api/v2/companies/#{companyId}/userdefinedfields"
-        post(path, model, options, "22.2.0")      end
+        post(path, model, options, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/users.rb

@@ -20,7 +20,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        put(path, model, {}, "22.5.0")      end
 
       # Create new users
       #
@@ -42,7 +42,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        post(path, model, {}, "22.5.0")      end
 
       # Delete a single user
       #
@@ -61,7 +61,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        delete(path, {}, "22.5.0")      end
 
       # Retrieve a single user
       #
@@ -81,7 +81,7 @@ module AvaTax
       # @param include [String] Optional fetch commands.
       # @return [Object]
       def get_user(id, accountId, options={})        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all entitlements for a single user
       #
@@ -109,7 +109,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Retrieve users for this account
       #
@@ -138,7 +138,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_users_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/users"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Retrieve all users
       #
@@ -168,7 +168,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_users(options={})        path = "/api/v2/users"
-        get(path, options, "22.2.0")      end
+        get(path, options, "22.5.0")      end
 
       # Update a single user
       #
@@ -186,7 +186,7 @@ module AvaTax
       # @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, {}, "22.2.0")      end
+        put(path, model, {}, "22.5.0")      end
     end
   end
 end

data/lib/avatax/client/utilities.rb

@@ -17,7 +17,7 @@ module AvaTax
       # @param serviceTypeId [String] The service to check
       # @return [Object]
       def get_my_subscription(serviceTypeId)        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
-        get(path, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # List all services to which the current user is subscribed
       #
@@ -32,7 +32,7 @@ module AvaTax
       # Swagger Name: AvaTaxClient	  
       # @return [FetchResult]
       def list_my_subscriptions()        path = "/api/v2/utilities/subscriptions"
-        get(path, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
 
       # Tests connectivity and version of the service
       #
@@ -59,7 +59,7 @@ module AvaTax
       # Swagger Name: AvaTaxClient	  
       # @return [Object]
       def ping()        path = "/api/v2/utilities/ping"
-        get(path, {}, "22.2.0")      end
+        get(path, {}, "22.5.0")      end
     end
   end
 end

data/lib/avatax/connection.rb

@@ -28,7 +28,11 @@ module AvaTax
         end
 
         faraday.response :json, content_type: /\bjson$/
-        faraday.basic_auth(username, password)
+        faraday.request :basic_auth, username, password
+
+        # TODO: use the following after upgrading to faraday 2.0
+        #   see https://github.com/lostisland/faraday/blob/main/docs/middleware/request/authentication.md
+        # faraday.request :authorization, :basic, username, password
 
         if logger
           faraday.response :logger do |logger|