Merge pull request #179 from avadev/25.6.2

svc-developer · web-flow · commit bf83d81bc0ba · 2025-06-26T09:54:04.000-07:00
25.6.2
diff --git a/lib/avatax/client/clerk.rb b/lib/avatax/client/clerk.rb
@@ -0,0 +1,25 @@
+module AvaTax
+  class Client
+    module Clerk 
+
+
+      # Retrieves a list of location records associated with the specified company.
+      # This endpoint is secured and requires appropriate subscription and permission levels.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique identifier of the company whose locations are being requested.
+      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:
+      # @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
+      # @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_location_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/clerk/locations"
+        get(path, options, AvaTax::VERSION)      end
+    end
+  end
+end
diff --git a/lib/avatax/client/definitions.rb b/lib/avatax/client/definitions.rb
@@ -1044,7 +1044,7 @@ def list_tax_authority_types(options={})        path = "/api/v2/definitions/taxa
       # Retrieves the list of Avalara-supported system tax codes.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
-      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       #
       # ### Security Policies
diff --git a/lib/avatax/client/items.rb b/lib/avatax/client/items.rb
@@ -236,6 +236,27 @@ def delete_item(companyId, id)        path = "/api/v2/companies/#{companyId}/ite
       def delete_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
         delete(path, {}, AvaTax::VERSION)      end
 
+      # Delete the image associated with an item.
+      #
+      # Delete the image associated with an item.
+      #
+      # Permanently deletes both the image and its association with the specified item.
+      # This endpoint allows users to manage product visual representations by removing outdated or incorrect images,
+      # and cleaning up unused resources in the system.
+      # Once deleted, the image association cannot be recovered. To use the image again, it must be re-uploaded and
+      # re-linked with the item.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID of the company.
+      # @param itemId [Integer] The unique ID of the item.
+      # @param imageId [String] The unique ID of the image to delete.
+      # @return [AssociatedObjectDeletedErrorDetailsModel[]]
+      def delete_item_image(companyId, itemId, imageId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
+        delete(path, {}, AvaTax::VERSION)      end
+
       # Delete a single item parameter
       #
       # Delete a single item parameter.
@@ -439,6 +460,24 @@ def get_item_tax_code_recommendations(companyId, itemId)        path = "/api/v2/
       def get_premium_classification(companyId, itemCode, systemCode, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemCode}/premiumClassification/#{systemCode}"
         get(path, options, AvaTax::VERSION)      end
 
+      # Get the image associated with an item.
+      #
+      # Get the image file for the specified image ID linked to the item.
+      #
+      # This endpoint allows users to retrieve and display product images in user interfaces or to verify the current
+      # image associated with a specific item.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID of the company.
+      # @param itemId [Integer] The unique ID of the item.
+      # @param imageId [String] The unique ID of the image to retrieve.
+      # @return [Object]
+      def get_product_image(companyId, itemId, imageId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
+        get(path, {}, AvaTax::VERSION)      end
+
       # Create an HS code classification request.
       #
       # ### Security Policies
@@ -598,7 +637,7 @@ def list_item_premium_classifications(companyId, itemCode, options={})        pa
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that defined these items
-      # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus
+      # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
       # @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.
@@ -677,7 +716,7 @@ def patch_item(companyId, id, model)        path = "/api/v2/companies/#{companyI
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # 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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus
+      # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
       # @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.
@@ -734,7 +773,7 @@ def query_items_by_system_code(companyId, systemCode, model, options={})
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that defined these items.
       # @param tag [String] The master tag to be associated with item.
-      # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus
+      # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
       # @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.
@@ -788,6 +827,25 @@ def sync_item_catalogue(companyId, model)        path = "/api/v2/companies/#{com
       def sync_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/sync"
         post(path, model, {}, AvaTax::VERSION)      end
 
+      # Update an existing image for an item.
+      #
+      # This endpoint allows users to update the existing image associated with a specific item by uploading a new image file.
+      #
+      # The updated image serves as the item's visual representation and will be used for tax code recommendation purposes.
+      #
+      # Restrictions:
+      # - Supported formats: JPEG, GIF, PNG
+      # - Maximum file size: 10MB
+      # - Maximum file name length allowed: 200 characters
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID of the company.
+      # @param itemId [Integer] The unique ID of the item.
+      # @param imageId [String] The unique ID of the image to update.
+      # @param imageFile [Object] 
+      # @return [Object]
+      def update_image(companyId, itemId, imageId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
+        put(path, {}, AvaTax::VERSION)      end
+
       # Update a single item
       #
       # Replace the existing `Item` object at this URL with an updated object.
@@ -860,6 +918,24 @@ def update_item_classification(companyId, itemId, id, model)        path = "/api
       def update_item_parameter(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         put(path, model, {}, AvaTax::VERSION)      end
 
+      # Upload an image for an item.
+      #
+      # This endpoint allows users to upload an image file for a specific item.
+      #
+      # The uploaded image serves as the item's visual representation and will be used for tax code recommendation purposes.
+      #
+      # Restrictions:
+      # - Supported formats: JPEG, GIF, PNG
+      # - Maximum file size: 10MB
+      # - Maximum file name length allowed: 200 characters
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID of the company.
+      # @param itemId [Integer] The unique ID of the item.
+      # @param imageFile [Object] 
+      # @return [Object]
+      def upload_image(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/images"
+        post(path, {}, {}, AvaTax::VERSION)      end
+
       # Add/update item classifications.
       #
       # Add/update classifications to an item.
diff --git a/lib/avatax/client/taxcodes.rb b/lib/avatax/client/taxcodes.rb
@@ -8,7 +8,7 @@ module TaxCodes
       # Create one or more new taxcode objects attached to this company.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
-      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       #
       # ### Security Policies
@@ -40,7 +40,7 @@ def delete_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}
       # Get the taxcode object identified by this URL.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
-      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       #
       # ### Security Policies
@@ -58,7 +58,7 @@ def get_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/ta
       # List all taxcode objects attached to this company.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
-      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
@@ -83,7 +83,7 @@ def list_tax_codes_by_company(companyId, options={})        path = "/api/v2/comp
       # Get multiple taxcode objects across all companies.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
-      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
@@ -107,7 +107,7 @@ def query_tax_codes(options={})        path = "/api/v2/taxcodes"
       # Replace the existing taxcode object at this URL with an updated object.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
-      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
       # All data from the existing object will be replaced with data in the object you PUT.
       # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
diff --git a/lib/avatax/version.rb b/lib/avatax/version.rb
@@ -1,3 +1,3 @@
 ﻿module AvaTax
-  VERSION = '25.5.1'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '25.6.2'.freeze unless defined?(::AvaTax::VERSION)
 end

Original file line number	Diff line number	Diff line change
`@@ -1044,7 +1044,7 @@ def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxa`
`1044`	`1044`	`# Retrieves the list of Avalara-supported system tax codes.`
`1045`	`1045`	`# A 'TaxCode' represents a uniquely identified type of product, good, or service.`
`1046`	`1046`	`# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.`
`1047`		`- # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and`
	`1047`	`+ # If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and`
`1048`	`1048`	`# taxability rules for this product in all supported jurisdictions.`
`1049`	`1049`	`#`
`1050`	`1050`	`# ### Security Policies`