@sp-api-sdk/product-pricing-api-v0 3.1.4 → 3.1.5

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/asinidentifier.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Schema to identify an item by MarketPlaceId and ASIN.
- * @export
- * @interface ASINIdentifier
  */
 export interface ASINIdentifier {
     /**
      * A marketplace identifier.
-     * @type {string}
-     * @memberof ASINIdentifier
      */
     'MarketplaceId': string;
     /**
      * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof ASINIdentifier
      */
     'ASIN': string;
 }

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

@@ -13,26 +13,12 @@ import type { CustomerType } from './customer-type';
 import type { ItemCondition } from './item-condition';
 /**
  * Common request parameters that can be accepted by `ItemOffersRequest` and `ListingOffersRequest`
- * @export
- * @interface BatchOffersRequestParams
  */
 export interface BatchOffersRequestParams {
     /**
      * A marketplace identifier. Specifies the marketplace for which prices are returned.
-     * @type {string}
-     * @memberof BatchOffersRequestParams
      */
     'MarketplaceId': string;
-    /**
-     *
-     * @type {ItemCondition}
-     * @memberof BatchOffersRequestParams
-     */
     'ItemCondition': ItemCondition;
-    /**
-     *
-     * @type {CustomerType}
-     * @memberof BatchOffersRequestParams
-     */
     'CustomerType'?: CustomerType;
 }

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

@@ -14,26 +14,9 @@ import type { GetOffersResponse } from './get-offers-response';
 import type { HttpResponseHeaders } from './http-response-headers';
 /**
  * Common schema that present in `ItemOffersResponse` and `ListingOffersResponse`
- * @export
- * @interface BatchOffersResponse
  */
 export interface BatchOffersResponse {
-    /**
-     *
-     * @type {HttpResponseHeaders}
-     * @memberof BatchOffersResponse
-     */
     'headers'?: HttpResponseHeaders;
-    /**
-     *
-     * @type {GetOffersHttpStatusLine}
-     * @memberof BatchOffersResponse
-     */
     'status'?: GetOffersHttpStatusLine;
-    /**
-     *
-     * @type {GetOffersResponse}
-     * @memberof BatchOffersResponse
-     */
     'body': GetOffersResponse;
 }

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

@@ -12,26 +12,15 @@
 import type { HttpMethod } from './http-method';
 /**
  * Common properties of batch requests against individual APIs.
- * @export
- * @interface BatchRequest
  */
 export interface BatchRequest {
     /**
      * The resource path of the operation you are calling in batch without any query parameters.  If you are calling `getItemOffersBatch`, supply the path of `getItemOffers`.  **Example:** `/products/pricing/v0/items/B000P6Q7MY/offers`  If you are calling `getListingOffersBatch`, supply the path of `getListingOffers`.  **Example:** `/products/pricing/v0/listings/B000P6Q7MY/offers`
-     * @type {string}
-     * @memberof BatchRequest
      */
     'uri': string;
-    /**
-     *
-     * @type {HttpMethod}
-     * @memberof BatchRequest
-     */
     'method': HttpMethod;
     /**
      * A mapping of additional HTTP headers to send/receive for the individual batch request.
-     * @type {{ [key: string]: string; }}
-     * @memberof BatchRequest
      */
     'headers'?: {
         [key: string]: string;

package/dist/types/api-model/models/buy-box-price-type.d.ts

@@ -15,62 +15,24 @@ import type { Points } from './points';
 import type { QuantityDiscountType } from './quantity-discount-type';
 /**
  * Schema for an individual buybox price.
- * @export
- * @interface BuyBoxPriceType
  */
 export interface BuyBoxPriceType {
     /**
      * Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.
-     * @type {string}
-     * @memberof BuyBoxPriceType
      */
     'condition': string;
-    /**
-     *
-     * @type {OfferCustomerType}
-     * @memberof BuyBoxPriceType
-     */
     'offerType'?: OfferCustomerType;
     /**
      * Indicates at what quantity this price becomes active.
-     * @type {number}
-     * @memberof BuyBoxPriceType
      */
     'quantityTier'?: number;
-    /**
-     *
-     * @type {QuantityDiscountType}
-     * @memberof BuyBoxPriceType
-     */
     'quantityDiscountType'?: QuantityDiscountType;
-    /**
-     *
-     * @type {MoneyType}
-     * @memberof BuyBoxPriceType
-     */
     'LandedPrice': MoneyType;
-    /**
-     *
-     * @type {MoneyType}
-     * @memberof BuyBoxPriceType
-     */
     'ListingPrice': MoneyType;
-    /**
-     *
-     * @type {MoneyType}
-     * @memberof BuyBoxPriceType
-     */
     'Shipping': MoneyType;
-    /**
-     *
-     * @type {Points}
-     * @memberof BuyBoxPriceType
-     */
     'Points'?: Points;
     /**
      * The seller identifier for the offer.
-     * @type {string}
-     * @memberof BuyBoxPriceType
      */
     'sellerId'?: string;
 }

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

@@ -14,62 +14,33 @@ import type { PriceType } from './price-type';
 import type { QuantityDiscountType } from './quantity-discount-type';
 /**
  * Schema for competitive pricing information
- * @export
- * @interface CompetitivePriceType
  */
 export interface CompetitivePriceType {
     /**
      * The pricing model for each price that is returned.  Possible values:  * 1 - New Buy Box Price. * 2 - Used Buy Box Price.
-     * @type {string}
-     * @memberof CompetitivePriceType
      */
     'CompetitivePriceId': string;
-    /**
-     *
-     * @type {PriceType}
-     * @memberof CompetitivePriceType
-     */
     'Price': PriceType;
     /**
      * Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, or Club.
-     * @type {string}
-     * @memberof CompetitivePriceType
      */
     'condition'?: string;
     /**
      * Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.
-     * @type {string}
-     * @memberof CompetitivePriceType
      */
     'subcondition'?: string;
-    /**
-     *
-     * @type {OfferCustomerType}
-     * @memberof CompetitivePriceType
-     */
     'offerType'?: OfferCustomerType;
     /**
      * Indicates at what quantity this price becomes active.
-     * @type {number}
-     * @memberof CompetitivePriceType
      */
     'quantityTier'?: number;
-    /**
-     *
-     * @type {QuantityDiscountType}
-     * @memberof CompetitivePriceType
-     */
     'quantityDiscountType'?: QuantityDiscountType;
     /**
      * The seller identifier for the offer.
-     * @type {string}
-     * @memberof CompetitivePriceType
      */
     'sellerId'?: string;
     /**
      *  Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false.
-     * @type {boolean}
-     * @memberof CompetitivePriceType
      */
     'belongsToRequester'?: boolean;
 }

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

@@ -14,26 +14,15 @@ import type { MoneyType } from './money-type';
 import type { OfferListingCountType } from './offer-listing-count-type';
 /**
  * Competitive pricing information for the item.
- * @export
- * @interface CompetitivePricingType
  */
 export interface CompetitivePricingType {
     /**
      * A list of competitive pricing information.
-     * @type {Array<CompetitivePriceType>}
-     * @memberof CompetitivePricingType
      */
     'CompetitivePrices': Array<CompetitivePriceType>;
     /**
      * The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned.
-     * @type {Array<OfferListingCountType>}
-     * @memberof CompetitivePricingType
      */
     'NumberOfOfferListings': Array<OfferListingCountType>;
-    /**
-     *
-     * @type {MoneyType}
-     * @memberof CompetitivePricingType
-     */
     'TradeInValue'?: MoneyType;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Indicates the condition of the item. Possible values: New, Used, Collectible, Refurbished, Club.
- * @export
- * @enum {string}
  */
 export declare const ConditionType: {
     readonly New: "New";

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

@@ -11,8 +11,6 @@
  */
 /**
  * Indicates whether to request Consumer or Business offers. Default is Consumer.
- * @export
- * @enum {string}
  */
 export declare const CustomerType: {
     readonly Consumer: "Consumer";

package/dist/types/api-model/models/detailed-shipping-time-type.d.ts

@@ -11,32 +11,22 @@
  */
 /**
  * The time range in which an item will likely be shipped once an order has been placed.
- * @export
- * @interface DetailedShippingTimeType
  */
 export interface DetailedShippingTimeType {
     /**
      * The minimum time, in hours, that the item will likely be shipped after the order has been placed.
-     * @type {number}
-     * @memberof DetailedShippingTimeType
      */
     'minimumHours'?: number;
     /**
      * The maximum time, in hours, that the item will likely be shipped after the order has been placed.
-     * @type {number}
-     * @memberof DetailedShippingTimeType
      */
     'maximumHours'?: number;
     /**
      * The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping.
-     * @type {string}
-     * @memberof DetailedShippingTimeType
      */
     'availableDate'?: string;
     /**
      * Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE.
-     * @type {string}
-     * @memberof DetailedShippingTimeType
      */
     'availabilityType'?: DetailedShippingTimeTypeAvailabilityTypeEnum;
 }

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 returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof Errors
      */
     'errors': Array<Error>;
 }

package/dist/types/api-model/models/fulfillment-channel-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 FulfillmentChannelType: {
     readonly Amazon: "Amazon";

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

@@ -12,14 +12,10 @@
 import type { ItemOffersRequest } from './item-offers-request';
 /**
  * The request associated with the `getItemOffersBatch` API call.
- * @export
- * @interface GetItemOffersBatchRequest
  */
 export interface GetItemOffersBatchRequest {
     /**
      * A list of `getListingOffers` batched requests to run.
-     * @type {Array<ItemOffersRequest>}
-     * @memberof GetItemOffersBatchRequest
      */
     'requests'?: Array<ItemOffersRequest>;
 }

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

@@ -12,14 +12,10 @@
 import type { ItemOffersResponse } from './item-offers-response';
 /**
  * The response associated with the `getItemOffersBatch` API call.
- * @export
- * @interface GetItemOffersBatchResponse
  */
 export interface GetItemOffersBatchResponse {
     /**
      * A list of `getItemOffers` batched responses.
-     * @type {Array<ItemOffersResponse>}
-     * @memberof GetItemOffersBatchResponse
      */
     'responses'?: Array<ItemOffersResponse>;
 }

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

@@ -12,14 +12,10 @@
 import type { ListingOffersRequest } from './listing-offers-request';
 /**
  * The request associated with the `getListingOffersBatch` API call.
- * @export
- * @interface GetListingOffersBatchRequest
  */
 export interface GetListingOffersBatchRequest {
     /**
      * A list of `getListingOffers` batched requests to run.
-     * @type {Array<ListingOffersRequest>}
-     * @memberof GetListingOffersBatchRequest
      */
     'requests'?: Array<ListingOffersRequest>;
 }

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

@@ -12,14 +12,10 @@
 import type { ListingOffersResponse } from './listing-offers-response';
 /**
  * The response associated with the `getListingOffersBatch` API call.
- * @export
- * @interface GetListingOffersBatchResponse
  */
 export interface GetListingOffersBatchResponse {
     /**
      * A list of `getListingOffers` batched responses.
-     * @type {Array<ListingOffersResponse>}
-     * @memberof GetListingOffersBatchResponse
      */
     'responses'?: Array<ListingOffersResponse>;
 }

package/dist/types/api-model/models/get-offers-http-status-line.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The HTTP status line associated with the response.  For more information, consult [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html).
- * @export
- * @interface GetOffersHttpStatusLine
  */
 export interface GetOffersHttpStatusLine {
     /**
      * The HTTP response Status Code.
-     * @type {number}
-     * @memberof GetOffersHttpStatusLine
      */
     'statusCode'?: number;
     /**
      * The HTTP response Reason-Phase.
-     * @type {string}
-     * @memberof GetOffersHttpStatusLine
      */
     'reasonPhrase'?: string;
 }

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

@@ -12,20 +12,11 @@
 import type { GetOffersResult } from './get-offers-result';
 /**
  * The response schema for the `getListingOffers` and `getItemOffers` operations.
- * @export
- * @interface GetOffersResponse
  */
 export interface GetOffersResponse {
-    /**
-     *
-     * @type {GetOffersResult}
-     * @memberof GetOffersResponse
-     */
     'payload'?: GetOffersResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetOffersResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-offers-result.d.ts

@@ -15,56 +15,29 @@ import type { OfferDetail } from './offer-detail';
 import type { Summary } from './summary';
 /**
  * The payload for the getListingOffers and getItemOffers operations.
- * @export
- * @interface GetOffersResult
  */
 export interface GetOffersResult {
     /**
      * A marketplace identifier.
-     * @type {string}
-     * @memberof GetOffersResult
      */
     'MarketplaceID': string;
     /**
      * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof GetOffersResult
      */
     'ASIN'?: string;
     /**
      * The stock keeping unit (SKU) of the item.
-     * @type {string}
-     * @memberof GetOffersResult
      */
     'SKU'?: string;
-    /**
-     *
-     * @type {ConditionType}
-     * @memberof GetOffersResult
-     */
     'ItemCondition': ConditionType;
     /**
      * The status of the operation.
-     * @type {string}
-     * @memberof GetOffersResult
      */
     'status': string;
-    /**
-     *
-     * @type {ItemIdentifier}
-     * @memberof GetOffersResult
-     */
     'Identifier': ItemIdentifier;
-    /**
-     *
-     * @type {Summary}
-     * @memberof GetOffersResult
-     */
     'Summary': Summary;
     /**
      * A list of offer details. The list is the same length as the TotalOfferCount in the Summary or 20, whichever is less.
-     * @type {Array<OfferDetail>}
-     * @memberof GetOffersResult
      */
     'Offers': Array<OfferDetail>;
 }

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

@@ -12,20 +12,14 @@
 import type { Price } from './price';
 /**
  * The response schema for the `getPricing` and `getCompetitivePricing` operations.
- * @export
- * @interface GetPricingResponse
  */
 export interface GetPricingResponse {
     /**
      * The payload for the `getPricing` and `getCompetitivePricing` operations.
-     * @type {Array<Price>}
-     * @memberof GetPricingResponse
      */
     'payload'?: Array<Price>;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetPricingResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/http-method.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The HTTP method associated with the individual APIs being called as part of the batch request.
- * @export
- * @enum {string}
  */
 export declare const HttpMethod: {
     readonly Get: "GET";

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

@@ -11,21 +11,15 @@
  */
 /**
  * A mapping of additional HTTP headers to send/receive for the individual batch request.
- * @export
- * @interface HttpResponseHeaders
  */
 export interface HttpResponseHeaders {
     [key: string]: string | any;
     /**
      * The timestamp that the API request was received.  For more information, consult [RFC 2616 Section 14](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
-     * @type {string}
-     * @memberof HttpResponseHeaders
      */
     'Date'?: string;
     /**
      * Unique request reference identifier.
-     * @type {string}
-     * @memberof HttpResponseHeaders
      */
     'x-amzn-RequestId'?: string;
 }

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

@@ -13,20 +13,8 @@ import type { ASINIdentifier } from './asinidentifier';
 import type { SellerSKUIdentifier } from './seller-skuidentifier';
 /**
  * Specifies the identifiers used to uniquely identify an item.
- * @export
- * @interface IdentifierType
  */
 export interface IdentifierType {
-    /**
-     *
-     * @type {ASINIdentifier}
-     * @memberof IdentifierType
-     */
     'MarketplaceASIN': ASINIdentifier;
-    /**
-     *
-     * @type {SellerSKUIdentifier}
-     * @memberof IdentifierType
-     */
     'SKUIdentifier'?: SellerSKUIdentifier;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.
- * @export
- * @enum {string}
  */
 export declare const ItemCondition: {
     readonly New: "New";

package/dist/types/api-model/models/item-identifier.d.ts

@@ -12,32 +12,19 @@
 import type { ConditionType } from './condition-type';
 /**
  * Information that identifies an item.
- * @export
- * @interface ItemIdentifier
  */
 export interface ItemIdentifier {
     /**
      * A marketplace identifier. Specifies the marketplace from which prices are returned.
-     * @type {string}
-     * @memberof ItemIdentifier
      */
     'MarketplaceId': string;
     /**
      * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof ItemIdentifier
      */
     'ASIN'?: string;
     /**
      * The seller stock keeping unit (SKU) of the item.
-     * @type {string}
-     * @memberof ItemIdentifier
      */
     'SellerSKU'?: string;
-    /**
-     *
-     * @type {ConditionType}
-     * @memberof ItemIdentifier
-     */
     'ItemCondition': ConditionType;
 }