/** * Selling Partner API for Listings Restrictions * The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings. For more information, see the [Listings Restrictions API Use Case Guide](doc:listings-restrictions-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-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 { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * A link to resources related to a listing restriction. * @export * @interface Link */ export interface Link { /** * The URI of the related resource. * @type {string} * @memberof Link */ resource: string; /** * The HTTP verb used to interact with the related resource. * @type {string} * @memberof Link */ verb: LinkVerbEnum | 'GET'; /** * The title of the related resource. * @type {string} * @memberof Link */ title?: string; /** * The media type of the related resource. * @type {string} * @memberof Link */ type?: string; } /** * @export * @enum {string} */ export declare enum LinkVerbEnum { Get = "GET" } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * A reason for the restriction, including path forward links that may allow Selling Partners to remove the restriction, if available. * @export * @interface Reason */ export interface Reason { /** * A message describing the reason for the restriction. * @type {string} * @memberof Reason */ message: string; /** * A code indicating why the listing is restricted. * @type {string} * @memberof Reason */ reasonCode?: ReasonReasonCodeEnum | 'APPROVAL_REQUIRED' | 'ASIN_NOT_FOUND' | 'NOT_ELIGIBLE'; /** * A list of path forward links that may allow Selling Partners to remove the restriction. * @type {Array} * @memberof Reason */ links?: Array; } /** * @export * @enum {string} */ export declare enum ReasonReasonCodeEnum { ApprovalRequired = "APPROVAL_REQUIRED", AsinNotFound = "ASIN_NOT_FOUND", NotEligible = "NOT_ELIGIBLE" } /** * A listing restriction, optionally qualified by a condition, with a list of reasons for the restriction. * @export * @interface Restriction */ export interface Restriction { /** * A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced. * @type {string} * @memberof Restriction */ marketplaceId: string; /** * The condition that applies to the restriction. * @type {string} * @memberof Restriction */ conditionType?: RestrictionConditionTypeEnum | 'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'; /** * A list of reasons for the restriction. * @type {Array} * @memberof Restriction */ reasons?: Array; } /** * @export * @enum {string} */ export declare enum RestrictionConditionTypeEnum { NewNew = "new_new", NewOpenBox = "new_open_box", NewOem = "new_oem", RefurbishedRefurbished = "refurbished_refurbished", UsedLikeNew = "used_like_new", UsedVeryGood = "used_very_good", UsedGood = "used_good", UsedAcceptable = "used_acceptable", CollectibleLikeNew = "collectible_like_new", CollectibleVeryGood = "collectible_very_good", CollectibleGood = "collectible_good", CollectibleAcceptable = "collectible_acceptable", ClubClub = "club_club" } /** * A list of restrictions for the specified Amazon catalog item. * @export * @interface RestrictionList */ export interface RestrictionList { /** * * @type {Array} * @memberof RestrictionList */ restrictions: Array; } /** * ListingsApi - axios parameter creator * @export */ export declare const ListingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns listing restrictions for an item in the Amazon Catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {string} sellerId A selling partner identifier, such as a merchant account. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'} [conditionType] The condition used to filter restrictions. * @param {string} [reasonLocale] A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingsRestrictions: (asin: string, sellerId: string, marketplaceIds: Array, conditionType?: "new_new" | "new_open_box" | "new_oem" | "refurbished_refurbished" | "used_like_new" | "used_very_good" | "used_good" | "used_acceptable" | "collectible_like_new" | "collectible_very_good" | "collectible_good" | "collectible_acceptable" | "club_club", reasonLocale?: string, options?: any) => Promise; }; /** * ListingsApi - functional programming interface * @export */ export declare const ListingsApiFp: (configuration?: Configuration) => { /** * Returns listing restrictions for an item in the Amazon Catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {string} sellerId A selling partner identifier, such as a merchant account. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'} [conditionType] The condition used to filter restrictions. * @param {string} [reasonLocale] A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingsRestrictions(asin: string, sellerId: string, marketplaceIds: Array, conditionType?: "new_new" | "new_open_box" | "new_oem" | "refurbished_refurbished" | "used_like_new" | "used_very_good" | "used_good" | "used_acceptable" | "collectible_like_new" | "collectible_very_good" | "collectible_good" | "collectible_acceptable" | "club_club", reasonLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ListingsApi - factory interface * @export */ export declare const ListingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns listing restrictions for an item in the Amazon Catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {string} sellerId A selling partner identifier, such as a merchant account. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'} [conditionType] The condition used to filter restrictions. * @param {string} [reasonLocale] A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingsRestrictions(asin: string, sellerId: string, marketplaceIds: Array, conditionType?: "new_new" | "new_open_box" | "new_oem" | "refurbished_refurbished" | "used_like_new" | "used_very_good" | "used_good" | "used_acceptable" | "collectible_like_new" | "collectible_very_good" | "collectible_good" | "collectible_acceptable" | "club_club", reasonLocale?: string, options?: any): AxiosPromise; }; /** * Request parameters for getListingsRestrictions operation in ListingsApi. * @export * @interface ListingsApiGetListingsRestrictionsRequest */ export interface ListingsApiGetListingsRestrictionsRequest { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof ListingsApiGetListingsRestrictions */ readonly asin: string; /** * A selling partner identifier, such as a merchant account. * @type {string} * @memberof ListingsApiGetListingsRestrictions */ readonly sellerId: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof ListingsApiGetListingsRestrictions */ readonly marketplaceIds: Array; /** * The condition used to filter restrictions. * @type {'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'} * @memberof ListingsApiGetListingsRestrictions */ readonly conditionType?: 'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'; /** * A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. * @type {string} * @memberof ListingsApiGetListingsRestrictions */ readonly reasonLocale?: string; } /** * ListingsApi - object-oriented interface * @export * @class ListingsApi * @extends {BaseAPI} */ export declare class ListingsApi extends BaseAPI { /** * Returns listing restrictions for an item in the Amazon Catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {ListingsApiGetListingsRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListingsApi */ getListingsRestrictions(requestParameters: ListingsApiGetListingsRestrictionsRequest, options?: any): Promise>; }