@sp-api-sdk/product-pricing-api-2022-05-01 3.1.4 → 3.2.1

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

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

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

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

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

@@ -23,49 +23,32 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

package/dist/types/api-model/models/batch-request.d.ts

@@ -12,34 +12,21 @@
 import type { HttpMethod } from './http-method';
 /**
  * The common properties for individual requests within a batch.
- * @export
- * @interface BatchRequest
  */
 export interface BatchRequest {
     /**
      * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`.
-     * @type {string}
-     * @memberof BatchRequest
      */
     'uri': string;
-    /**
-     *
-     * @type {HttpMethod}
-     * @memberof BatchRequest
-     */
     'method': HttpMethod;
     /**
      * Additional HTTP body information that is associated with an individual request within a batch.
-     * @type {{ [key: string]: object; }}
-     * @memberof BatchRequest
      */
     'body'?: {
         [key: string]: object;
     };
     /**
      * A mapping of additional HTTP headers to send or receive for an individual request within a batch.
-     * @type {{ [key: string]: string; }}
-     * @memberof BatchRequest
      */
     'headers'?: {
         [key: string]: string;

package/dist/types/api-model/models/batch-response.d.ts

@@ -12,22 +12,13 @@
 import type { HttpStatusLine } from './http-status-line';
 /**
  * The common properties for responses to individual requests within a batch.
- * @export
- * @interface BatchResponse
  */
 export interface BatchResponse {
     /**
      * A mapping of additional HTTP headers to send or receive for an individual request within a batch.
-     * @type {{ [key: string]: string; }}
-     * @memberof BatchResponse
      */
     'headers': {
         [key: string]: string;
     };
-    /**
-     *
-     * @type {HttpStatusLine}
-     * @memberof BatchResponse
-     */
     'status': HttpStatusLine;
 }

package/dist/types/api-model/models/competitive-summary-batch-request.d.ts

@@ -12,14 +12,10 @@
 import type { CompetitiveSummaryRequest } from './competitive-summary-request';
 /**
  * The `competitiveSummary` batch request data.
- * @export
- * @interface CompetitiveSummaryBatchRequest
  */
 export interface CompetitiveSummaryBatchRequest {
     /**
      * A batched list of `competitiveSummary` requests.
-     * @type {Array<CompetitiveSummaryRequest>}
-     * @memberof CompetitiveSummaryBatchRequest
      */
     'requests': Array<CompetitiveSummaryRequest>;
 }

package/dist/types/api-model/models/competitive-summary-batch-response.d.ts

@@ -12,14 +12,10 @@
 import type { CompetitiveSummaryResponse } from './competitive-summary-response';
 /**
  * The response schema for the `competitiveSummaryBatch` operation.
- * @export
- * @interface CompetitiveSummaryBatchResponse
  */
 export interface CompetitiveSummaryBatchResponse {
     /**
      * The response list for the `competitiveSummaryBatch` operation.
-     * @type {Array<CompetitiveSummaryResponse>}
-     * @memberof CompetitiveSummaryBatchResponse
      */
     'responses': Array<CompetitiveSummaryResponse>;
 }

package/dist/types/api-model/models/competitive-summary-included-data.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The supported data types in the `getCompetitiveSummary` API.
- * @export
- * @enum {string}
  */
 export declare const CompetitiveSummaryIncludedData: {
     readonly FeaturedBuyingOptions: "featuredBuyingOptions";

package/dist/types/api-model/models/competitive-summary-request.d.ts

@@ -14,44 +14,27 @@ import type { HttpMethod } from './http-method';
 import type { LowestPricedOffersInput } from './lowest-priced-offers-input';
 /**
  * An individual `competitiveSummary` request for an ASIN and `marketplaceId`.
- * @export
- * @interface CompetitiveSummaryRequest
  */
 export interface CompetitiveSummaryRequest {
     /**
      * The ASIN of the item.
-     * @type {string}
-     * @memberof CompetitiveSummaryRequest
      */
     'asin': string;
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
-     * @type {string}
-     * @memberof CompetitiveSummaryRequest
+     * 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.
-     * @type {Array<CompetitiveSummaryIncludedData>}
-     * @memberof CompetitiveSummaryRequest
      */
     '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`
-     * @type {Array<LowestPricedOffersInput>}
-     * @memberof CompetitiveSummaryRequest
      */
     'lowestPricedOffersInputs'?: Array<LowestPricedOffersInput>;
-    /**
-     *
-     * @type {HttpMethod}
-     * @memberof CompetitiveSummaryRequest
-     */
     'method': HttpMethod;
     /**
      * The URI associated with the individual APIs that are called as part of the batch request.
-     * @type {string}
-     * @memberof CompetitiveSummaryRequest
      */
     'uri': string;
 }

package/dist/types/api-model/models/competitive-summary-response-body.d.ts

@@ -14,44 +14,30 @@ import type { LowestPricedOffer } from './lowest-priced-offer';
 import type { ReferencePrice } from './reference-price';
 /**
  * The `competitiveSummaryResponse` body for a requested ASIN and `marketplaceId`.
- * @export
- * @interface CompetitiveSummaryResponseBody
  */
 export interface CompetitiveSummaryResponseBody {
     /**
      * The ASIN of the item.
-     * @type {string}
-     * @memberof CompetitiveSummaryResponseBody
      */
     'asin': string;
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
-     * @type {string}
-     * @memberof CompetitiveSummaryResponseBody
+     * 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.
-     * @type {Array<FeaturedBuyingOption>}
-     * @memberof CompetitiveSummaryResponseBody
      */
     'featuredBuyingOptions'?: Array<FeaturedBuyingOption>;
     /**
      * A list of lowest priced offers for the specified ASIN `marketplaceId` combination.
-     * @type {Array<LowestPricedOffer>}
-     * @memberof CompetitiveSummaryResponseBody
      */
     'lowestPricedOffers'?: Array<LowestPricedOffer>;
     /**
      * A list of reference prices for the specified ASIN `marketplaceId` combination.
-     * @type {Array<ReferencePrice>}
-     * @memberof CompetitiveSummaryResponseBody
      */
     'referencePrices'?: Array<ReferencePrice>;
     /**
      * A list of error responses that are returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof CompetitiveSummaryResponseBody
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/competitive-summary-response.d.ts

@@ -13,20 +13,8 @@ import type { CompetitiveSummaryResponseBody } from './competitive-summary-respo
 import type { HttpStatusLine } from './http-status-line';
 /**
  * The response for the individual `competitiveSummary` request in the batch operation.
- * @export
- * @interface CompetitiveSummaryResponse
  */
 export interface CompetitiveSummaryResponse {
-    /**
-     *
-     * @type {HttpStatusLine}
-     * @memberof CompetitiveSummaryResponse
-     */
     'status': HttpStatusLine;
-    /**
-     *
-     * @type {CompetitiveSummaryResponseBody}
-     * @memberof CompetitiveSummaryResponse
-     */
     'body': CompetitiveSummaryResponseBody;
 }

package/dist/types/api-model/models/condition.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The condition of the item.
- * @export
- * @enum {string}
  */
 export declare const Condition: {
     readonly New: "New";

package/dist/types/api-model/models/errors.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * A list of error responses returned when a request is unsuccessful.
- * @export
- * @interface Errors
  */
 export interface Errors {
     /**
      * A list of error responses that are returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof Errors
      */
     'errors': Array<Error>;
 }

package/dist/types/api-model/models/featured-buying-option.d.ts

@@ -12,20 +12,14 @@
 import type { SegmentedFeaturedOffer } from './segmented-featured-offer';
 /**
  * Describes a featured buying option, which includes a list of segmented featured offers for a particular item condition.
- * @export
- * @interface FeaturedBuyingOption
  */
 export 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.
-     * @type {string}
-     * @memberof FeaturedBuyingOption
      */
     '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.
-     * @type {Array<SegmentedFeaturedOffer>}
-     * @memberof FeaturedBuyingOption
      */
     'segmentedFeaturedOffers': Array<SegmentedFeaturedOffer>;
 }

package/dist/types/api-model/models/featured-offer-expected-price-request-params.d.ts

@@ -12,26 +12,15 @@
 import type { Segment } from './segment';
 /**
  * The parameters for an individual request.
- * @export
- * @interface FeaturedOfferExpectedPriceRequestParams
  */
 export interface FeaturedOfferExpectedPriceRequestParams {
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
-     * @type {string}
-     * @memberof 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.
-     * @type {string}
-     * @memberof FeaturedOfferExpectedPriceRequestParams
      */
     'sku': string;
-    /**
-     *
-     * @type {Segment}
-     * @memberof FeaturedOfferExpectedPriceRequestParams
-     */
     'segment'?: Segment;
 }

package/dist/types/api-model/models/featured-offer-expected-price-request.d.ts

@@ -14,6 +14,5 @@ import type { FeaturedOfferExpectedPriceRequestParams } from './featured-offer-e
 /**
  * @type FeaturedOfferExpectedPriceRequest
  * An individual FOEP request for a particular SKU.
- * @export
  */
 export type FeaturedOfferExpectedPriceRequest = BatchRequest & FeaturedOfferExpectedPriceRequestParams;

package/dist/types/api-model/models/featured-offer-expected-price-response-all-of.d.ts

@@ -11,22 +11,7 @@
  */
 import type { FeaturedOfferExpectedPriceRequestParams } from './featured-offer-expected-price-request-params';
 import type { FeaturedOfferExpectedPriceResponseBody } from './featured-offer-expected-price-response-body';
-/**
- *
- * @export
- * @interface FeaturedOfferExpectedPriceResponseAllOf
- */
 export interface FeaturedOfferExpectedPriceResponseAllOf {
-    /**
-     *
-     * @type {FeaturedOfferExpectedPriceRequestParams}
-     * @memberof FeaturedOfferExpectedPriceResponseAllOf
-     */
     'request': FeaturedOfferExpectedPriceRequestParams;
-    /**
-     *
-     * @type {FeaturedOfferExpectedPriceResponseBody}
-     * @memberof FeaturedOfferExpectedPriceResponseAllOf
-     */
     'body'?: FeaturedOfferExpectedPriceResponseBody;
 }

package/dist/types/api-model/models/featured-offer-expected-price-response-body.d.ts

@@ -13,26 +13,15 @@ import type { FeaturedOfferExpectedPriceResult } from './featured-offer-expected
 import type { OfferIdentifier } from './offer-identifier';
 /**
  * The FOEP response data for a requested SKU.
- * @export
- * @interface FeaturedOfferExpectedPriceResponseBody
  */
 export interface FeaturedOfferExpectedPriceResponseBody {
-    /**
-     *
-     * @type {OfferIdentifier}
-     * @memberof FeaturedOfferExpectedPriceResponseBody
-     */
     'offerIdentifier'?: OfferIdentifier;
     /**
      * A list of FOEP results for the requested offer.
-     * @type {Array<FeaturedOfferExpectedPriceResult>}
-     * @memberof FeaturedOfferExpectedPriceResponseBody
      */
     'featuredOfferExpectedPriceResults'?: Array<FeaturedOfferExpectedPriceResult>;
     /**
      * A list of error responses that are returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof FeaturedOfferExpectedPriceResponseBody
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/featured-offer-expected-price-response.d.ts

@@ -14,6 +14,5 @@ import type { FeaturedOfferExpectedPriceResponseAllOf } from './featured-offer-e
 /**
  * @type FeaturedOfferExpectedPriceResponse
  * Schema for an individual FOEP response.
- * @export
  */
 export type FeaturedOfferExpectedPriceResponse = BatchResponse & FeaturedOfferExpectedPriceResponseAllOf;

package/dist/types/api-model/models/featured-offer-expected-price-result.d.ts

@@ -13,32 +13,13 @@ import type { FeaturedOffer } from './featured-offer';
 import type { FeaturedOfferExpectedPrice } from './featured-offer-expected-price';
 /**
  * The FOEP result data for the requested offer.
- * @export
- * @interface FeaturedOfferExpectedPriceResult
  */
 export interface FeaturedOfferExpectedPriceResult {
-    /**
-     *
-     * @type {FeaturedOfferExpectedPrice}
-     * @memberof 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.
-     * @type {string}
-     * @memberof FeaturedOfferExpectedPriceResult
      */
     'resultStatus': string;
-    /**
-     *
-     * @type {FeaturedOffer}
-     * @memberof FeaturedOfferExpectedPriceResult
-     */
     'competingFeaturedOffer'?: FeaturedOffer;
-    /**
-     *
-     * @type {FeaturedOffer}
-     * @memberof FeaturedOfferExpectedPriceResult
-     */
     'currentFeaturedOffer'?: FeaturedOffer;
 }

package/dist/types/api-model/models/featured-offer-expected-price.d.ts

@@ -13,20 +13,8 @@ import type { MoneyType } from './money-type';
 import type { Points } from './points';
 /**
  * The item price at or below which the target offer may be featured.
- * @export
- * @interface FeaturedOfferExpectedPrice
  */
 export interface FeaturedOfferExpectedPrice {
-    /**
-     *
-     * @type {MoneyType}
-     * @memberof FeaturedOfferExpectedPrice
-     */
     'listingPrice': MoneyType;
-    /**
-     *
-     * @type {Points}
-     * @memberof FeaturedOfferExpectedPrice
-     */
     'points'?: Points;
 }

package/dist/types/api-model/models/featured-offer-segment.d.ts

@@ -12,25 +12,17 @@
 import type { SegmentDetails } from './segment-details';
 /**
  * Describes the segment in which the offer is featured.
- * @export
- * @interface FeaturedOfferSegment
  */
 export interface FeaturedOfferSegment {
     /**
      * The customer membership type that makes up this segment
-     * @type {string}
-     * @memberof FeaturedOfferSegment
      */
     'customerMembership': FeaturedOfferSegmentCustomerMembershipEnum;
-    /**
-     *
-     * @type {SegmentDetails}
-     * @memberof FeaturedOfferSegment
-     */
     'segmentDetails': SegmentDetails;
 }
 export declare const FeaturedOfferSegmentCustomerMembershipEnum: {
     readonly Prime: "PRIME";
     readonly NonPrime: "NON_PRIME";
+    readonly Default: "DEFAULT";
 };
 export type FeaturedOfferSegmentCustomerMembershipEnum = typeof FeaturedOfferSegmentCustomerMembershipEnum[keyof typeof FeaturedOfferSegmentCustomerMembershipEnum];

package/dist/types/api-model/models/featured-offer.d.ts

@@ -14,26 +14,9 @@ import type { OfferIdentifier } from './offer-identifier';
 import type { Price } from './price';
 /**
  * Schema for `currentFeaturedOffer` or `competingFeaturedOffer`.
- * @export
- * @interface FeaturedOffer
  */
 export interface FeaturedOffer {
-    /**
-     *
-     * @type {OfferIdentifier}
-     * @memberof FeaturedOffer
-     */
     'offerIdentifier': OfferIdentifier;
-    /**
-     *
-     * @type {Condition}
-     * @memberof FeaturedOffer
-     */
     'condition'?: Condition;
-    /**
-     *
-     * @type {Price}
-     * @memberof FeaturedOffer
-     */
     'price'?: Price;
 }

package/dist/types/api-model/models/fulfillment-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Indicates whether the item is fulfilled by Amazon or by the seller (merchant).
- * @export
- * @enum {string}
  */
 export declare const FulfillmentType: {
     readonly Afn: "AFN";

package/dist/types/api-model/models/get-featured-offer-expected-price-batch-request.d.ts

@@ -12,14 +12,10 @@
 import type { FeaturedOfferExpectedPriceRequest } from './featured-offer-expected-price-request';
 /**
  * The request body for the `getFeaturedOfferExpectedPriceBatch` operation.
- * @export
- * @interface GetFeaturedOfferExpectedPriceBatchRequest
  */
 export interface GetFeaturedOfferExpectedPriceBatchRequest {
     /**
      * A batched list of FOEP requests.
-     * @type {Array<FeaturedOfferExpectedPriceRequest>}
-     * @memberof GetFeaturedOfferExpectedPriceBatchRequest
      */
     'requests'?: Array<FeaturedOfferExpectedPriceRequest>;
 }

package/dist/types/api-model/models/get-featured-offer-expected-price-batch-response.d.ts

@@ -12,14 +12,10 @@
 import type { FeaturedOfferExpectedPriceResponse } from './featured-offer-expected-price-response';
 /**
  * The response schema for the `getFeaturedOfferExpectedPriceBatch` operation.
- * @export
- * @interface GetFeaturedOfferExpectedPriceBatchResponse
  */
 export interface GetFeaturedOfferExpectedPriceBatchResponse {
     /**
      * A batched list of FOEP responses.
-     * @type {Array<FeaturedOfferExpectedPriceResponse>}
-     * @memberof GetFeaturedOfferExpectedPriceBatchResponse
      */
     'responses'?: Array<FeaturedOfferExpectedPriceResponse>;
 }