avatax 23.8.1 → 23.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeef1574896e478aa21341aff33fc8d664c1b130b3e13fc6d78bc3c5373d39bd
-  data.tar.gz: 3edafaf948b4592076b70ea2848c4a3dc130182f80ee4ab2fb7c81bd76e2e8bf
+  metadata.gz: 4b284a025cf6da4d08e800948c224d4349fd0b135c2bbd93b894a8896db0250b
+  data.tar.gz: 4d5bb87fb862f66cbaabe6dbbb532f3aae5c6934a6ff4dc990152d8a17aefac2
 SHA512:
-  metadata.gz: 8b5efe3e93349e52d25ce7b9ba222a8bed185fd672a67fd6aaa12d93ffc51779e393e1dc45b9da32e2b21a8b99198a9e2161b75f9f463030a9f2b24308320ecc
-  data.tar.gz: 6509f4d7379c091a8bbbd69858aff375a7d42bc9b917ee0be6cc92d2e6cd833db1f84f4fc903c64e84f743220ae53b44c34fbcd437da301438cd6e9b09722ad7
+  metadata.gz: '0899840e86762bb4d0d9ab85d08c566ec8ed531c25341b0d7d1382f512ed720fd3523dd9649231289045546c41e038e7606856979280c3c2a2e36ccb0f4ed6c1'
+  data.tar.gz: 73ba848201eaf752af22923a1298a1568d1d2bca65d9b7dc95bfcfb8b75530bb11013c4ef17130727e5a9c29d52c0d2e87b6f66c8e479a4ecba7a754baa283aa

data/lib/avatax/client/accounts.rb

@@ -191,6 +191,20 @@ module AvaTax
       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.

data/lib/avatax/client/addresses.rb

@@ -3,12 +3,14 @@ module AvaTax
     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 AvaTax
       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

data/lib/avatax/client/apconfigsetting.rb

@@ -0,0 +1,54 @@
+module AvaTax
+  class Client
+    module APConfigSetting 
+
+
+      # Create new rule
+      #
+      # 
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this AP Config Setting object
+      # @param model [Object] The AP Config Setting you wish to create.
+      # @return [Object]
+      def create_a_p_config_setting(companyid, model)        path = "/api/v2/companies/#{companyid}/apconfigsetting"
+        post(path, model, {}, AvaTax::VERSION)      end
+
+      # Retrieve rule for this company
+      #
+      # 
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that defined this rule
+      # @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:* meta, amount, varianceForIgnore, varianceForAccrue, variancePercent
+      # @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 get_a_p_config_setting_by_company(companyid, options={})        path = "/api/v2/companies/#{companyid}/apconfigsetting"
+        get(path, options, AvaTax::VERSION)      end
+
+      # Retrieve all rules
+      #
+      # 
+      # 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:* meta, amount, varianceForIgnore, varianceForAccrue, variancePercent
+      # @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_a_p_config_setting(options={})        path = "/api/v2/apconfigsetting"
+        get(path, options, AvaTax::VERSION)      end
+
+      # Update a AP config setting
+      #
+      # 
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this AP config setting object
+      # @param model [Object] The AP config setting object you wish to update.
+      # @return [Object]
+      def update_a_p_config_setting(companyid, model)        path = "/api/v2/companies/#{companyid}/apconfigsetting"
+        put(path, model, {}, AvaTax::VERSION)      end
+    end
+  end
+end

data/lib/avatax/client/costcenter.rb

@@ -0,0 +1,87 @@
+module AvaTax
+  class Client
+    module CostCenter 
+
+
+      # Bulk upload cost centers
+      #
+      # Allows bulk upload of cost centers for the specified company. Use the companyId path parameter to identify the company for which the cost centers should be uploaded.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this cost center object
+      # @param model [Object] The cost center bulk upload model.
+      # @return [Object]
+      def bulk_upload_cost_centers(companyid, model)        path = "/api/v2/companies/#{companyid}/costcenters/$upload"
+        post(path, model, {}, AvaTax::VERSION)      end
+
+      # Create new cost center
+      #
+      # Creates one or more new item objects attached to this company.
+      #
+      # Costcenter is defined as function or department within a company which is not directly going to generate revenues and profits to the company but is still incurring expenses to the company for its operations.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this cost center object
+      # @param model [Object] The cost center you wish to create.
+      # @return [Object]
+      def create_cost_center(companyid, model)        path = "/api/v2/companies/#{companyid}/costcenters"
+        post(path, model, {}, AvaTax::VERSION)      end
+
+      # Delete cost center for the given id
+      #
+      # Deletes a cost center with the specified costcenterId that belongs to the company.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this cost center object
+      # @param costcenterid [Integer] The primary key of this cost center
+      # @return [Object]
+      def delete_cost_center(companyid, costcenterid)        path = "/api/v2/companies/#{companyid}/costcenters/#{costcenterid}"
+        delete(path, {}, AvaTax::VERSION)      end
+
+      # Retrieve a single cost center
+      #
+      # Retrieves details of a single cost center identified by costcenterId, which is owned by the company.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this cost center object
+      # @param costcenterid [Integer] The primary key of this cost center
+      # @return [Object]
+      def get_cost_center_by_id(companyid, costcenterid)        path = "/api/v2/companies/#{companyid}/costcenters/#{costcenterid}"
+        get(path, {}, AvaTax::VERSION)      end
+
+      # Retrieve cost centers for this company
+      #
+      # Retrieves a list of cost centers attached to this company. You can apply filters to retrieve specific records.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that defined these cost centers
+      # @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:* companyId, meta, defaultItem
+      # @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
+      # @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_cost_centers_by_company(companyid, options={})        path = "/api/v2/companies/#{companyid}/costcenters"
+        get(path, options, AvaTax::VERSION)      end
+
+      # Retrieve all cost centers
+      #
+      # Retrieves all cost centers available. You can apply filters to retrieve specific records.
+      # 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:* companyId, meta, defaultItem
+      # @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
+      # @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_cost_centers(options={})        path = "/api/v2/costcenters"
+        get(path, options, AvaTax::VERSION)      end
+
+      # Update a single cost center
+      #
+      # Updates a single cost center owned by the company. Use the costcenterId path parameter to identify the cost center to update.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyid [Integer] The ID of the company that owns this cost center object
+      # @param costcenterid [Integer] The primary key of this cost center
+      # @param model [Object] The cost center object you wish to update.
+      # @return [Object]
+      def update_cost_center(companyid, costcenterid, model)        path = "/api/v2/companies/#{companyid}/costcenters/#{costcenterid}"
+        put(path, model, {}, AvaTax::VERSION)      end
+    end
+  end
+end

data/lib/avatax/client/customers.rb

@@ -54,7 +54,7 @@ module AvaTax
       # 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
 

data/lib/avatax/client/definitions.rb

@@ -362,6 +362,22 @@ module AvaTax
       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
@@ -825,7 +841,7 @@ module AvaTax
       # This API is intended to be useful to identify all the different rate types.
       # Swagger Name: AvaTaxClient	  
       # @param country [String] The country to examine for rate types
-      # @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 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:* country
       # @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`.

data/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

data/lib/avatax/client/shippingverificationbatches.rb

@@ -0,0 +1,44 @@
+module AvaTax
+  class Client
+    module ShippingVerificationBatches 
+
+
+      # Enqueues a batch of AvaTax transactions to be deregistered by ASV
+      #
+      # 
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param companyCode [String] The company code of the company that recorded the transaction
+      # @param batchCode [String] The batch code of generated by AvaTax batch transaction upload
+      # @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 enqueue_batch_deregistration(companyCode, batchCode, options={}, x_avalara_version="")        path = "/api/v2/asv/companies/#{companyCode}/batches/#{batchCode}/deregister"
+        headers= Hash.new
+        headers["x-avalara-version"]=x_avalara_version if !(x_avalara_version.nil? || x_avalara_version.empty?);
+        put(path, options, AvaTax::VERSION, headers)      end
+
+      # Enqueues a batch of AvaTax transactions to be registered by ASV
+      #
+      # 
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param companyCode [String] The company code of the company that recorded the transaction
+      # @param batchCode [String] The batch code generated by AvaTax for batch transaction upload process
+      # @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 enqueue_batch_registration(companyCode, batchCode, options={}, x_avalara_version="")        path = "/api/v2/asv/companies/#{companyCode}/batches/#{batchCode}/register"
+        headers= Hash.new
+        headers["x-avalara-version"]=x_avalara_version if !(x_avalara_version.nil? || x_avalara_version.empty?);
+        put(path, options, AvaTax::VERSION, headers)      end
+
+      # Gets records for current and previously processed batch registration jobs
+      #
+      # 
+      # Swagger Name: AvaTaxBeverageClient	  
+      # @param accountId [String] (Optional): For users with access to multiple accounts, filters results to those associated with the specified Account ID. If not specified, the Account ID defaults to the one associated with the account
+      # @return [Object]
+      def get_batch_registration_data(options={})        path = "/api/v2/asv/batches"
+        get(path, options, AvaTax::VERSION)      end
+    end
+  end
+end

data/lib/avatax/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 23.8.1
+  version: 23.11.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,7 @@ files:
 - lib/avatax/client/addresses.rb
 - lib/avatax/client/advancedrules.rb
 - lib/avatax/client/ageverification.rb
+- lib/avatax/client/apconfigsetting.rb
 - lib/avatax/client/avafileforms.rb
 - lib/avatax/client/batches.rb
 - lib/avatax/client/certexpressinvites.rb
@@ -129,10 +130,12 @@ files:
 - lib/avatax/client/companies.rb
 - lib/avatax/client/compliance.rb
 - lib/avatax/client/contacts.rb
+- lib/avatax/client/costcenter.rb
 - lib/avatax/client/customers.rb
 - lib/avatax/client/datasources.rb
 - lib/avatax/client/definitions.rb
 - lib/avatax/client/distancethresholds.rb
+- lib/avatax/client/domaincontrolverification.rb
 - lib/avatax/client/ecms.rb
 - lib/avatax/client/ecommercetoken.rb
 - lib/avatax/client/errortransactions.rb
@@ -155,6 +158,7 @@ files:
 - lib/avatax/client/reports.rb
 - lib/avatax/client/settings.rb
 - lib/avatax/client/shippingverification.rb
+- lib/avatax/client/shippingverificationbatches.rb
 - lib/avatax/client/subscriptions.rb
 - lib/avatax/client/taxContent/README.txt
 - lib/avatax/client/taxRatesByZip/README.txt