import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common'; import * as axios from 'axios'; import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios'; /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-01 * * * 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 | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); 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 | ((name: string) => string) | ((name: string) => Promise); /** * 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 | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * 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 Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-01 * * * 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 Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-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. */ interface ErrorList { /** * A list of error responses. */ 'errors': Array; } /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-01 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * 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; } /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-01 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * An Amazon product type with a definition available. */ interface ProductType { /** * The name of the Amazon product type. */ 'name': string; /** * Human-readable and localized description of the Amazon product type. */ 'displayName': string; /** * The Amazon marketplace identifiers for which the product type definition is available. */ 'marketplaceIds': Array; } /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-01 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The version details for an Amazon product type. */ interface ProductTypeVersion { /** * Version identifier. */ 'version': string; /** * When true, the version indicated by the version identifier is the latest available for the Amazon product type. */ 'latest': boolean; /** * When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type. */ 'releaseCandidate'?: boolean; } /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-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 property group represents a logical grouping of schema properties that can be used for display or informational purposes. */ interface PropertyGroup { /** * The display label of the property group. */ 'title'?: string; /** * The description of the property group. */ 'description'?: string; /** * The names of the schema properties for the property group. */ 'propertyNames'?: Array; } /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-01 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Link to retrieve the schema. */ interface SchemaLinkLink { /** * URI resource for the link. */ 'resource': string; /** * HTTP method for the link operation. */ 'verb': SchemaLinkLinkVerbEnum; } declare const SchemaLinkLinkVerbEnum: { readonly Get: "GET"; }; type SchemaLinkLinkVerbEnum = typeof SchemaLinkLinkVerbEnum[keyof typeof SchemaLinkLinkVerbEnum]; /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-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 link to metadata schema. */ interface SchemaLink { 'link': SchemaLinkLink; /** * Checksum hash of the schema (Base64 MD5). Use this to verify schema contents, identify changes between schema versions, and for caching. */ 'checksum': string; } /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-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 product type definition represents the attributes and data requirements for a product type in the Amazon catalog. Product type definitions are used interchangeably between the Selling Partner API for Listings Items, Selling Partner API for Catalog Items, and JSON-based listings feeds in the Selling Partner API for Feeds. */ interface ProductTypeDefinition { 'metaSchema'?: SchemaLink; 'schema': SchemaLink; /** * Name of the requirements set represented in this product type definition. */ 'requirements': ProductTypeDefinitionRequirementsEnum; /** * Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates). */ 'requirementsEnforced': ProductTypeDefinitionRequirementsEnforcedEnum; /** * Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes. */ 'propertyGroups': { [key: string]: PropertyGroup; }; /** * Locale of the display elements contained in the product type definition. */ 'locale': string; /** * Amazon marketplace identifiers for which the product type definition is applicable. */ 'marketplaceIds': Array; /** * The name of the Amazon product type that this product type definition applies to. */ 'productType': string; /** * Human-readable and localized description of the Amazon product type. */ 'displayName': string; 'productTypeVersion': ProductTypeVersion; } declare const ProductTypeDefinitionRequirementsEnum: { readonly Listing: "LISTING"; readonly ListingProductOnly: "LISTING_PRODUCT_ONLY"; readonly ListingOfferOnly: "LISTING_OFFER_ONLY"; }; type ProductTypeDefinitionRequirementsEnum = typeof ProductTypeDefinitionRequirementsEnum[keyof typeof ProductTypeDefinitionRequirementsEnum]; declare const ProductTypeDefinitionRequirementsEnforcedEnum: { readonly Enforced: "ENFORCED"; readonly NotEnforced: "NOT_ENFORCED"; }; type ProductTypeDefinitionRequirementsEnforcedEnum = typeof ProductTypeDefinitionRequirementsEnforcedEnum[keyof typeof ProductTypeDefinitionRequirementsEnforcedEnum]; /** * Selling Partner API for Product Type Definitions * The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the [Product Type Definitions API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). * * The version of the OpenAPI document: 2020-09-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 Amazon product types with definitions available. */ interface ProductTypeList { /** * A list of product types. */ 'productTypes': Array; /** * Amazon product type version identifier. */ 'productTypeVersion': string; } /** * ProductTypeDefinitionsApi - axios parameter creator */ declare const ProductTypeDefinitionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} productType The Amazon product type name. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time. * @param {string} [sellerId] A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner. * @param {string} [productTypeVersion] The version of the Amazon product type to retrieve. Defaults to \"LATEST\". Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided. * @param {GetDefinitionsProductTypeRequirementsEnum} [requirements] The name of the requirements set to retrieve requirements for. * @param {GetDefinitionsProductTypeRequirementsEnforcedEnum} [requirementsEnforced] Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates). * @param {GetDefinitionsProductTypeLocaleEnum} [locale] Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request. * @param {GetDefinitionsProductTypeParentageLevelEnum} [parentageLevel] The parentage level of the listing to retrieve a schema for. When provided, the schema is simplified by resolving all conditional logic related to the specified parentage level, resulting in a smaller schema with fewer conditions. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinitionsProductType: (productType: string, marketplaceIds: Array, sellerId?: string, productTypeVersion?: string, requirements?: GetDefinitionsProductTypeRequirementsEnum, requirementsEnforced?: GetDefinitionsProductTypeRequirementsEnforcedEnum, locale?: GetDefinitionsProductTypeLocaleEnum, parentageLevel?: GetDefinitionsProductTypeParentageLevelEnum, options?: RawAxiosRequestConfig) => Promise; /** * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with `itemName`. * @param {string} [itemName] Title of ASIN to get product type recommendation. **Note:** Cannot be used with `keywords`. * @param {string} [locale] Locale for display names in response. Defaults to primary locale of the marketplace. * @param {string} [searchLocale] Language used for `keywords` or `itemName` parameters. Defaults to primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchDefinitionsProductTypes: (marketplaceIds: Array, keywords?: Array, itemName?: string, locale?: string, searchLocale?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ProductTypeDefinitionsApi - functional programming interface */ declare const ProductTypeDefinitionsApiFp: (configuration?: Configuration) => { /** * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} productType The Amazon product type name. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time. * @param {string} [sellerId] A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner. * @param {string} [productTypeVersion] The version of the Amazon product type to retrieve. Defaults to \"LATEST\". Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided. * @param {GetDefinitionsProductTypeRequirementsEnum} [requirements] The name of the requirements set to retrieve requirements for. * @param {GetDefinitionsProductTypeRequirementsEnforcedEnum} [requirementsEnforced] Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates). * @param {GetDefinitionsProductTypeLocaleEnum} [locale] Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request. * @param {GetDefinitionsProductTypeParentageLevelEnum} [parentageLevel] The parentage level of the listing to retrieve a schema for. When provided, the schema is simplified by resolving all conditional logic related to the specified parentage level, resulting in a smaller schema with fewer conditions. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinitionsProductType(productType: string, marketplaceIds: Array, sellerId?: string, productTypeVersion?: string, requirements?: GetDefinitionsProductTypeRequirementsEnum, requirementsEnforced?: GetDefinitionsProductTypeRequirementsEnforcedEnum, locale?: GetDefinitionsProductTypeLocaleEnum, parentageLevel?: GetDefinitionsProductTypeParentageLevelEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [keywords] A comma-delimited list of keywords to search product types. **Note:** Cannot be used with `itemName`. * @param {string} [itemName] Title of ASIN to get product type recommendation. **Note:** Cannot be used with `keywords`. * @param {string} [locale] Locale for display names in response. Defaults to primary locale of the marketplace. * @param {string} [searchLocale] Language used for `keywords` or `itemName` parameters. Defaults to primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchDefinitionsProductTypes(marketplaceIds: Array, keywords?: Array, itemName?: string, locale?: string, searchLocale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProductTypeDefinitionsApi - factory interface */ declare const ProductTypeDefinitionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinitionsProductType(requestParameters: ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchDefinitionsProductTypes(requestParameters: ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getDefinitionsProductType operation in ProductTypeDefinitionsApi. */ interface ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest { /** * The Amazon product type name. */ readonly productType: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time. */ readonly marketplaceIds: Array; /** * A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner. */ readonly sellerId?: string; /** * The version of the Amazon product type to retrieve. Defaults to \"LATEST\". Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided. */ readonly productTypeVersion?: string; /** * The name of the requirements set to retrieve requirements for. */ readonly requirements?: GetDefinitionsProductTypeRequirementsEnum; /** * Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates). */ readonly requirementsEnforced?: GetDefinitionsProductTypeRequirementsEnforcedEnum; /** * Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request. */ readonly locale?: GetDefinitionsProductTypeLocaleEnum; /** * The parentage level of the listing to retrieve a schema for. When provided, the schema is simplified by resolving all conditional logic related to the specified parentage level, resulting in a smaller schema with fewer conditions. */ readonly parentageLevel?: GetDefinitionsProductTypeParentageLevelEnum; } /** * Request parameters for searchDefinitionsProductTypes operation in ProductTypeDefinitionsApi. */ interface ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest { /** * A comma-delimited list of Amazon marketplace identifiers for the request. */ readonly marketplaceIds: Array; /** * A comma-delimited list of keywords to search product types. **Note:** Cannot be used with `itemName`. */ readonly keywords?: Array; /** * Title of ASIN to get product type recommendation. **Note:** Cannot be used with `keywords`. */ readonly itemName?: string; /** * Locale for display names in response. Defaults to primary locale of the marketplace. */ readonly locale?: string; /** * Language used for `keywords` or `itemName` parameters. Defaults to primary locale of the marketplace. */ readonly searchLocale?: string; } /** * ProductTypeDefinitionsApi - object-oriented interface */ declare class ProductTypeDefinitionsApi extends BaseAPI { /** * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinitionsProductType(requestParameters: ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest, options?: RawAxiosRequestConfig): Promise>; /** * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchDefinitionsProductTypes(requestParameters: ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest, options?: RawAxiosRequestConfig): Promise>; } declare const GetDefinitionsProductTypeRequirementsEnum: { readonly Listing: "LISTING"; readonly ListingProductOnly: "LISTING_PRODUCT_ONLY"; readonly ListingOfferOnly: "LISTING_OFFER_ONLY"; }; type GetDefinitionsProductTypeRequirementsEnum = typeof GetDefinitionsProductTypeRequirementsEnum[keyof typeof GetDefinitionsProductTypeRequirementsEnum]; declare const GetDefinitionsProductTypeRequirementsEnforcedEnum: { readonly Enforced: "ENFORCED"; readonly NotEnforced: "NOT_ENFORCED"; }; type GetDefinitionsProductTypeRequirementsEnforcedEnum = typeof GetDefinitionsProductTypeRequirementsEnforcedEnum[keyof typeof GetDefinitionsProductTypeRequirementsEnforcedEnum]; declare const GetDefinitionsProductTypeLocaleEnum: { readonly Default: "DEFAULT"; readonly Ar: "ar"; readonly ArAe: "ar_AE"; readonly De: "de"; readonly DeDe: "de_DE"; readonly En: "en"; readonly EnAe: "en_AE"; readonly EnAu: "en_AU"; readonly EnCa: "en_CA"; readonly EnGb: "en_GB"; readonly EnIn: "en_IN"; readonly EnSg: "en_SG"; readonly EnUs: "en_US"; readonly Es: "es"; readonly EsEs: "es_ES"; readonly EsMx: "es_MX"; readonly EsUs: "es_US"; readonly Fr: "fr"; readonly FrCa: "fr_CA"; readonly FrFr: "fr_FR"; readonly It: "it"; readonly ItIt: "it_IT"; readonly Ja: "ja"; readonly JaJp: "ja_JP"; readonly Nl: "nl"; readonly NlNl: "nl_NL"; readonly Pl: "pl"; readonly PlPl: "pl_PL"; readonly Pt: "pt"; readonly PtBr: "pt_BR"; readonly PtPt: "pt_PT"; readonly Sv: "sv"; readonly SvSe: "sv_SE"; readonly Tr: "tr"; readonly TrTr: "tr_TR"; readonly Zh: "zh"; readonly ZhCn: "zh_CN"; readonly ZhTw: "zh_TW"; }; type GetDefinitionsProductTypeLocaleEnum = typeof GetDefinitionsProductTypeLocaleEnum[keyof typeof GetDefinitionsProductTypeLocaleEnum]; declare const GetDefinitionsProductTypeParentageLevelEnum: { readonly None: "NONE"; readonly Child: "CHILD"; readonly Parent: "PARENT"; }; type GetDefinitionsProductTypeParentageLevelEnum = typeof GetDefinitionsProductTypeParentageLevelEnum[keyof typeof GetDefinitionsProductTypeParentageLevelEnum]; declare const clientRateLimits: RateLimit[]; declare class ProductTypeDefinitionsApiClient extends ProductTypeDefinitionsApi { constructor(configuration: ClientConfiguration); } export { type ErrorList, GetDefinitionsProductTypeLocaleEnum, GetDefinitionsProductTypeParentageLevelEnum, GetDefinitionsProductTypeRequirementsEnforcedEnum, GetDefinitionsProductTypeRequirementsEnum, type ModelError, type ProductType, type ProductTypeDefinition, ProductTypeDefinitionRequirementsEnforcedEnum, ProductTypeDefinitionRequirementsEnum, ProductTypeDefinitionsApi, ProductTypeDefinitionsApiAxiosParamCreator, ProductTypeDefinitionsApiClient, ProductTypeDefinitionsApiFactory, ProductTypeDefinitionsApiFp, type ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest, type ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest, type ProductTypeList, type ProductTypeVersion, type PropertyGroup, type SchemaLink, type SchemaLinkLink, SchemaLinkLinkVerbEnum, clientRateLimits };