Merge pull request #160 from avadev/23.11.0

Update for 23.11.0

lib/avatax/client/accounts.rb

@@ -191,6 +191,20 @@ def get_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/li
       def get_license_keys(id)        path = "/api/v2/accounts/#{id}/licensekeys"
         get(path, {}, AvaTax::VERSION)      end
 
+      # Retrieve a list of MRS Accounts
+      #
+      # This API is available by invitation only.
+      #
+      # Get a list of accounts with an active MRS service.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
+      # @return [FetchResult]
+      def list_mrs_accounts()        path = "/api/v2/accounts/mrs"
+        get(path, {}, AvaTax::VERSION)      end
+
       # Retrieve all accounts
       #
       # List all account objects that can be seen by the current user.

lib/avatax/client/addresses.rb

@@ -3,12 +3,14 @@ class Client
     module Addresses 
 
 
-      # Retrieve geolocation information for a specified address
+      # Retrieve geolocation information for a specified US or Canadian address
       #
-      # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
-      # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
-      # to identify how closely this address can be located. If the address cannot be clearly located, use the
-      # 'messages' structure to learn more about problems with this address.
+      # Resolve a US or Canadian address against Avalara's address validation system. Note that this API is
+      # valid for US and Canadian addresses only.
+      #
+      # If the address can be resolved, this API provides the latitude and longitude of the resolved location.
+      # The value `resolutionQuality` can be used to identify how closely this address can be located. If the
+      # address cannot be clearly located, use the `messages` structure to learn more about problems with this address.
       # This is the same API as the POST /api/v2/addresses/resolve endpoint.
       # Both verbs are supported to provide for flexible implementation.
       #
@@ -34,13 +36,15 @@ module Addresses
       def resolve_address(options={})        path = "/api/v2/addresses/resolve"
         get(path, options, AvaTax::VERSION)      end
 
-      # Retrieve geolocation information for a specified address
+      # Retrieve geolocation information for a specified US or Canadian address
       #
-      # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
-      # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
-      # to identify how closely this address can be located. If the address cannot be clearly located, use the
-      # 'messages' structure to learn more about problems with this address.
-      # This is the same API as the GET /api/v2/addresses/resolve endpoint.
+      # Resolve a US or Canadian address against Avalara's address validation system. Note that this API is
+      # valid for US and Canadian addresses only.
+      #
+      # If the address can be resolved, this API provides the latitude and longitude of the resolved location.
+      # The value `resolutionQuality` can be used to identify how closely this address can be located. If the
+      # address cannot be clearly located, use the `messages` structure to learn more about problems with this
+      # address. This is the same API as the GET /api/v2/addresses/resolve endpoint.
       # Both verbs are supported to provide for flexible implementation.
       #
       # ### Security Policies

lib/avatax/client/customers.rb

@@ -54,7 +54,7 @@ def create_customers(companyId, model)        path = "/api/v2/companies/#{compan
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
-      # @return [Object]
+      # @return []
       def delete_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
         delete(path, {}, AvaTax::VERSION)      end
 

lib/avatax/client/definitions.rb

@@ -362,6 +362,22 @@ def list_jurisdictions_by_address(options={})        path = "/api/v2/definitions
       def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={})        path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
         get(path, options, AvaTax::VERSION)      end
 
+      # List jurisdictions hierarchy based on the filter provided
+      #
+      # Returns a list of all Avalara-supported taxing jurisdictions hirearchy.
+      #
+      # This API Lists the hierarchical relationship of jurisdictions for US states, identifying the cities and special taxing jurisdictions (STJs) for a given county within a state.
+      #
+      # The rate, salesRate, and useRate fields are not available on the JurisdictionHirearchyModels returned by this API.
+      # 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:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst
+      # @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_jurisdictions_hierarchy(options={})        path = "/api/v2/definitions/jurisdictions/hierarchy"
+        get(path, options, AvaTax::VERSION)      end
+
       # List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
       #
       # Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId

lib/avatax/client/domaincontrolverification.rb

@@ -0,0 +1,34 @@
+module AvaTax
+  class Client
+    module DomainControlVerification 
+
+
+      # Create Domain control verification
+      #
+      # 
+      # Swagger Name: AvaTaxClient	  
+      # @param model [Object] 
+      # @return [Object]
+      def create_dcv(model)        path = "/api/v2/domain-control-verifications"
+        post(path, model, {}, AvaTax::VERSION)      end
+
+      # Get domain control verifications by logged in user/domain name.
+      #
+      # 
+      # 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:* Id, Context, Token, Status, EmailId, CreatedOn, CreatedBy, UpdatedOn, UpdatedBy
+      # @return [DcvViewModel[]]
+      def filter_dcv(options={})        path = "/api/v2/domain-control-verifications"
+        get(path, options, AvaTax::VERSION)      end
+
+      # Get domain control verification by domainControlVerificationId
+      #
+      # 
+      # Swagger Name: AvaTaxClient	  
+      # @param domainControlVerificationId [String] 
+      # @return [Object]
+      def get_dcv_by_id(domainControlVerificationId)        path = "/api/v2/domain-control-verifications/#{domainControlVerificationId}"
+        get(path, {}, AvaTax::VERSION)      end
+    end
+  end
+end

lib/avatax/version.rb

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