@sp-api-sdk/catalog-items-api-2022-04-01 1.1.0

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

@@ -0,0 +1,252 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { Item } from '../models';
+import { ItemSearchResults } from '../models';
+/**
+ * CatalogApi - axios parameter creator
+ * @export
+ */
+export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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} asin The Amazon Standard Identification Number (ASIN) of the item.
+     * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
+     * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, options?: any) => Promise<RequestArgs>;
+    /**
+     * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
+     * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
+     * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {number} [pageSize] Number of results to be returned per page.
+     * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
+     * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: string[] | undefined, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC" | undefined, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, sellerId?: string | undefined, keywords?: string[] | undefined, brandNames?: string[] | undefined, classificationIds?: string[] | undefined, pageSize?: number | undefined, pageToken?: string | undefined, keywordsLocale?: string | undefined, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * CatalogApi - functional programming interface
+ * @export
+ */
+export declare const CatalogApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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} asin The Amazon Standard Identification Number (ASIN) of the item.
+     * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
+     * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Item>>;
+    /**
+     * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
+     * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
+     * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {number} [pageSize] Number of results to be returned per page.
+     * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
+     * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchCatalogItems(marketplaceIds: Array<string>, identifiers?: string[] | undefined, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC" | undefined, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, sellerId?: string | undefined, keywords?: string[] | undefined, brandNames?: string[] | undefined, classificationIds?: string[] | undefined, pageSize?: number | undefined, pageToken?: string | undefined, keywordsLocale?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ItemSearchResults>>;
+};
+/**
+ * CatalogApi - factory interface
+ * @export
+ */
+export declare const CatalogApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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} asin The Amazon Standard Identification Number (ASIN) of the item.
+     * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
+     * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, options?: any): AxiosPromise<Item>;
+    /**
+     * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
+     * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
+     * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {number} [pageSize] Number of results to be returned per page.
+     * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
+     * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchCatalogItems(marketplaceIds: Array<string>, identifiers?: string[] | undefined, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC" | undefined, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, sellerId?: string | undefined, keywords?: string[] | undefined, brandNames?: string[] | undefined, classificationIds?: string[] | undefined, pageSize?: number | undefined, pageToken?: string | undefined, keywordsLocale?: string | undefined, options?: any): AxiosPromise<ItemSearchResults>;
+};
+/**
+ * Request parameters for getCatalogItem operation in CatalogApi.
+ * @export
+ * @interface CatalogApiGetCatalogItemRequest
+ */
+export interface CatalogApiGetCatalogItemRequest {
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item.
+     * @type {string}
+     * @memberof CatalogApiGetCatalogItem
+     */
+    readonly asin: string;
+    /**
+     * A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
+     * @type {Array<string>}
+     * @memberof CatalogApiGetCatalogItem
+     */
+    readonly marketplaceIds: Array<string>;
+    /**
+     * A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @type {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
+     * @memberof CatalogApiGetCatalogItem
+     */
+    readonly includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>;
+    /**
+     * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @type {string}
+     * @memberof CatalogApiGetCatalogItem
+     */
+    readonly locale?: string;
+}
+/**
+ * Request parameters for searchCatalogItems operation in CatalogApi.
+ * @export
+ * @interface CatalogApiSearchCatalogItemsRequest
+ */
+export interface CatalogApiSearchCatalogItemsRequest {
+    /**
+     * A comma-delimited list of Amazon marketplace identifiers for the request.
+     * @type {Array<string>}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly marketplaceIds: Array<string>;
+    /**
+     * A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
+     * @type {Array<string>}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly identifiers?: Array<string>;
+    /**
+     * Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
+     * @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC';
+    /**
+     * A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+     * @type {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>;
+    /**
+     * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+     * @type {string}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly locale?: string;
+    /**
+     * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
+     * @type {string}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly sellerId?: string;
+    /**
+     * A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @type {Array<string>}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly keywords?: Array<string>;
+    /**
+     * A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @type {Array<string>}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly brandNames?: Array<string>;
+    /**
+     * A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @type {Array<string>}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly classificationIds?: Array<string>;
+    /**
+     * Number of results to be returned per page.
+     * @type {number}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly pageSize?: number;
+    /**
+     * A token to fetch a certain page when there are multiple pages worth of results.
+     * @type {string}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly pageToken?: string;
+    /**
+     * The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+     * @type {string}
+     * @memberof CatalogApiSearchCatalogItems
+     */
+    readonly keywordsLocale?: string;
+}
+/**
+ * CatalogApi - object-oriented interface
+ * @export
+ * @class CatalogApi
+ * @extends {BaseAPI}
+ */
+export declare class CatalogApi extends BaseAPI {
+    /**
+     * Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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 {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CatalogApi
+     */
+    getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: any): Promise<import("axios").AxiosResponse<Item, any>>;
+    /**
+     * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [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 {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CatalogApi
+     */
+    searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: any): Promise<import("axios").AxiosResponse<ItemSearchResults, any>>;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from './api/catalog-api';

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

@@ -0,0 +1,55 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Configuration } from "./configuration";
+import { AxiosInstance } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: any;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}

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

@@ -0,0 +1,65 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Configuration } from "./configuration";
+import { RequestArgs } from "./base";
+import { AxiosInstance } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration | undefined) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration | undefined) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;

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

@@ -0,0 +1,83 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * 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 ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/src/api-model/models/brand-refinement.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Description of a brand that can be used to get more fine-grained search results.
+ * @export
+ * @interface BrandRefinement
+ */
+export interface BrandRefinement {
+    /**
+     * The estimated number of results that would still be returned if refinement key applied.
+     * @type {number}
+     * @memberof BrandRefinement
+     */
+    numberOfResults: number;
+    /**
+     * Brand name. For display and can be used as a search refinement.
+     * @type {string}
+     * @memberof BrandRefinement
+     */
+    brandName: string;
+}

package/dist/types/src/api-model/models/classification-refinement.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Description of a classification that can be used to get more fine-grained search results.
+ * @export
+ * @interface ClassificationRefinement
+ */
+export interface ClassificationRefinement {
+    /**
+     * The estimated number of results that would still be returned if refinement key applied.
+     * @type {number}
+     * @memberof ClassificationRefinement
+     */
+    numberOfResults: number;
+    /**
+     * Display name for the classification.
+     * @type {string}
+     * @memberof ClassificationRefinement
+     */
+    displayName: string;
+    /**
+     * Identifier for the classification that can be used for search refinement purposes.
+     * @type {string}
+     * @memberof ClassificationRefinement
+     */
+    classificationId: string;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A list of error responses returned when a request is unsuccessful.
+ * @export
+ * @interface ErrorList
+ */
+export interface ErrorList {
+    /**
+     *
+     * @type {Array<Error>}
+     * @memberof ErrorList
+     */
+    errors: Array<Error>;
+}

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

@@ -0,0 +1,26 @@
+export * from './brand-refinement';
+export * from './classification-refinement';
+export * from './error-list';
+export * from './item';
+export * from './item-browse-classification';
+export * from './item-classification-sales-rank';
+export * from './item-dimension';
+export * from './item-dimensions';
+export * from './item-dimensions-by-marketplace';
+export * from './item-display-group-sales-rank';
+export * from './item-identifier';
+export * from './item-identifiers-by-marketplace';
+export * from './item-image';
+export * from './item-images-by-marketplace';
+export * from './item-product-type-by-marketplace';
+export * from './item-relationship';
+export * from './item-relationships-by-marketplace';
+export * from './item-sales-ranks-by-marketplace';
+export * from './item-search-results';
+export * from './item-summary-by-marketplace';
+export * from './item-variation-theme';
+export * from './item-vendor-details-by-marketplace';
+export * from './item-vendor-details-category';
+export * from './model-error';
+export * from './pagination';
+export * from './refinements';

package/dist/types/src/api-model/models/item-browse-classification.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Selling Partner API for Catalog Items
+ * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-04-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Classification (browse node) associated with an Amazon catalog item.
+ * @export
+ * @interface ItemBrowseClassification
+ */
+export interface ItemBrowseClassification {
+    /**
+     * Display name for the classification.
+     * @type {string}
+     * @memberof ItemBrowseClassification
+     */
+    displayName: string;
+    /**
+     * Identifier of the classification (browse node identifier).
+     * @type {string}
+     * @memberof ItemBrowseClassification
+     */
+    classificationId: string;
+}