@sp-api-sdk/product-pricing-api-2022-05-01 3.3.0 → 4.1.0

package/dist/index.d.ts

@@ -0,0 +1,964 @@
+import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
+import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
+//#region src/api-model/configuration.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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<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;
+}
+//#endregion
+//#region src/api-model/base.d.ts
+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);
+}
+//#endregion
+//#region src/api-model/models/http-method.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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 HTTP method associated with an individual request within a batch.
+ */
+declare const HttpMethod: {
+  readonly Get: "GET";
+  readonly Put: "PUT";
+  readonly Patch: "PATCH";
+  readonly Delete: "DELETE";
+  readonly Post: "POST";
+};
+type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
+//#endregion
+//#region src/api-model/models/batch-request.d.ts
+/**
+ * The common properties for individual requests within a batch.
+ */
+interface BatchRequest {
+  /**
+   * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`.
+   */
+  'uri': string;
+  'method': HttpMethod;
+  /**
+   * Additional HTTP body information that is associated with an individual request within a batch.
+   */
+  'body'?: {
+    [key: string]: object;
+  };
+  /**
+   * A mapping of additional HTTP headers to send or receive for an individual request within a batch.
+   */
+  'headers'?: {
+    [key: string]: string;
+  };
+}
+//#endregion
+//#region src/api-model/models/http-status-line.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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 HTTP status line associated with the response for an individual request within a batch. For more information, refer to [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html).
+ */
+interface HttpStatusLine {
+  /**
+   * The HTTP response status code.
+   */
+  'statusCode'?: number;
+  /**
+   * The HTTP response reason phrase.
+   */
+  'reasonPhrase'?: string;
+}
+//#endregion
+//#region src/api-model/models/batch-response.d.ts
+/**
+ * The common properties for responses to individual requests within a batch.
+ */
+interface BatchResponse {
+  /**
+   * A mapping of additional HTTP headers to send or receive for an individual request within a batch.
+   */
+  'headers': {
+    [key: string]: string;
+  };
+  'status': HttpStatusLine;
+}
+//#endregion
+//#region src/api-model/models/competitive-summary-included-data.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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 supported data types in the `getCompetitiveSummary` API.
+ */
+declare const CompetitiveSummaryIncludedData: {
+  readonly FeaturedBuyingOptions: "featuredBuyingOptions";
+  readonly ReferencePrices: "referencePrices";
+  readonly LowestPricedOffers: "lowestPricedOffers";
+  readonly SimilarItems: "similarItems";
+};
+type CompetitiveSummaryIncludedData = typeof CompetitiveSummaryIncludedData[keyof typeof CompetitiveSummaryIncludedData];
+//#endregion
+//#region src/api-model/models/condition.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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 condition of the item.
+ */
+declare const Condition: {
+  readonly New: "New";
+  readonly Used: "Used";
+  readonly Collectible: "Collectible";
+  readonly Refurbished: "Refurbished";
+  readonly Club: "Club";
+};
+type Condition = typeof Condition[keyof typeof Condition];
+//#endregion
+//#region src/api-model/models/lowest-priced-offers-input.d.ts
+/**
+ * The input required for building `LowestPricedOffers` data in the response.
+ */
+interface LowestPricedOffersInput {
+  'itemCondition': Condition;
+  /**
+   * The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.
+   */
+  'offerType': LowestPricedOffersInputOfferTypeEnum;
+}
+declare const LowestPricedOffersInputOfferTypeEnum: {
+  readonly Consumer: "Consumer";
+};
+type LowestPricedOffersInputOfferTypeEnum = typeof LowestPricedOffersInputOfferTypeEnum[keyof typeof LowestPricedOffersInputOfferTypeEnum];
+//#endregion
+//#region src/api-model/models/competitive-summary-request.d.ts
+/**
+ * An individual `competitiveSummary` request for an ASIN and `marketplaceId`.
+ */
+interface CompetitiveSummaryRequest {
+  /**
+   * The ASIN of the item.
+   */
+  'asin': string;
+  /**
+   * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+   */
+  'marketplaceId': string;
+  /**
+   * The list of requested competitive pricing data for the product.
+   */
+  'includedData': Array<CompetitiveSummaryIncludedData>;
+  /**
+   * The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`
+   */
+  'lowestPricedOffersInputs'?: Array<LowestPricedOffersInput>;
+  'method': HttpMethod;
+  /**
+   * The URI associated with the individual APIs that are called as part of the batch request.
+   */
+  'uri': string;
+}
+//#endregion
+//#region src/api-model/models/competitive-summary-batch-request.d.ts
+/**
+ * The `competitiveSummary` batch request data.
+ */
+interface CompetitiveSummaryBatchRequest {
+  /**
+   * A batched list of `competitiveSummary` requests.
+   */
+  'requests': Array<CompetitiveSummaryRequest>;
+}
+//#endregion
+//#region src/api-model/models/fulfillment-type.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Indicates whether the item is fulfilled by Amazon or by the seller (merchant).
+ */
+declare const FulfillmentType: {
+  readonly Afn: "AFN";
+  readonly Mfn: "MFN";
+};
+type FulfillmentType = typeof FulfillmentType[keyof typeof FulfillmentType];
+//#endregion
+//#region src/api-model/models/money-type.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Currency type and monetary value schema to demonstrate pricing information.
+ */
+interface MoneyType {
+  /**
+   * The currency code in ISO 4217 format.
+   */
+  'currencyCode'?: string;
+  /**
+   * The monetary value.
+   */
+  'amount'?: number;
+}
+//#endregion
+//#region src/api-model/models/points.d.ts
+/**
+ * The number of Amazon Points that are offered with the purchase of an item and the monetary value of these points.
+ */
+interface Points {
+  /**
+   * The number of Amazon Points.
+   */
+  'pointsNumber'?: number;
+  'pointsMonetaryValue'?: MoneyType;
+}
+//#endregion
+//#region src/api-model/models/prime-details.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Amazon Prime details.
+ */
+interface PrimeDetails {
+  /**
+   * Indicates whether the offer is an Amazon Prime offer.
+   */
+  'eligibility': PrimeDetailsEligibilityEnum;
+}
+declare const PrimeDetailsEligibilityEnum: {
+  readonly National: "NATIONAL";
+  readonly Regional: "REGIONAL";
+  readonly None: "NONE";
+};
+type PrimeDetailsEligibilityEnum = typeof PrimeDetailsEligibilityEnum[keyof typeof PrimeDetailsEligibilityEnum];
+//#endregion
+//#region src/api-model/models/shipping-option.d.ts
+/**
+ * The shipping option available for the offer.
+ */
+interface ShippingOption {
+  /**
+   * The type of shipping option.
+   */
+  'shippingOptionType': ShippingOptionShippingOptionTypeEnum;
+  'price': MoneyType;
+}
+declare const ShippingOptionShippingOptionTypeEnum: {
+  readonly Default: "DEFAULT";
+};
+type ShippingOptionShippingOptionTypeEnum = typeof ShippingOptionShippingOptionTypeEnum[keyof typeof ShippingOptionShippingOptionTypeEnum];
+//#endregion
+//#region src/api-model/models/offer.d.ts
+/**
+ * The offer data of a product.
+ */
+interface Offer {
+  /**
+   * The seller identifier for the offer.
+   */
+  'sellerId': string;
+  'condition': Condition;
+  /**
+   * The item subcondition of the offer.
+   */
+  'subCondition'?: OfferSubConditionEnum;
+  'fulfillmentType': FulfillmentType;
+  'listingPrice': MoneyType;
+  /**
+   * A list of shipping options associated with this offer
+   */
+  'shippingOptions'?: Array<ShippingOption>;
+  'points'?: Points;
+  'primeDetails'?: PrimeDetails;
+}
+declare const OfferSubConditionEnum: {
+  readonly New: "New";
+  readonly Mint: "Mint";
+  readonly VeryGood: "VeryGood";
+  readonly Good: "Good";
+  readonly Acceptable: "Acceptable";
+  readonly Poor: "Poor";
+  readonly Club: "Club";
+  readonly Oem: "OEM";
+  readonly Warranty: "Warranty";
+  readonly RefurbishedWarranty: "RefurbishedWarranty";
+  readonly Refurbished: "Refurbished";
+  readonly OpenBox: "OpenBox";
+  readonly Other: "Other";
+};
+type OfferSubConditionEnum = typeof OfferSubConditionEnum[keyof typeof OfferSubConditionEnum];
+//#endregion
+//#region src/api-model/models/postal-code.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Postal code value with country code
+ */
+interface PostalCode {
+  /**
+   * Country code value
+   */
+  'countryCode'?: string;
+  /**
+   * Postal code value
+   */
+  'value'?: string;
+}
+//#endregion
+//#region src/api-model/models/sample-location.d.ts
+/**
+ * Information about a location. It uses a postal code to identify the location.
+ */
+interface SampleLocation {
+  'postalCode'?: PostalCode;
+}
+//#endregion
+//#region src/api-model/models/segment-details.d.ts
+/**
+ * The details about the segment. The FeaturedOfferExpectedPrice API uses only the sampleLocation portion as input.
+ */
+interface SegmentDetails {
+  /**
+   * The glance view weighted percentage for this segment, which is the glance views for this segment as a percentage of total glance views across all segments for the ASIN. A higher percentage indicates that more Amazon customers receive this offer as the Featured Offer.
+   */
+  'glanceViewWeightPercentage'?: number;
+  'sampleLocation'?: SampleLocation;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-segment.d.ts
+/**
+ * Describes the segment in which the offer is featured.
+ */
+interface FeaturedOfferSegment {
+  /**
+   * The customer membership type that makes up this segment
+   */
+  'customerMembership': FeaturedOfferSegmentCustomerMembershipEnum;
+  'segmentDetails': SegmentDetails;
+}
+declare const FeaturedOfferSegmentCustomerMembershipEnum: {
+  readonly Prime: "PRIME";
+  readonly NonPrime: "NON_PRIME";
+  readonly Default: "DEFAULT";
+};
+type FeaturedOfferSegmentCustomerMembershipEnum = typeof FeaturedOfferSegmentCustomerMembershipEnum[keyof typeof FeaturedOfferSegmentCustomerMembershipEnum];
+//#endregion
+//#region src/api-model/models/segmented-featured-offer-all-of.d.ts
+/**
+ * The list of segment information in which the offer is featured.
+ */
+interface SegmentedFeaturedOfferAllOf {
+  /**
+   * The list of segment information in which the offer is featured.
+   */
+  'featuredOfferSegments': Array<FeaturedOfferSegment>;
+}
+//#endregion
+//#region src/api-model/models/segmented-featured-offer.d.ts
+/**
+ * @type SegmentedFeaturedOffer
+ * A product offer with segment information indicating where it\'s featured.
+ */
+type SegmentedFeaturedOffer = Offer & SegmentedFeaturedOfferAllOf;
+//#endregion
+//#region src/api-model/models/featured-buying-option.d.ts
+/**
+ * Describes a featured buying option, which includes a list of segmented featured offers for a particular item condition.
+ */
+interface FeaturedBuyingOption {
+  /**
+   * The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value.
+   */
+  'buyingOptionType': FeaturedBuyingOptionBuyingOptionTypeEnum;
+  /**
+   * A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option.
+   */
+  'segmentedFeaturedOffers': Array<SegmentedFeaturedOffer>;
+}
+declare const FeaturedBuyingOptionBuyingOptionTypeEnum: {
+  readonly New: "New";
+};
+type FeaturedBuyingOptionBuyingOptionTypeEnum = typeof FeaturedBuyingOptionBuyingOptionTypeEnum[keyof typeof FeaturedBuyingOptionBuyingOptionTypeEnum];
+//#endregion
+//#region src/api-model/models/lowest-priced-offer.d.ts
+/**
+ * Describes the lowest priced offers for the specified item condition and offer type.
+ */
+interface LowestPricedOffer {
+  'lowestPricedOffersInput': LowestPricedOffersInput;
+  /**
+   * A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`.
+   */
+  'offers': Array<Offer>;
+}
+//#endregion
+//#region src/api-model/models/reference-price.d.ts
+/**
+ * The reference price for the specified ASIN `marketplaceId` combination.
+ */
+interface ReferencePrice {
+  /**
+   * Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, see the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+   */
+  'name': string;
+  'price': MoneyType;
+}
+//#endregion
+//#region src/api-model/models/item.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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 similar item for the specified ASIN `marketplaceId` combination.
+ */
+interface Item {
+  /**
+   * The ASIN of the item.
+   */
+  'asin': string;
+}
+//#endregion
+//#region src/api-model/models/similar-items.d.ts
+/**
+ * The summary of similar items for the specified ASIN `marketplaceId` combination.
+ */
+interface SimilarItems {
+  /**
+   * A list of similar items for the specified ASIN `marketplaceId` combination.
+   */
+  'items'?: Array<Item>;
+}
+//#endregion
+//#region src/api-model/models/competitive-summary-response-body.d.ts
+/**
+ * The `competitiveSummaryResponse` body for a requested ASIN and `marketplaceId`.
+ */
+interface CompetitiveSummaryResponseBody {
+  /**
+   * The ASIN of the item.
+   */
+  'asin': string;
+  /**
+   * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+   */
+  'marketplaceId': string;
+  /**
+   * A list of featured buying options for the specified ASIN `marketplaceId` combination.
+   */
+  'featuredBuyingOptions'?: Array<FeaturedBuyingOption>;
+  /**
+   * A list of lowest priced offers for the specified ASIN `marketplaceId` combination.
+   */
+  'lowestPricedOffers'?: Array<LowestPricedOffer>;
+  /**
+   * A list of reference prices for the specified ASIN `marketplaceId` combination.
+   */
+  'referencePrices'?: Array<ReferencePrice>;
+  /**
+   * A list of similar items for the specified ASIN `marketplaceId` combination.
+   */
+  'similarItems'?: Array<SimilarItems>;
+  /**
+   * A list of error responses that are returned when a request is unsuccessful.
+   */
+  'errors'?: Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/competitive-summary-response.d.ts
+/**
+ * The response for the individual `competitiveSummary` request in the batch operation.
+ */
+interface CompetitiveSummaryResponse {
+  'status': HttpStatusLine;
+  'body': CompetitiveSummaryResponseBody;
+}
+//#endregion
+//#region src/api-model/models/competitive-summary-batch-response.d.ts
+/**
+ * The response schema for the `competitiveSummaryBatch` operation.
+ */
+interface CompetitiveSummaryBatchResponse {
+  /**
+   * The response list for the `competitiveSummaryBatch` operation.
+   */
+  'responses': Array<CompetitiveSummaryResponse>;
+}
+//#endregion
+//#region src/api-model/models/errors.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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 Errors {
+  /**
+   * A list of error responses that are returned when a request is unsuccessful.
+   */
+  'errors': Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/offer-identifier.d.ts
+/**
+ * Identifies an offer from a particular seller for a specified ASIN.
+ */
+interface OfferIdentifier {
+  /**
+   * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+   */
+  'marketplaceId': string;
+  /**
+   * The seller identifier for the offer.
+   */
+  'sellerId'?: string;
+  /**
+   * The seller SKU of the item. This will only be present for the target offer, which belongs to the requesting seller.
+   */
+  'sku'?: string;
+  /**
+   * The ASIN of the item.
+   */
+  'asin': string;
+  'fulfillmentType'?: FulfillmentType;
+}
+//#endregion
+//#region src/api-model/models/price.d.ts
+/**
+ * The schema for item\'s price information, including listing price, shipping price, and Amazon Points.
+ */
+interface Price {
+  'listingPrice': MoneyType;
+  'shippingPrice'?: MoneyType;
+  'points'?: Points;
+}
+//#endregion
+//#region src/api-model/models/featured-offer.d.ts
+/**
+ * Schema for `currentFeaturedOffer` or `competingFeaturedOffer`.
+ */
+interface FeaturedOffer {
+  'offerIdentifier': OfferIdentifier;
+  'condition'?: Condition;
+  'price'?: Price;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price.d.ts
+/**
+ * The item price at or below which the target offer may be featured.
+ */
+interface FeaturedOfferExpectedPrice {
+  'listingPrice': MoneyType;
+  'points'?: Points;
+}
+//#endregion
+//#region src/api-model/models/segment.d.ts
+/**
+ * Input segment for featured offer expected price. The segment contains the location information for which featured offer expected price is requested.
+ */
+interface Segment {
+  'segmentDetails'?: SegmentDetails;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price-request-params.d.ts
+/**
+ * The parameters for an individual request.
+ */
+interface FeaturedOfferExpectedPriceRequestParams {
+  /**
+   * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+   */
+  'marketplaceId': string;
+  /**
+   * The seller SKU of the item.
+   */
+  'sku': string;
+  'segment'?: Segment;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price-request.d.ts
+/**
+ * @type FeaturedOfferExpectedPriceRequest
+ * An individual FOEP request for a particular SKU.
+ */
+type FeaturedOfferExpectedPriceRequest = BatchRequest & FeaturedOfferExpectedPriceRequestParams;
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price-result.d.ts
+/**
+ * The FOEP result data for the requested offer.
+ */
+interface FeaturedOfferExpectedPriceResult {
+  'featuredOfferExpectedPrice'?: FeaturedOfferExpectedPrice;
+  /**
+   * The status of the FOEP computation. Possible values include `VALID_FOEP`, `NO_COMPETING_OFFER`, `OFFER_NOT_ELIGIBLE`, `OFFER_NOT_FOUND`, and `ASIN_NOT_ELIGIBLE`. Additional values might be added in the future.
+   */
+  'resultStatus': string;
+  'competingFeaturedOffer'?: FeaturedOffer;
+  'currentFeaturedOffer'?: FeaturedOffer;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price-response-body.d.ts
+/**
+ * The FOEP response data for a requested SKU.
+ */
+interface FeaturedOfferExpectedPriceResponseBody {
+  'offerIdentifier'?: OfferIdentifier;
+  /**
+   * A list of FOEP results for the requested offer.
+   */
+  'featuredOfferExpectedPriceResults'?: Array<FeaturedOfferExpectedPriceResult>;
+  /**
+   * A list of error responses that are returned when a request is unsuccessful.
+   */
+  'errors'?: Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price-response-all-of.d.ts
+interface FeaturedOfferExpectedPriceResponseAllOf {
+  'request': FeaturedOfferExpectedPriceRequestParams;
+  'body'?: FeaturedOfferExpectedPriceResponseBody;
+}
+//#endregion
+//#region src/api-model/models/featured-offer-expected-price-response.d.ts
+/**
+ * @type FeaturedOfferExpectedPriceResponse
+ * Schema for an individual FOEP response.
+ */
+type FeaturedOfferExpectedPriceResponse = BatchResponse & FeaturedOfferExpectedPriceResponseAllOf;
+//#endregion
+//#region src/api-model/models/get-featured-offer-expected-price-batch-request.d.ts
+/**
+ * The request body for the `getFeaturedOfferExpectedPriceBatch` operation.
+ */
+interface GetFeaturedOfferExpectedPriceBatchRequest {
+  /**
+   * A batched list of FOEP requests.
+   */
+  'requests'?: Array<FeaturedOfferExpectedPriceRequest>;
+}
+//#endregion
+//#region src/api-model/models/get-featured-offer-expected-price-batch-response.d.ts
+/**
+ * The response schema for the `getFeaturedOfferExpectedPriceBatch` operation.
+ */
+interface GetFeaturedOfferExpectedPriceBatchResponse {
+  /**
+   * A batched list of FOEP responses.
+   */
+  'responses'?: Array<FeaturedOfferExpectedPriceResponse>;
+}
+//#endregion
+//#region src/api-model/models/model-error.d.ts
+/**
+ * Selling Partner API for Pricing
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.  For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ *
+ * The version of the OpenAPI document: 2022-05-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;
+}
+//#endregion
+//#region src/api-model/api/product-pricing-api.d.ts
+/**
+ * ProductPricingApi - axios parameter creator
+ */
+declare const ProductPricingApiAxiosParamCreator: (configuration?: Configuration) => {
+  /**
+   * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {CompetitiveSummaryBatchRequest} requests The batch of &#x60;getCompetitiveSummary&#x60; requests.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getCompetitiveSummary: (requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getFeaturedOfferExpectedPriceBatch: (getFeaturedOfferExpectedPriceBatchRequestBody: GetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductPricingApi - functional programming interface
+ */
+declare const ProductPricingApiFp: (configuration?: Configuration) => {
+  /**
+   * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {CompetitiveSummaryBatchRequest} requests The batch of &#x60;getCompetitiveSummary&#x60; requests.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getCompetitiveSummary(requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompetitiveSummaryBatchResponse>>;
+  /**
+   * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getFeaturedOfferExpectedPriceBatch(getFeaturedOfferExpectedPriceBatchRequestBody: GetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeaturedOfferExpectedPriceBatchResponse>>;
+};
+/**
+ * ProductPricingApi - factory interface
+ */
+declare const ProductPricingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+  /**
+   * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getCompetitiveSummary(requestParameters: ProductPricingApiGetCompetitiveSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CompetitiveSummaryBatchResponse>;
+  /**
+   * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getFeaturedOfferExpectedPriceBatch(requestParameters: ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeaturedOfferExpectedPriceBatchResponse>;
+};
+/**
+ * Request parameters for getCompetitiveSummary operation in ProductPricingApi.
+ */
+interface ProductPricingApiGetCompetitiveSummaryRequest {
+  /**
+   * The batch of &#x60;getCompetitiveSummary&#x60; requests.
+   */
+  readonly requests: CompetitiveSummaryBatchRequest;
+}
+/**
+ * Request parameters for getFeaturedOfferExpectedPriceBatch operation in ProductPricingApi.
+ */
+interface ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest {
+  /**
+   * The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
+   */
+  readonly getFeaturedOfferExpectedPriceBatchRequestBody: GetFeaturedOfferExpectedPriceBatchRequest;
+}
+/**
+ * ProductPricingApi - object-oriented interface
+ */
+declare class ProductPricingApi extends BaseAPI {
+  /**
+   * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getCompetitiveSummary(requestParameters: ProductPricingApiGetCompetitiveSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompetitiveSummaryBatchResponse, any, {}>>;
+  /**
+   * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
+   * @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getFeaturedOfferExpectedPriceBatch(requestParameters: ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFeaturedOfferExpectedPriceBatchResponse, any, {}>>;
+}
+//#endregion
+//#region src/client.d.ts
+declare const clientRateLimits: RateLimit[];
+declare class ProductPricingApiClient extends ProductPricingApi {
+  constructor(configuration: ClientConfiguration);
+}
+//#endregion
+export { BatchRequest, BatchResponse, CompetitiveSummaryBatchRequest, CompetitiveSummaryBatchResponse, CompetitiveSummaryIncludedData, CompetitiveSummaryRequest, CompetitiveSummaryResponse, CompetitiveSummaryResponseBody, Condition, Errors, FeaturedBuyingOption, FeaturedBuyingOptionBuyingOptionTypeEnum, FeaturedOffer, FeaturedOfferExpectedPrice, FeaturedOfferExpectedPriceRequest, FeaturedOfferExpectedPriceRequestParams, FeaturedOfferExpectedPriceResponse, FeaturedOfferExpectedPriceResponseAllOf, FeaturedOfferExpectedPriceResponseBody, FeaturedOfferExpectedPriceResult, FeaturedOfferSegment, FeaturedOfferSegmentCustomerMembershipEnum, FulfillmentType, GetFeaturedOfferExpectedPriceBatchRequest, GetFeaturedOfferExpectedPriceBatchResponse, HttpMethod, HttpStatusLine, Item, LowestPricedOffer, LowestPricedOffersInput, LowestPricedOffersInputOfferTypeEnum, ModelError, MoneyType, Offer, OfferIdentifier, OfferSubConditionEnum, Points, PostalCode, Price, PrimeDetails, PrimeDetailsEligibilityEnum, ProductPricingApi, ProductPricingApiAxiosParamCreator, ProductPricingApiClient, ProductPricingApiFactory, ProductPricingApiFp, ProductPricingApiGetCompetitiveSummaryRequest, ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest, ReferencePrice, SampleLocation, Segment, SegmentDetails, SegmentedFeaturedOffer, SegmentedFeaturedOfferAllOf, ShippingOption, ShippingOptionShippingOptionTypeEnum, SimilarItems, clientRateLimits };
+//# sourceMappingURL=index.d.ts.map