@sp-api-sdk/catalog-items-api-v0 3.0.4 → 4.0.0

package/dist/types/api-model/api/catalog-api.d.ts

@@ -1,250 +0,0 @@
-/**
- * Selling Partner API for Catalog Items
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { Configuration } from '../configuration';
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import globalAxios from 'axios';
-import { type RequestArgs, BaseAPI } from '../base';
-import type { GetCatalogItemResponse } from '../models';
-import type { ListCatalogCategoriesResponse } from '../models';
-import type { ListCatalogItemsResponse } from '../models';
-/**
- * CatalogApi - axios parameter creator
- * @export
- */
-export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
-     * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getCatalogItem: (marketplaceId: string, asin: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. 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 {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
-     * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
-     * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCatalogCategories: (marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which items are returned.
-     * @param {string} [query] Keyword(s) to use to search for items in the catalog. Example: \&#39;harry potter books\&#39;.
-     * @param {string} [queryContextId] An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.
-     * @param {string} [sellerSKU] Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
-     * @param {string} [uPC] A 12-digit bar code used for retail packaging.
-     * @param {string} [eAN] A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-     * @param {string} [iSBN] The unique commercial book identifier used to identify books internationally.
-     * @param {string} [jAN] A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCatalogItems: (marketplaceId: string, query?: string, queryContextId?: string, sellerSKU?: string, uPC?: string, eAN?: string, iSBN?: string, jAN?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * CatalogApi - functional programming interface
- * @export
- */
-export declare const CatalogApiFp: (configuration?: Configuration) => {
-    /**
-     * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
-     * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getCatalogItem(marketplaceId: string, asin: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCatalogItemResponse>>;
-    /**
-     * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. 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 {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item.
-     * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item.
-     * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCatalogCategories(marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCatalogCategoriesResponse>>;
-    /**
-     * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which items are returned.
-     * @param {string} [query] Keyword(s) to use to search for items in the catalog. Example: \&#39;harry potter books\&#39;.
-     * @param {string} [queryContextId] An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.
-     * @param {string} [sellerSKU] Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
-     * @param {string} [uPC] A 12-digit bar code used for retail packaging.
-     * @param {string} [eAN] A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-     * @param {string} [iSBN] The unique commercial book identifier used to identify books internationally.
-     * @param {string} [jAN] A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCatalogItems(marketplaceId: string, query?: string, queryContextId?: string, sellerSKU?: string, uPC?: string, eAN?: string, iSBN?: string, jAN?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCatalogItemsResponse>>;
-};
-/**
- * CatalogApi - factory interface
- * @export
- */
-export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCatalogItemResponse>;
-    /**
-     * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. 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 {CatalogApiListCatalogCategoriesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCatalogCategories(requestParameters: CatalogApiListCatalogCategoriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCatalogCategoriesResponse>;
-    /**
-     * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {CatalogApiListCatalogItemsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listCatalogItems(requestParameters: CatalogApiListCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCatalogItemsResponse>;
-};
-/**
- * Request parameters for getCatalogItem operation in CatalogApi.
- * @export
- * @interface CatalogApiGetCatalogItemRequest
- */
-export interface CatalogApiGetCatalogItemRequest {
-    /**
-     * A marketplace identifier. Specifies the marketplace for the item.
-     * @type {string}
-     * @memberof CatalogApiGetCatalogItem
-     */
-    readonly marketplaceId: string;
-    /**
-     * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof CatalogApiGetCatalogItem
-     */
-    readonly asin: string;
-}
-/**
- * Request parameters for listCatalogCategories operation in CatalogApi.
- * @export
- * @interface CatalogApiListCatalogCategoriesRequest
- */
-export interface CatalogApiListCatalogCategoriesRequest {
-    /**
-     * A marketplace identifier. Specifies the marketplace for the item.
-     * @type {string}
-     * @memberof CatalogApiListCatalogCategories
-     */
-    readonly marketplaceId: string;
-    /**
-     * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof CatalogApiListCatalogCategories
-     */
-    readonly aSIN?: string;
-    /**
-     * Used to identify items in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
-     * @type {string}
-     * @memberof CatalogApiListCatalogCategories
-     */
-    readonly sellerSKU?: string;
-}
-/**
- * Request parameters for listCatalogItems operation in CatalogApi.
- * @export
- * @interface CatalogApiListCatalogItemsRequest
- */
-export interface CatalogApiListCatalogItemsRequest {
-    /**
-     * A marketplace identifier. Specifies the marketplace for which items are returned.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly marketplaceId: string;
-    /**
-     * Keyword(s) to use to search for items in the catalog. Example: \&#39;harry potter books\&#39;.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly query?: string;
-    /**
-     * An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly queryContextId?: string;
-    /**
-     * Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\&#39;s SellerId, which is included with every operation that you submit.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly sellerSKU?: string;
-    /**
-     * A 12-digit bar code used for retail packaging.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly uPC?: string;
-    /**
-     * A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly eAN?: string;
-    /**
-     * The unique commercial book identifier used to identify books internationally.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly iSBN?: string;
-    /**
-     * A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
-     * @type {string}
-     * @memberof CatalogApiListCatalogItems
-     */
-    readonly jAN?: string;
-}
-/**
- * CatalogApi - object-oriented interface
- * @export
- * @class CatalogApi
- * @extends {BaseAPI}
- */
-export declare class CatalogApi extends BaseAPI {
-    /**
-     * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CatalogApi
-     */
-    getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCatalogItemResponse, any>>;
-    /**
-     * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. 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 {CatalogApiListCatalogCategoriesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CatalogApi
-     */
-    listCatalogCategories(requestParameters: CatalogApiListCatalogCategoriesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListCatalogCategoriesResponse, any>>;
-    /**
-     * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption.  _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.
-     * @param {CatalogApiListCatalogItemsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CatalogApi
-     */
-    listCatalogItems(requestParameters: CatalogApiListCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListCatalogItemsResponse, any>>;
-}

package/dist/types/api-model/models/asinidentifier.d.ts

@@ -1,30 +0,0 @@
-/**
- * Selling Partner API for Catalog Items
- * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface ASINIdentifier
- */
-export interface ASINIdentifier {
-    /**
-     * A marketplace identifier.
-     * @type {string}
-     * @memberof ASINIdentifier
-     */
-    'MarketplaceId': string;
-    /**
-     * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof ASINIdentifier
-     */
-    'ASIN': string;
-}