avatax 20.9.0 → 21.10.0

data/lib/avatax/client/items.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Items 
-
-
-      # Delete all classifications for an item
-      #
+module AvaTax
+  class Client
+    module Items 
+
+
+      # Delete all classifications for an item
+      #
       # Delete all the classifications for a given item.
       #
       # A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
@@ -13,15 +13,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param itemId [Integer] The ID of the item you wish to delete the classifications.
-      # @return [ErrorDetail[]]
-      def batch_delete_item_classifications(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
-        delete(path)      end
-
-      # Delete all parameters for an item
-      #
+      # @return [ErrorDetail[]]
+      def batch_delete_item_classifications(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
+        delete(path)      end
+
+      # Delete all parameters for an item
+      #
       # Delete all the parameters for a given item.
       #
       # Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
@@ -32,15 +32,36 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param itemId [Integer] The ID of the item you wish to delete the parameters.
-      # @return [ErrorDetail[]]
-      def batch_delete_item_parameters(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
-        delete(path)      end
-
-      # Add classifications to an item.
+      # @return [ErrorDetail[]]
+      def batch_delete_item_parameters(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
+        delete(path)      end
+
+      # Bulk upload items from a product catalog
+      #
+      # Create/Update one or more item objects attached to this company.
+      #
+      # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
+      # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
+      # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
+      #
+      # The tax code takes precedence over the tax code id if both are provided.
+      #
+      # ### Security Policies
       #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this items.
+      # @param model [Object] The items you wish to upload.
+      # @return [Object]
+      def bulk_upload_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/upload"
+        post(path, model)      end
+
+      # Add classifications to an item.
+      #
       # Add classifications to an item.
       #
       # A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
@@ -51,16 +72,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id.
       # @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
-      # @return [ItemClassificationOutputModel[]]
-      def create_item_classifications(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
-        post(path, model)      end
-
-      # Add parameters to an item.
-      #
+      # @return [ItemClassificationOutputModel[]]
+      def create_item_classifications(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
+        post(path, model)      end
+
+      # Add parameters to an item.
+      #
       # Add parameters to an item.
       #
       # Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
@@ -75,16 +96,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this item parameter.
       # @param itemId [Integer] The item id.
       # @param model [ItemParameterModel[]] The item parameters you wish to create.
-      # @return [ItemParameterModel[]]
-      def create_item_parameters(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
-        post(path, model)      end
-
-      # Create a new item
-      #
+      # @return [ItemParameterModel[]]
+      def create_item_parameters(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
+        post(path, model)      end
+
+      # Create a new item
+      #
       # Creates one or more new item objects attached to this company.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
@@ -97,15 +118,31 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param model [ItemModel[]] The item you wish to create.
-      # @return [ItemModel[]]
-      def create_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items"
-        post(path, model)      end
-
-      # Delete a single item
+      # @return [ItemModel[]]
+      def create_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items"
+        post(path, model)      end
+
+      # Create tags for a item
+      #
+      # Creates one or more new `Tag` objects attached to this Item.
       #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @param model [ItemTagDetailModel[]] Tags you wish to associate with the Item
+      # @return [ItemTagDetailModel[]]
+      def create_item_tags(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
+        post(path, model)      end
+
+      # Delete a single item
+      #
       # Deletes the item object at this URL.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
@@ -118,15 +155,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param id [Integer] The ID of the item you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_item(companyId, id)        path = "/api/v2/companies/#{companyId}/items/#{id}"
-        delete(path)      end
-
-      # Delete a single item classification.
-      #
+      # @return [ErrorDetail[]]
+      def delete_item(companyId, id)        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        delete(path)      end
+
+      # Delete a single item classification.
+      #
       # Delete a single item classification.
       #
       # A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
@@ -135,16 +172,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id.
       # @param id [Integer] The item classification id.
-      # @return [ErrorDetail[]]
-      def delete_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
-        delete(path)      end
-
-      # Delete a single item parameter
-      #
+      # @return [ErrorDetail[]]
+      def delete_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
+        delete(path)      end
+
+      # Delete a single item parameter
+      #
       # Delete a single item parameter.
       #
       # Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
@@ -155,16 +192,47 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id
       # @param itemId [Integer] The item id
       # @param id [Integer] The parameter id
-      # @return [ErrorDetail[]]
-      def delete_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
-        delete(path)      end
-
-      # Retrieve a single item
+      # @return [ErrorDetail[]]
+      def delete_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
+        delete(path)      end
+
+      # Delete item tag by id
+      #
+      # Deletes the `Tag` object of an Item at this URL.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
       #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_item_tag(companyId, itemId, itemTagDetailId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
+        delete(path)      end
+
+      # Delete all item tags
+      #
+      # Deletes all `Tags` objects of an Item at this URL.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that defined these items.
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @return [ErrorDetail[]]
+      def delete_item_tags(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
+        delete(path)      end
+
+      # Retrieve a single item
+      #
       # Get the `Item` object identified by this URL.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
@@ -175,16 +243,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns this item object
       # @param id [Integer] The primary key of this item
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @return [Object]
-      def get_item(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/items/#{id}"
-        get(path, options)      end
-
-      # Retrieve a single item classification.
-      #
+      # @return [Object]
+      def get_item(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        get(path, options)      end
+
+      # Retrieve a single item classification.
+      #
       # Retrieve a single item classification.
       #
       # A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
@@ -193,16 +261,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id.
       # @param id [Integer] The item classification id.
-      # @return [Object]
-      def get_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
-        get(path)      end
-
-      # Retrieve a single item parameter
-      #
+      # @return [Object]
+      def get_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
+        get(path)      end
+
+      # Retrieve a single item parameter
+      #
       # Retrieve a single item parameter.
       #
       # Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
@@ -213,16 +281,34 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id
       # @param itemId [Integer] The item id
       # @param id [Integer] The parameter id
-      # @return [Object]
-      def get_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
-        get(path)      end
-
-      # Retrieve classifications for an item.
+      # @return [Object]
+      def get_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
+        get(path)      end
+
+      # Retrieve tags for an item
+      #
+      # Get the `Tag` objects of an Item identified by this URL.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
       #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @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:* tagName
+      # @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 get_item_tags(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
+        get(path, options)      end
+
+      # Retrieve classifications for an item.
+      #
       # List classifications for an item.
       #
       # A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
@@ -234,19 +320,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id.
       # @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:* productCode, systemCode
       # @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_item_classifications(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
-        get(path, options)      end
-
-      # Retrieve parameters for an item
-      #
+      # @return [FetchResult]
+      def list_item_classifications(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
+        get(path, options)      end
+
+      # Retrieve parameters for an item
+      #
       # List parameters for an item.
       #
       # Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
@@ -260,19 +346,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id
       # @param itemId [Integer] The item id
-      # @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:* name, unit
+      # @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:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification
       # @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_item_parameters(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
-        get(path, options)      end
-
-      # Retrieve items for this company
-      #
+      # @return [FetchResult]
+      def list_item_parameters(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
+        get(path, options)      end
+
+      # Retrieve items for this company
+      #
       # List all items defined for the current company.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
@@ -285,26 +371,30 @@ module AvaTax
       #
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       #
+      # You may specify Tag Name in the `tagName` query parameter if you want to filter items on the basis of tagName
+      #
       # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
       #
       # * Parameters
       # * Classifications
+      # * Tags
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @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, classifications, parameters
+      # @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, classifications, parameters, tags
       # @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 list_items_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/items"
-        get(path, options)      end
-
-      # Retrieve all items
-      #
+      # @param tagName [String] Tag Name on the basis of which you want to filter Items
+      # @return [FetchResult]
+      def list_items_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/items"
+        get(path, options)      end
+
+      # Retrieve all items
+      #
       # Get multiple item objects across all companies.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
@@ -319,18 +409,46 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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, classifications, parameters
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @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, classifications, parameters, tags
       # @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_items(options={})        path = "/api/v2/items"
-        get(path, options)      end
-
-      # Sync items from a product catalog
+      # @return [FetchResult]
+      def query_items(options={})        path = "/api/v2/items"
+        get(path, options)      end
+
+      # Retrieve all items associated with given tag
+      #
+      # Get multiple item objects associated with given tag.
       #
+      # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
+      # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
+      # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
+      #
+      # 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/) .
+      #
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @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, classifications, parameters, tags
+      # @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_items_by_tag(companyId, tag, options={})        path = "/api/v2/companies/#{companyId}/items/bytags/#{tag}"
+        get(path, options)      end
+
+      # Sync items from a product catalog
+      #
       # Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs
       # with AvaTax.
       #
@@ -346,15 +464,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param model [Object] The request object.
-      # @return [Object]
-      def sync_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/sync"
-        post(path, model)      end
-
-      # Update a single item
-      #
+      # @return [Object]
+      def sync_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/sync"
+        post(path, model)      end
+
+      # Update a single item
+      #
       # Replace the existing `Item` object at this URL with an updated object.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
@@ -370,16 +488,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that this item belongs to.
       # @param id [Integer] The ID of the item you wish to update
       # @param model [Object] The item object you wish to update.
-      # @return [Object]
-      def update_item(companyId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{id}"
-        put(path, model)      end
-
-      # Update an item classification.
-      #
+      # @return [Object]
+      def update_item(companyId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        put(path, model)      end
+
+      # Update an item classification.
+      #
       # Update an item classification.
       #
       # A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
@@ -390,17 +508,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id.
       # @param id [Integer] The item classification id.
       # @param model [Object] The item object you wish to update.
-      # @return [Object]
-      def update_item_classification(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
-        put(path, model)      end
-
-      # Update an item parameter
-      #
+      # @return [Object]
+      def update_item_classification(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
+        put(path, model)      end
+
+      # Update an item parameter
+      #
       # Update an item parameter.
       #
       # Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
@@ -411,14 +529,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id
       # @param id [Integer] The item parameter id
       # @param model [Object] The item object you wish to update.
-      # @return [Object]
-      def update_item_parameter(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_item_parameter(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
+        put(path, model)      end
+    end
+  end
 end