amazon-pa-api5-node-ts
Version:
ProductAdvertisingAPI 5.0 NodeJS SDK rewritten in TypeScript.
660 lines (659 loc) • 18.3 kB
text/typescript
/**
* Adapted to TypeScript by David A. Ball. (c) 2024.
*
* Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/**
* ProductAdvertisingAPI
* https://webservices.amazon.com/paapi5/documentation/index.html
*
*/
/**
* Enum class SearchItemsResource.
* @enum {}
* @readonly
*/
export declare const SearchItemsResourceValues: {
/**
* value: "BrowseNodeInfo.BrowseNodes"
* @const
*/
"BrowseNodeInfo.BrowseNodes": string;
/**
* value: "BrowseNodeInfo.BrowseNodes.Ancestor"
* @const
*/
"BrowseNodeInfo.BrowseNodes.Ancestor": string;
/**
* value: "BrowseNodeInfo.BrowseNodes.SalesRank"
* @const
*/
"BrowseNodeInfo.BrowseNodes.SalesRank": string;
/**
* value: "BrowseNodeInfo.WebsiteSalesRank"
* @const
*/
"BrowseNodeInfo.WebsiteSalesRank": string;
/**
* value: "CustomerReviews.Count"
* @const
*/
"CustomerReviews.Count": string;
/**
* value: "CustomerReviews.StarRating"
* @const
*/
"CustomerReviews.StarRating": string;
/**
* value: "Images.Primary.Small"
* @const
*/
"Images.Primary.Small": string;
/**
* value: "Images.Primary.Medium"
* @const
*/
"Images.Primary.Medium": string;
/**
* value: "Images.Primary.Large"
* @const
*/
"Images.Primary.Large": string;
/**
* value: "Images.Primary.HighRes"
* @const
*/
"Images.Primary.HighRes": string;
/**
* value: "Images.Variants.Small"
* @const
*/
"Images.Variants.Small": string;
/**
* value: "Images.Variants.Medium"
* @const
*/
"Images.Variants.Medium": string;
/**
* value: "Images.Variants.Large"
* @const
*/
"Images.Variants.Large": string;
/**
* value: "Images.Variants.HighRes"
* @const
*/
"Images.Variants.HighRes": string;
/**
* value: "ItemInfo.ByLineInfo"
* @const
*/
"ItemInfo.ByLineInfo": string;
/**
* value: "ItemInfo.ContentInfo"
* @const
*/
"ItemInfo.ContentInfo": string;
/**
* value: "ItemInfo.ContentRating"
* @const
*/
"ItemInfo.ContentRating": string;
/**
* value: "ItemInfo.Classifications"
* @const
*/
"ItemInfo.Classifications": string;
/**
* value: "ItemInfo.ExternalIds"
* @const
*/
"ItemInfo.ExternalIds": string;
/**
* value: "ItemInfo.Features"
* @const
*/
"ItemInfo.Features": string;
/**
* value: "ItemInfo.ManufactureInfo"
* @const
*/
"ItemInfo.ManufactureInfo": string;
/**
* value: "ItemInfo.ProductInfo"
* @const
*/
"ItemInfo.ProductInfo": string;
/**
* value: "ItemInfo.TechnicalInfo"
* @const
*/
"ItemInfo.TechnicalInfo": string;
/**
* value: "ItemInfo.Title"
* @const
*/
"ItemInfo.Title": string;
/**
* value: "ItemInfo.TradeInInfo"
* @const
*/
"ItemInfo.TradeInInfo": string;
/**
* value: "Offers.Listings.Availability.MaxOrderQuantity"
* @const
*/
"Offers.Listings.Availability.MaxOrderQuantity": string;
/**
* value: "Offers.Listings.Availability.Message"
* @const
*/
"Offers.Listings.Availability.Message": string;
/**
* value: "Offers.Listings.Availability.MinOrderQuantity"
* @const
*/
"Offers.Listings.Availability.MinOrderQuantity": string;
/**
* value: "Offers.Listings.Availability.Type"
* @const
*/
"Offers.Listings.Availability.Type": string;
/**
* value: "Offers.Listings.Condition"
* @const
*/
"Offers.Listings.Condition": string;
/**
* value: "Offers.Listings.Condition.ConditionNote"
* @const
*/
"Offers.Listings.Condition.ConditionNote": string;
/**
* value: "Offers.Listings.Condition.SubCondition"
* @const
*/
"Offers.Listings.Condition.SubCondition": string;
/**
* value: "Offers.Listings.DeliveryInfo.IsAmazonFulfilled"
* @const
*/
"Offers.Listings.DeliveryInfo.IsAmazonFulfilled": string;
/**
* value: "Offers.Listings.DeliveryInfo.IsFreeShippingEligible"
* @const
*/
"Offers.Listings.DeliveryInfo.IsFreeShippingEligible": string;
/**
* value: "Offers.Listings.DeliveryInfo.IsPrimeEligible"
* @const
*/
"Offers.Listings.DeliveryInfo.IsPrimeEligible": string;
/**
* value: "Offers.Listings.DeliveryInfo.ShippingCharges"
* @const
*/
"Offers.Listings.DeliveryInfo.ShippingCharges": string;
/**
* value: "Offers.Listings.IsBuyBoxWinner"
* @const
*/
"Offers.Listings.IsBuyBoxWinner": string;
/**
* value: "Offers.Listings.LoyaltyPoints.Points"
* @const
*/
"Offers.Listings.LoyaltyPoints.Points": string;
/**
* value: "Offers.Listings.MerchantInfo"
* @const
*/
"Offers.Listings.MerchantInfo": string;
/**
* value: "Offers.Listings.Price"
* @const
*/
"Offers.Listings.Price": string;
/**
* value: "Offers.Listings.ProgramEligibility.IsPrimeExclusive"
* @const
*/
"Offers.Listings.ProgramEligibility.IsPrimeExclusive": string;
/**
* value: "Offers.Listings.ProgramEligibility.IsPrimePantry"
* @const
*/
"Offers.Listings.ProgramEligibility.IsPrimePantry": string;
/**
* value: "Offers.Listings.Promotions"
* @const
*/
"Offers.Listings.Promotions": string;
/**
* value: "Offers.Listings.SavingBasis"
* @const
*/
"Offers.Listings.SavingBasis": string;
/**
* value: "Offers.Summaries.HighestPrice"
* @const
*/
"Offers.Summaries.HighestPrice": string;
/**
* value: "Offers.Summaries.LowestPrice"
* @const
*/
"Offers.Summaries.LowestPrice": string;
/**
* value: "Offers.Summaries.OfferCount"
* @const
*/
"Offers.Summaries.OfferCount": string;
/**
* value: "ParentASIN"
* @const
*/
ParentASIN: string;
/**
* value: "RentalOffers.Listings.Availability.MaxOrderQuantity"
* @const
*/
"RentalOffers.Listings.Availability.MaxOrderQuantity": string;
/**
* value: "RentalOffers.Listings.Availability.Message"
* @const
*/
"RentalOffers.Listings.Availability.Message": string;
/**
* value: "RentalOffers.Listings.Availability.MinOrderQuantity"
* @const
*/
"RentalOffers.Listings.Availability.MinOrderQuantity": string;
/**
* value: "RentalOffers.Listings.Availability.Type"
* @const
*/
"RentalOffers.Listings.Availability.Type": string;
/**
* value: "RentalOffers.Listings.BasePrice"
* @const
*/
"RentalOffers.Listings.BasePrice": string;
/**
* value: "RentalOffers.Listings.Condition"
* @const
*/
"RentalOffers.Listings.Condition": string;
/**
* value: "RentalOffers.Listings.Condition.ConditionNote"
* @const
*/
"RentalOffers.Listings.Condition.ConditionNote": string;
/**
* value: "RentalOffers.Listings.Condition.SubCondition"
* @const
*/
"RentalOffers.Listings.Condition.SubCondition": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.IsAmazonFulfilled"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.IsAmazonFulfilled": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.IsFreeShippingEligible"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.IsFreeShippingEligible": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.IsPrimeEligible"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.IsPrimeEligible": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.ShippingCharges"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.ShippingCharges": string;
/**
* value: "RentalOffers.Listings.MerchantInfo"
* @const
*/
"RentalOffers.Listings.MerchantInfo": string;
/**
* value: "SearchRefinements"
* @const
*/
SearchRefinements: string;
};
export declare class SearchItemsResource extends String {
[key: string]: any;
constructor();
/**
* Returns a <code>SearchItemsResource</code> enum value from a Javascript object name.
* @param {Object} data The plain JavaScript object containing the name of the enum value.
* @return {module:model/SearchItemsResource} The enum <code>SearchItemsResource</code> value.
*/
static constructFromObject(object: string | SearchItemsResource | typeof SearchItemsResourceValues): string | {
/**
* value: "BrowseNodeInfo.BrowseNodes"
* @const
*/
"BrowseNodeInfo.BrowseNodes": string;
/**
* value: "BrowseNodeInfo.BrowseNodes.Ancestor"
* @const
*/
"BrowseNodeInfo.BrowseNodes.Ancestor": string;
/**
* value: "BrowseNodeInfo.BrowseNodes.SalesRank"
* @const
*/
"BrowseNodeInfo.BrowseNodes.SalesRank": string;
/**
* value: "BrowseNodeInfo.WebsiteSalesRank"
* @const
*/
"BrowseNodeInfo.WebsiteSalesRank": string;
/**
* value: "CustomerReviews.Count"
* @const
*/
"CustomerReviews.Count": string;
/**
* value: "CustomerReviews.StarRating"
* @const
*/
"CustomerReviews.StarRating": string;
/**
* value: "Images.Primary.Small"
* @const
*/
"Images.Primary.Small": string;
/**
* value: "Images.Primary.Medium"
* @const
*/
"Images.Primary.Medium": string;
/**
* value: "Images.Primary.Large"
* @const
*/
"Images.Primary.Large": string;
/**
* value: "Images.Primary.HighRes"
* @const
*/
"Images.Primary.HighRes": string;
/**
* value: "Images.Variants.Small"
* @const
*/
"Images.Variants.Small": string;
/**
* value: "Images.Variants.Medium"
* @const
*/
"Images.Variants.Medium": string;
/**
* value: "Images.Variants.Large"
* @const
*/
"Images.Variants.Large": string;
/**
* value: "Images.Variants.HighRes"
* @const
*/
"Images.Variants.HighRes": string;
/**
* value: "ItemInfo.ByLineInfo"
* @const
*/
"ItemInfo.ByLineInfo": string;
/**
* value: "ItemInfo.ContentInfo"
* @const
*/
"ItemInfo.ContentInfo": string;
/**
* value: "ItemInfo.ContentRating"
* @const
*/
"ItemInfo.ContentRating": string;
/**
* value: "ItemInfo.Classifications"
* @const
*/
"ItemInfo.Classifications": string;
/**
* value: "ItemInfo.ExternalIds"
* @const
*/
"ItemInfo.ExternalIds": string;
/**
* value: "ItemInfo.Features"
* @const
*/
"ItemInfo.Features": string;
/**
* value: "ItemInfo.ManufactureInfo"
* @const
*/
"ItemInfo.ManufactureInfo": string;
/**
* value: "ItemInfo.ProductInfo"
* @const
*/
"ItemInfo.ProductInfo": string;
/**
* value: "ItemInfo.TechnicalInfo"
* @const
*/
"ItemInfo.TechnicalInfo": string;
/**
* value: "ItemInfo.Title"
* @const
*/
"ItemInfo.Title": string;
/**
* value: "ItemInfo.TradeInInfo"
* @const
*/
"ItemInfo.TradeInInfo": string;
/**
* value: "Offers.Listings.Availability.MaxOrderQuantity"
* @const
*/
"Offers.Listings.Availability.MaxOrderQuantity": string;
/**
* value: "Offers.Listings.Availability.Message"
* @const
*/
"Offers.Listings.Availability.Message": string;
/**
* value: "Offers.Listings.Availability.MinOrderQuantity"
* @const
*/
"Offers.Listings.Availability.MinOrderQuantity": string;
/**
* value: "Offers.Listings.Availability.Type"
* @const
*/
"Offers.Listings.Availability.Type": string;
/**
* value: "Offers.Listings.Condition"
* @const
*/
"Offers.Listings.Condition": string;
/**
* value: "Offers.Listings.Condition.ConditionNote"
* @const
*/
"Offers.Listings.Condition.ConditionNote": string;
/**
* value: "Offers.Listings.Condition.SubCondition"
* @const
*/
"Offers.Listings.Condition.SubCondition": string;
/**
* value: "Offers.Listings.DeliveryInfo.IsAmazonFulfilled"
* @const
*/
"Offers.Listings.DeliveryInfo.IsAmazonFulfilled": string;
/**
* value: "Offers.Listings.DeliveryInfo.IsFreeShippingEligible"
* @const
*/
"Offers.Listings.DeliveryInfo.IsFreeShippingEligible": string;
/**
* value: "Offers.Listings.DeliveryInfo.IsPrimeEligible"
* @const
*/
"Offers.Listings.DeliveryInfo.IsPrimeEligible": string;
/**
* value: "Offers.Listings.DeliveryInfo.ShippingCharges"
* @const
*/
"Offers.Listings.DeliveryInfo.ShippingCharges": string;
/**
* value: "Offers.Listings.IsBuyBoxWinner"
* @const
*/
"Offers.Listings.IsBuyBoxWinner": string;
/**
* value: "Offers.Listings.LoyaltyPoints.Points"
* @const
*/
"Offers.Listings.LoyaltyPoints.Points": string;
/**
* value: "Offers.Listings.MerchantInfo"
* @const
*/
"Offers.Listings.MerchantInfo": string;
/**
* value: "Offers.Listings.Price"
* @const
*/
"Offers.Listings.Price": string;
/**
* value: "Offers.Listings.ProgramEligibility.IsPrimeExclusive"
* @const
*/
"Offers.Listings.ProgramEligibility.IsPrimeExclusive": string;
/**
* value: "Offers.Listings.ProgramEligibility.IsPrimePantry"
* @const
*/
"Offers.Listings.ProgramEligibility.IsPrimePantry": string;
/**
* value: "Offers.Listings.Promotions"
* @const
*/
"Offers.Listings.Promotions": string;
/**
* value: "Offers.Listings.SavingBasis"
* @const
*/
"Offers.Listings.SavingBasis": string;
/**
* value: "Offers.Summaries.HighestPrice"
* @const
*/
"Offers.Summaries.HighestPrice": string;
/**
* value: "Offers.Summaries.LowestPrice"
* @const
*/
"Offers.Summaries.LowestPrice": string;
/**
* value: "Offers.Summaries.OfferCount"
* @const
*/
"Offers.Summaries.OfferCount": string;
/**
* value: "ParentASIN"
* @const
*/
ParentASIN: string;
/**
* value: "RentalOffers.Listings.Availability.MaxOrderQuantity"
* @const
*/
"RentalOffers.Listings.Availability.MaxOrderQuantity": string;
/**
* value: "RentalOffers.Listings.Availability.Message"
* @const
*/
"RentalOffers.Listings.Availability.Message": string;
/**
* value: "RentalOffers.Listings.Availability.MinOrderQuantity"
* @const
*/
"RentalOffers.Listings.Availability.MinOrderQuantity": string;
/**
* value: "RentalOffers.Listings.Availability.Type"
* @const
*/
"RentalOffers.Listings.Availability.Type": string;
/**
* value: "RentalOffers.Listings.BasePrice"
* @const
*/
"RentalOffers.Listings.BasePrice": string;
/**
* value: "RentalOffers.Listings.Condition"
* @const
*/
"RentalOffers.Listings.Condition": string;
/**
* value: "RentalOffers.Listings.Condition.ConditionNote"
* @const
*/
"RentalOffers.Listings.Condition.ConditionNote": string;
/**
* value: "RentalOffers.Listings.Condition.SubCondition"
* @const
*/
"RentalOffers.Listings.Condition.SubCondition": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.IsAmazonFulfilled"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.IsAmazonFulfilled": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.IsFreeShippingEligible"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.IsFreeShippingEligible": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.IsPrimeEligible"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.IsPrimeEligible": string;
/**
* value: "RentalOffers.Listings.DeliveryInfo.ShippingCharges"
* @const
*/
"RentalOffers.Listings.DeliveryInfo.ShippingCharges": string;
/**
* value: "RentalOffers.Listings.MerchantInfo"
* @const
*/
"RentalOffers.Listings.MerchantInfo": string;
/**
* value: "SearchRefinements"
* @const
*/
SearchRefinements: string;
} | SearchItemsResource;
}