@sp-api-sdk/product-type-definitions-api-2020-09-01 2.0.1 → 2.1.0

package/dist/cjs/src/api-model/api/definitions-api.js

@@ -86,11 +86,14 @@ const DefinitionsApiAxiosParamCreator = function (configuration) {
         /**
          * Search for and return a list of Amazon product types that have definitions available.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
          * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
-         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types by.
+         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
+         * @param {string} [itemName] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+         * @param {string} [locale] The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+         * @param {string} [searchLocale] The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchDefinitionsProductTypes: async (marketplaceIds, keywords, options = {}) => {
+        searchDefinitionsProductTypes: async (marketplaceIds, keywords, itemName, locale, searchLocale, options = {}) => {
             // verify required parameter 'marketplaceIds' is not null or undefined
             (0, common_1.assertParamExists)('searchDefinitionsProductTypes', 'marketplaceIds', marketplaceIds);
             const localVarPath = `/definitions/2020-09-01/productTypes`;
@@ -109,6 +112,15 @@ const DefinitionsApiAxiosParamCreator = function (configuration) {
             if (marketplaceIds) {
                 localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(base_1.COLLECTION_FORMATS.csv);
             }
+            if (itemName !== undefined) {
+                localVarQueryParameter['itemName'] = itemName;
+            }
+            if (locale !== undefined) {
+                localVarQueryParameter['locale'] = locale;
+            }
+            if (searchLocale !== undefined) {
+                localVarQueryParameter['searchLocale'] = searchLocale;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -146,12 +158,15 @@ const DefinitionsApiFp = function (configuration) {
         /**
          * Search for and return a list of Amazon product types that have definitions available.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
          * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
-         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types by.
+         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
+         * @param {string} [itemName] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+         * @param {string} [locale] The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+         * @param {string} [searchLocale] The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async searchDefinitionsProductTypes(marketplaceIds, keywords, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.searchDefinitionsProductTypes(marketplaceIds, keywords, options);
+        async searchDefinitionsProductTypes(marketplaceIds, keywords, itemName, locale, searchLocale, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.searchDefinitionsProductTypes(marketplaceIds, keywords, itemName, locale, searchLocale, options);
             return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
         },
     };
@@ -180,7 +195,7 @@ const DefinitionsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         searchDefinitionsProductTypes(requestParameters, options) {
-            return localVarFp.searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, options).then((request) => request(axios, basePath));
+            return localVarFp.searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, requestParameters.itemName, requestParameters.locale, requestParameters.searchLocale, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -210,7 +225,7 @@ class DefinitionsApi extends base_1.BaseAPI {
      * @memberof DefinitionsApi
      */
     searchDefinitionsProductTypes(requestParameters, options) {
-        return (0, exports.DefinitionsApiFp)(this.configuration).searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.DefinitionsApiFp)(this.configuration).searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, requestParameters.itemName, requestParameters.locale, requestParameters.searchLocale, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.DefinitionsApi = DefinitionsApi;

package/dist/es/src/api-model/api/definitions-api.js

@@ -80,11 +80,14 @@ export const DefinitionsApiAxiosParamCreator = function (configuration) {
         /**
          * Search for and return a list of Amazon product types that have definitions available.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
          * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
-         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types by.
+         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
+         * @param {string} [itemName] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+         * @param {string} [locale] The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+         * @param {string} [searchLocale] The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchDefinitionsProductTypes: async (marketplaceIds, keywords, options = {}) => {
+        searchDefinitionsProductTypes: async (marketplaceIds, keywords, itemName, locale, searchLocale, options = {}) => {
             // verify required parameter 'marketplaceIds' is not null or undefined
             assertParamExists('searchDefinitionsProductTypes', 'marketplaceIds', marketplaceIds);
             const localVarPath = `/definitions/2020-09-01/productTypes`;
@@ -103,6 +106,15 @@ export const DefinitionsApiAxiosParamCreator = function (configuration) {
             if (marketplaceIds) {
                 localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
             }
+            if (itemName !== undefined) {
+                localVarQueryParameter['itemName'] = itemName;
+            }
+            if (locale !== undefined) {
+                localVarQueryParameter['locale'] = locale;
+            }
+            if (searchLocale !== undefined) {
+                localVarQueryParameter['searchLocale'] = searchLocale;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -139,12 +151,15 @@ export const DefinitionsApiFp = function (configuration) {
         /**
          * Search for and return a list of Amazon product types that have definitions available.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
          * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
-         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types by.
+         * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
+         * @param {string} [itemName] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+         * @param {string} [locale] The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+         * @param {string} [searchLocale] The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async searchDefinitionsProductTypes(marketplaceIds, keywords, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.searchDefinitionsProductTypes(marketplaceIds, keywords, options);
+        async searchDefinitionsProductTypes(marketplaceIds, keywords, itemName, locale, searchLocale, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.searchDefinitionsProductTypes(marketplaceIds, keywords, itemName, locale, searchLocale, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     };
@@ -172,7 +187,7 @@ export const DefinitionsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         searchDefinitionsProductTypes(requestParameters, options) {
-            return localVarFp.searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, options).then((request) => request(axios, basePath));
+            return localVarFp.searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, requestParameters.itemName, requestParameters.locale, requestParameters.searchLocale, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -201,6 +216,6 @@ export class DefinitionsApi extends BaseAPI {
      * @memberof DefinitionsApi
      */
     searchDefinitionsProductTypes(requestParameters, options) {
-        return DefinitionsApiFp(this.configuration).searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, options).then((request) => request(this.axios, this.basePath));
+        return DefinitionsApiFp(this.configuration).searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, requestParameters.itemName, requestParameters.locale, requestParameters.searchLocale, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/dist/types/src/api-model/api/definitions-api.d.ts

@@ -35,11 +35,14 @@ export declare const DefinitionsApiAxiosParamCreator: (configuration?: Configura
     /**
      * Search for and return a list of Amazon product types that have definitions available.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
-     * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types by.
+     * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
+     * @param {string} [itemName] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @param {string} [locale] The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+     * @param {string} [searchLocale] The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    searchDefinitionsProductTypes: (marketplaceIds: Array<string>, keywords?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    searchDefinitionsProductTypes: (marketplaceIds: Array<string>, keywords?: Array<string>, itemName?: string, locale?: string, searchLocale?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * DefinitionsApi - functional programming interface
@@ -62,11 +65,14 @@ export declare const DefinitionsApiFp: (configuration?: Configuration) => {
     /**
      * Search for and return a list of Amazon product types that have definitions available.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
-     * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types by.
+     * @param {Array<string>} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
+     * @param {string} [itemName] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @param {string} [locale] The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+     * @param {string} [searchLocale] The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    searchDefinitionsProductTypes(marketplaceIds: Array<string>, keywords?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductTypeList>>;
+    searchDefinitionsProductTypes(marketplaceIds: Array<string>, keywords?: Array<string>, itemName?: string, locale?: string, searchLocale?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductTypeList>>;
 };
 /**
  * DefinitionsApi - factory interface
@@ -150,11 +156,29 @@ export interface DefinitionsApiSearchDefinitionsProductTypesRequest {
      */
     readonly marketplaceIds: Array<string>;
     /**
-     * A comma-delimited list of keywords to search product types by.
+     * A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
      * @type {Array<string>}
      * @memberof DefinitionsApiSearchDefinitionsProductTypes
      */
     readonly keywords?: Array<string>;
+    /**
+     * The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @type {string}
+     * @memberof DefinitionsApiSearchDefinitionsProductTypes
+     */
+    readonly itemName?: string;
+    /**
+     * The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+     * @type {string}
+     * @memberof DefinitionsApiSearchDefinitionsProductTypes
+     */
+    readonly locale?: string;
+    /**
+     * The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
+     * @type {string}
+     * @memberof DefinitionsApiSearchDefinitionsProductTypes
+     */
+    readonly searchLocale?: string;
 }
 /**
  * DefinitionsApi - object-oriented interface

package/dist/types/src/api-model/models/product-type-definition.d.ts

@@ -68,6 +68,12 @@ export interface ProductTypeDefinition {
      * @memberof ProductTypeDefinition
      */
     'productType': string;
+    /**
+     * Human-readable and localized description of the Amazon product type.
+     * @type {string}
+     * @memberof ProductTypeDefinition
+     */
+    'displayName': string;
     /**
      *
      * @type {ProductTypeVersion}

package/dist/types/src/api-model/models/product-type-list.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { ProductType } from './product-type';
+import { ProductTypeVersion } from './product-type-version';
 /**
  * A list of Amazon product types with definitions available.
  * @export
@@ -22,4 +23,10 @@ export interface ProductTypeList {
      * @memberof ProductTypeList
      */
     'productTypes': Array<ProductType>;
+    /**
+     *
+     * @type {ProductTypeVersion}
+     * @memberof ProductTypeList
+     */
+    'productTypeVersion': ProductTypeVersion;
 }

package/dist/types/src/api-model/models/product-type.d.ts

@@ -21,6 +21,12 @@ export interface ProductType {
      * @memberof ProductType
      */
     'name': string;
+    /**
+     * The human-readable and localized description of the Amazon product type.
+     * @type {string}
+     * @memberof ProductType
+     */
+    'displayName': string;
     /**
      * The Amazon marketplace identifiers for which the product type definition is available.
      * @type {Array<string>}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/product-type-definitions-api-2020-09-01",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the Product Type Definitions API Use Case Guide.",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.0.1",
-    "axios": "^1.6.0"
+    "@sp-api-sdk/common": "2.0.2",
+    "axios": "^1.6.1"
   },
   "repository": {
     "type": "git",
@@ -40,5 +40,5 @@
     "sp sdk",
     "product type definitions api"
   ],
-  "gitHead": "9bb159a54b588ec3184def8b5f2ae9b91cdfbcf5"
+  "gitHead": "23d420d10e931be7657141e989fccdc9dafe2a9c"
 }