@sp-api-sdk/feeds-api-2021-06-30

import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common'; import * as axios from 'axios'; import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios'; /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ interface AWSv4Configuration { options?: { region?: string; service?: string; }; credentials?: { accessKeyId?: string; secretAccessKey?: string; sessionToken?: string; }; } 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>); awsv4?: AWSv4Configuration; basePath?: string; serverIndex?: number; baseOptions?: any; formDataCtor?: new () => any; } declare class Configuration { /** * parameter for apiKey security * @param name security name */ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); /** * parameter for basic security */ username?: string; /** * parameter for basic security */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope */ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>); /** * parameter for aws4 signature security * @param {Object} AWS4Signature - AWS4 Signature security * @param {string} options.region - aws region * @param {string} options.service - name of the service. * @param {string} credentials.accessKeyId - aws access key id * @param {string} credentials.secretAccessKey - aws access key * @param {string} credentials.sessionToken - aws session token * @memberof Configuration */ awsv4?: AWSv4Configuration; /** * override base path */ basePath?: string; /** * override server index */ serverIndex?: number; /** * base options for axios calls */ 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; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ interface RequestArgs { url: string; options: RawAxiosRequestConfig; } declare class BaseAPI { protected basePath: string; protected axios: AxiosInstance; protected configuration: Configuration | undefined; constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Information required to upload a feed document\'s contents. */ interface CreateFeedDocumentResponse { /** * The identifier of the feed document. */ 'feedDocumentId': string; /** * The presigned URL for uploading the feed contents. This URL expires after 5 minutes. */ 'url': string; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Specifies the content type for the createFeedDocument operation. */ interface CreateFeedDocumentSpecification { /** * The content type of the feed. */ 'contentType': string; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Response schema. */ interface CreateFeedResponse { /** * The identifier for the feed. This identifier is unique only in combination with a seller ID. */ 'feedId': string; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Information required to create the feed. */ interface CreateFeedSpecification { /** * The feed type. */ 'feedType': string; /** * A list of identifiers for marketplaces that you want the feed to be applied to. */ 'marketplaceIds': Array<string>; /** * The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation. */ 'inputFeedDocumentId': string; /** * Additional options to control the feed. These vary by feed type. */ 'feedOptions'?: { [key: string]: string; }; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * 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. */ interface ErrorList { /** * An error response returned when the request is unsuccessful. */ 'errors': Array<Error>; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Detailed information about the feed. */ interface Feed { /** * The identifier for the feed. This identifier is unique only in combination with a seller ID. */ 'feedId': string; /** * The feed type. */ 'feedType': string; /** * A list of identifiers for the marketplaces that the feed is applied to. */ 'marketplaceIds'?: Array<string>; /** * The date and time when the feed was created, in ISO 8601 date time format. */ 'createdTime': string; /** * The processing status of the feed. */ 'processingStatus': FeedProcessingStatusEnum; /** * The date and time when feed processing started, in ISO 8601 date time format. */ 'processingStartTime'?: string; /** * The date and time when feed processing completed, in ISO 8601 date time format. */ 'processingEndTime'?: string; /** * The identifier for the feed document. This identifier is unique only in combination with a seller ID. */ 'resultFeedDocumentId'?: string; } declare const FeedProcessingStatusEnum: { readonly Cancelled: "CANCELLED"; readonly Done: "DONE"; readonly Fatal: "FATAL"; readonly InProgress: "IN_PROGRESS"; readonly InQueue: "IN_QUEUE"; }; type FeedProcessingStatusEnum = typeof FeedProcessingStatusEnum[keyof typeof FeedProcessingStatusEnum]; /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Information required for the feed document. */ interface FeedDocument { /** * The identifier for the feed document. This identifier is unique only in combination with a seller ID. */ 'feedDocumentId': string; /** * A presigned URL for the feed document. If `compressionAlgorithm` is not returned, you can download the feed directly from this URL. This URL expires after 5 minutes. */ 'url': string; /** * If the feed document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the feed when you download. Otherwise, you can download the feed directly. Refer to [Step 7. Download the feed processing report](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-use-case-guide#step-7-download-the-feed-processing-report) in the use case guide, where sample code is provided. */ 'compressionAlgorithm'?: FeedDocumentCompressionAlgorithmEnum; } declare const FeedDocumentCompressionAlgorithmEnum: { readonly Gzip: "GZIP"; }; type FeedDocumentCompressionAlgorithmEnum = typeof FeedDocumentCompressionAlgorithmEnum[keyof typeof FeedDocumentCompressionAlgorithmEnum]; /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Response schema. */ interface GetFeedsResponse { /** * A list of feeds. */ 'feeds': Array<Feed>; /** * Returned when the number of results exceeds pageSize. To get the next page of results, call the getFeeds operation with this token as the only parameter. */ 'nextToken'?: string; } /** * Selling Partner API for Feeds * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * An error response returned when the request is unsuccessful. */ interface ModelError { /** * An error code that identifies the type of error that occurred. */ 'code': string; /** * A message that describes the error condition. */ 'message': string; /** * Additional details that can help the caller understand or fix the issue. */ 'details'?: string; } /** * FeedsApi - axios parameter creator */ declare const FeedsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelFeed: (feedId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeed: (body: CreateFeedSpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeedDocument: (body: CreateFeedDocumentSpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeed: (feedId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} feedDocumentId The identifier of the feed document. * @param {boolean} [enableContentEncodingUrlHeader] When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeedDocument: (feedDocumentId: string, enableContentEncodingUrlHeader?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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>} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. * @param {Array<string>} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of feeds to return in a single call. * @param {Array<GetFeedsProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter feeds. * @param {string} [createdSince] The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. * @param {string} [createdUntil] The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. * @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeeds: (feedTypes?: Array<string>, marketplaceIds?: Array<string>, pageSize?: number, processingStatuses?: Array<GetFeedsProcessingStatusesEnum>, createdSince?: string, createdUntil?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * FeedsApi - functional programming interface */ declare const FeedsApiFp: (configuration?: Configuration) => { /** * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelFeed(feedId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeed(body: CreateFeedSpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFeedResponse>>; /** * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeedDocument(body: CreateFeedDocumentSpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFeedDocumentResponse>>; /** * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeed(feedId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Feed>>; /** * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} feedDocumentId The identifier of the feed document. * @param {boolean} [enableContentEncodingUrlHeader] When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeedDocument(feedDocumentId: string, enableContentEncodingUrlHeader?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedDocument>>; /** * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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>} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. * @param {Array<string>} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of feeds to return in a single call. * @param {Array<GetFeedsProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter feeds. * @param {string} [createdSince] The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. * @param {string} [createdUntil] The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. * @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeeds(feedTypes?: Array<string>, marketplaceIds?: Array<string>, pageSize?: number, processingStatuses?: Array<GetFeedsProcessingStatusesEnum>, createdSince?: string, createdUntil?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeedsResponse>>; }; /** * FeedsApi - factory interface */ declare const FeedsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiCancelFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelFeed(requestParameters: FeedsApiCancelFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; /** * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {FeedsApiCreateFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeed(requestParameters: FeedsApiCreateFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFeedResponse>; /** * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeedDocument(requestParameters: FeedsApiCreateFeedDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFeedDocumentResponse>; /** * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiGetFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeed(requestParameters: FeedsApiGetFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise<Feed>; /** * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeedDocument(requestParameters: FeedsApiGetFeedDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<FeedDocument>; /** * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiGetFeedsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeeds(requestParameters?: FeedsApiGetFeedsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeedsResponse>; }; /** * Request parameters for cancelFeed operation in FeedsApi. */ interface FeedsApiCancelFeedRequest { /** * The identifier for the feed. This identifier is unique only in combination with a seller ID. */ readonly feedId: string; } /** * Request parameters for createFeed operation in FeedsApi. */ interface FeedsApiCreateFeedRequest { /** * Information required to create the feed. */ readonly body: CreateFeedSpecification; } /** * Request parameters for createFeedDocument operation in FeedsApi. */ interface FeedsApiCreateFeedDocumentRequest { /** * Specifies the content type for the createFeedDocument operation. */ readonly body: CreateFeedDocumentSpecification; } /** * Request parameters for getFeed operation in FeedsApi. */ interface FeedsApiGetFeedRequest { /** * The identifier for the feed. This identifier is unique only in combination with a seller ID. */ readonly feedId: string; } /** * Request parameters for getFeedDocument operation in FeedsApi. */ interface FeedsApiGetFeedDocumentRequest { /** * The identifier of the feed document. */ readonly feedDocumentId: string; /** * When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients. */ readonly enableContentEncodingUrlHeader?: boolean; } /** * Request parameters for getFeeds operation in FeedsApi. */ interface FeedsApiGetFeedsRequest { /** * A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. */ readonly feedTypes?: Array<string>; /** * A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. */ readonly marketplaceIds?: Array<string>; /** * The maximum number of feeds to return in a single call. */ readonly pageSize?: number; /** * A list of processing statuses used to filter feeds. */ readonly processingStatuses?: Array<GetFeedsProcessingStatusesEnum>; /** * The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. */ readonly createdSince?: string; /** * The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. */ readonly createdUntil?: string; /** * A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. */ readonly nextToken?: string; } /** * FeedsApi - object-oriented interface */ declare class FeedsApi extends BaseAPI { /** * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiCancelFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelFeed(requestParameters: FeedsApiCancelFeedRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>; /** * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {FeedsApiCreateFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeed(requestParameters: FeedsApiCreateFeedRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateFeedResponse, any, {}>>; /** * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFeedDocument(requestParameters: FeedsApiCreateFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateFeedDocumentResponse, any, {}>>; /** * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiGetFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeed(requestParameters: FeedsApiGetFeedRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Feed, any, {}>>; /** * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeedDocument(requestParameters: FeedsApiGetFeedDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<FeedDocument, any, {}>>; /** * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {FeedsApiGetFeedsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeeds(requestParameters?: FeedsApiGetFeedsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetFeedsResponse, any, {}>>; } declare const GetFeedsProcessingStatusesEnum: { readonly Cancelled: "CANCELLED"; readonly Done: "DONE"; readonly Fatal: "FATAL"; readonly InProgress: "IN_PROGRESS"; readonly InQueue: "IN_QUEUE"; }; type GetFeedsProcessingStatusesEnum = typeof GetFeedsProcessingStatusesEnum[keyof typeof GetFeedsProcessingStatusesEnum]; declare const clientRateLimits: RateLimit[]; declare class FeedsApiClient extends FeedsApi { constructor(configuration: ClientConfiguration); } export { type CreateFeedDocumentResponse, type CreateFeedDocumentSpecification, type CreateFeedResponse, type CreateFeedSpecification, type ErrorList, type Feed, type FeedDocument, FeedDocumentCompressionAlgorithmEnum, FeedProcessingStatusEnum, FeedsApi, FeedsApiAxiosParamCreator, type FeedsApiCancelFeedRequest, FeedsApiClient, type FeedsApiCreateFeedDocumentRequest, type FeedsApiCreateFeedRequest, FeedsApiFactory, FeedsApiFp, type FeedsApiGetFeedDocumentRequest, type FeedsApiGetFeedRequest, type FeedsApiGetFeedsRequest, GetFeedsProcessingStatusesEnum, type GetFeedsResponse, type ModelError, clientRateLimits };