amazon-creators-api 1.2.0

package/dist/model/SearchItemsRequestContent.js

@@ -0,0 +1,343 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _Availability = _interopRequireDefault(require("./Availability"));
+var _Condition = _interopRequireDefault(require("./Condition"));
+var _DeliveryFlag = _interopRequireDefault(require("./DeliveryFlag"));
+var _SearchItemsResource = _interopRequireDefault(require("./SearchItemsResource"));
+var _SortBy = _interopRequireDefault(require("./SortBy"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Copyright 2025 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.
+ */
+/**
+ * The SearchItemsRequestContent model module.
+ * @module model/SearchItemsRequestContent
+ * @version 1.0.0
+ */
+var SearchItemsRequestContent = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>SearchItemsRequestContent</code>.
+   * The request object for the search items operation. It contains the request parameters for the search items operation.
+   * @alias module:model/SearchItemsRequestContent
+   */
+  function SearchItemsRequestContent() {
+    _classCallCheck(this, SearchItemsRequestContent);
+    SearchItemsRequestContent.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(SearchItemsRequestContent, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>SearchItemsRequestContent</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/SearchItemsRequestContent} obj Optional instance to populate.
+     * @return {module:model/SearchItemsRequestContent} The populated <code>SearchItemsRequestContent</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new SearchItemsRequestContent();
+        if (data.hasOwnProperty('actor')) {
+          obj['actor'] = _ApiClient["default"].convertToType(data['actor'], 'String');
+        }
+        if (data.hasOwnProperty('artist')) {
+          obj['artist'] = _ApiClient["default"].convertToType(data['artist'], 'String');
+        }
+        if (data.hasOwnProperty('author')) {
+          obj['author'] = _ApiClient["default"].convertToType(data['author'], 'String');
+        }
+        if (data.hasOwnProperty('availability')) {
+          obj['availability'] = _Availability["default"].constructFromObject(data['availability']);
+        }
+        if (data.hasOwnProperty('brand')) {
+          obj['brand'] = _ApiClient["default"].convertToType(data['brand'], 'String');
+        }
+        if (data.hasOwnProperty('browseNodeId')) {
+          obj['browseNodeId'] = _ApiClient["default"].convertToType(data['browseNodeId'], 'String');
+        }
+        if (data.hasOwnProperty('condition')) {
+          obj['condition'] = _Condition["default"].constructFromObject(data['condition']);
+        }
+        if (data.hasOwnProperty('currencyOfPreference')) {
+          obj['currencyOfPreference'] = _ApiClient["default"].convertToType(data['currencyOfPreference'], 'String');
+        }
+        if (data.hasOwnProperty('deliveryFlags')) {
+          obj['deliveryFlags'] = _ApiClient["default"].convertToType(data['deliveryFlags'], [_DeliveryFlag["default"]]);
+        }
+        if (data.hasOwnProperty('itemCount')) {
+          obj['itemCount'] = _ApiClient["default"].convertToType(data['itemCount'], 'Number');
+        }
+        if (data.hasOwnProperty('itemPage')) {
+          obj['itemPage'] = _ApiClient["default"].convertToType(data['itemPage'], 'Number');
+        }
+        if (data.hasOwnProperty('keywords')) {
+          obj['keywords'] = _ApiClient["default"].convertToType(data['keywords'], 'String');
+        }
+        if (data.hasOwnProperty('languagesOfPreference')) {
+          obj['languagesOfPreference'] = _ApiClient["default"].convertToType(data['languagesOfPreference'], ['String']);
+        }
+        if (data.hasOwnProperty('maxPrice')) {
+          obj['maxPrice'] = _ApiClient["default"].convertToType(data['maxPrice'], 'Number');
+        }
+        if (data.hasOwnProperty('minPrice')) {
+          obj['minPrice'] = _ApiClient["default"].convertToType(data['minPrice'], 'Number');
+        }
+        if (data.hasOwnProperty('minReviewsRating')) {
+          obj['minReviewsRating'] = _ApiClient["default"].convertToType(data['minReviewsRating'], 'Number');
+        }
+        if (data.hasOwnProperty('minSavingPercent')) {
+          obj['minSavingPercent'] = _ApiClient["default"].convertToType(data['minSavingPercent'], 'Number');
+        }
+        if (data.hasOwnProperty('partnerTag')) {
+          obj['partnerTag'] = _ApiClient["default"].convertToType(data['partnerTag'], 'String');
+        }
+        if (data.hasOwnProperty('properties')) {
+          obj['properties'] = _ApiClient["default"].convertToType(data['properties'], {
+            'String': 'String'
+          });
+        }
+        if (data.hasOwnProperty('resources')) {
+          obj['resources'] = _ApiClient["default"].convertToType(data['resources'], [_SearchItemsResource["default"]]);
+        }
+        if (data.hasOwnProperty('searchIndex')) {
+          obj['searchIndex'] = _ApiClient["default"].convertToType(data['searchIndex'], 'String');
+        }
+        if (data.hasOwnProperty('sortBy')) {
+          obj['sortBy'] = _SortBy["default"].constructFromObject(data['sortBy']);
+        }
+        if (data.hasOwnProperty('title')) {
+          obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>SearchItemsRequestContent</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SearchItemsRequestContent</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['actor'] && !(typeof data['actor'] === 'string' || data['actor'] instanceof String)) {
+        throw new Error("Expected the field `actor` to be a primitive type in the JSON string but got " + data['actor']);
+      }
+      // ensure the json data is a string
+      if (data['artist'] && !(typeof data['artist'] === 'string' || data['artist'] instanceof String)) {
+        throw new Error("Expected the field `artist` to be a primitive type in the JSON string but got " + data['artist']);
+      }
+      // ensure the json data is a string
+      if (data['author'] && !(typeof data['author'] === 'string' || data['author'] instanceof String)) {
+        throw new Error("Expected the field `author` to be a primitive type in the JSON string but got " + data['author']);
+      }
+      // ensure the json data is a string
+      if (data['brand'] && !(typeof data['brand'] === 'string' || data['brand'] instanceof String)) {
+        throw new Error("Expected the field `brand` to be a primitive type in the JSON string but got " + data['brand']);
+      }
+      // ensure the json data is a string
+      if (data['browseNodeId'] && !(typeof data['browseNodeId'] === 'string' || data['browseNodeId'] instanceof String)) {
+        throw new Error("Expected the field `browseNodeId` to be a primitive type in the JSON string but got " + data['browseNodeId']);
+      }
+      // ensure the json data is a string
+      if (data['currencyOfPreference'] && !(typeof data['currencyOfPreference'] === 'string' || data['currencyOfPreference'] instanceof String)) {
+        throw new Error("Expected the field `currencyOfPreference` to be a primitive type in the JSON string but got " + data['currencyOfPreference']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['deliveryFlags'])) {
+        throw new Error("Expected the field `deliveryFlags` to be an array in the JSON data but got " + data['deliveryFlags']);
+      }
+      // ensure the json data is a string
+      if (data['keywords'] && !(typeof data['keywords'] === 'string' || data['keywords'] instanceof String)) {
+        throw new Error("Expected the field `keywords` to be a primitive type in the JSON string but got " + data['keywords']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['languagesOfPreference'])) {
+        throw new Error("Expected the field `languagesOfPreference` to be an array in the JSON data but got " + data['languagesOfPreference']);
+      }
+      // ensure the json data is a string
+      if (data['partnerTag'] && !(typeof data['partnerTag'] === 'string' || data['partnerTag'] instanceof String)) {
+        throw new Error("Expected the field `partnerTag` to be a primitive type in the JSON string but got " + data['partnerTag']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['resources'])) {
+        throw new Error("Expected the field `resources` to be an array in the JSON data but got " + data['resources']);
+      }
+      // ensure the json data is a string
+      if (data['searchIndex'] && !(typeof data['searchIndex'] === 'string' || data['searchIndex'] instanceof String)) {
+        throw new Error("Expected the field `searchIndex` to be a primitive type in the JSON string but got " + data['searchIndex']);
+      }
+      // ensure the json data is a string
+      if (data['title'] && !(typeof data['title'] === 'string' || data['title'] instanceof String)) {
+        throw new Error("Expected the field `title` to be a primitive type in the JSON string but got " + data['title']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Actor name associated with the item. You can enter all or part of the name.
+ * @member {String} actor
+ */
+SearchItemsRequestContent.prototype['actor'] = undefined;
+
+/**
+ * Artist name associated with the item. You can enter all or part of the name.
+ * @member {String} artist
+ */
+SearchItemsRequestContent.prototype['artist'] = undefined;
+
+/**
+ * Author name associated with the item. You can enter all or part of the name.
+ * @member {String} author
+ */
+SearchItemsRequestContent.prototype['author'] = undefined;
+
+/**
+ * @member {module:model/Availability} availability
+ */
+SearchItemsRequestContent.prototype['availability'] = undefined;
+
+/**
+ * Brand name associated with the item. You can enter all or part of the name.
+ * @member {String} brand
+ */
+SearchItemsRequestContent.prototype['brand'] = undefined;
+
+/**
+ * A unique ID assigned by Amazon that identifies a product category/sub-category. The BrowseNodeId is a positive Long having max value upto Long.MAX_VALUE i.e. 9223372036854775807 (inclusive).
+ * @member {String} browseNodeId
+ */
+SearchItemsRequestContent.prototype['browseNodeId'] = undefined;
+
+/**
+ * @member {module:model/Condition} condition
+ */
+SearchItemsRequestContent.prototype['condition'] = undefined;
+
+/**
+ * Currency of preference in which the prices information should be returned in response. By default the prices are returned in the default currency of the marketplace. Expected currency code format is the ISO 4217 currency code (i.e. USD, EUR etc.).
+ * @member {String} currencyOfPreference
+ */
+SearchItemsRequestContent.prototype['currencyOfPreference'] = undefined;
+
+/**
+ * List of DeliveryFlag which denotes a certain delivery program.
+ * @member {Array.<module:model/DeliveryFlag>} deliveryFlags
+ */
+SearchItemsRequestContent.prototype['deliveryFlags'] = undefined;
+
+/**
+ * The number of items desired in SearchItems response.
+ * @member {Number} itemCount
+ */
+SearchItemsRequestContent.prototype['itemCount'] = undefined;
+
+/**
+ * The specific page of items to be returned from the available Search Results.
+ * @member {Number} itemPage
+ */
+SearchItemsRequestContent.prototype['itemPage'] = undefined;
+
+/**
+ * A word or phrase that describes an item i.e. the search query.
+ * @member {String} keywords
+ */
+SearchItemsRequestContent.prototype['keywords'] = undefined;
+
+/**
+ * Languages in order of preference in which the item information should be returned in response. By default the item information is returned in the default language of the marketplace.
+ * @member {Array.<String>} languagesOfPreference
+ */
+SearchItemsRequestContent.prototype['languagesOfPreference'] = undefined;
+
+/**
+ * The MaxPrice parameter filters search results to items with at least one offer price below the specified value.
+ * @member {Number} maxPrice
+ */
+SearchItemsRequestContent.prototype['maxPrice'] = undefined;
+
+/**
+ * The MinPrice parameter filters search results to items with at least one offer price above the specified value.
+ * @member {Number} minPrice
+ */
+SearchItemsRequestContent.prototype['minPrice'] = undefined;
+
+/**
+ * The MinReviewsRating parameter filters search results to items with customer review ratings above specified value.
+ * @member {Number} minReviewsRating
+ */
+SearchItemsRequestContent.prototype['minReviewsRating'] = undefined;
+
+/**
+ * The MinSavingPercent parameter filters search results to items with at least one offer having saving percentage above the specified value.
+ * @member {Number} minSavingPercent
+ */
+SearchItemsRequestContent.prototype['minSavingPercent'] = undefined;
+
+/**
+ * An alphanumeric token that uniquely identifies a partner. If the value of PartnerType is Associates, enter your Store Id or tracking ID.
+ * @member {String} partnerTag
+ */
+SearchItemsRequestContent.prototype['partnerTag'] = undefined;
+
+/**
+ * Reserved parameter for specifying key-value pairs. This is a flexible mechanism for passing additional context or metadata to the API.
+ * @member {Object.<String, String>} properties
+ */
+SearchItemsRequestContent.prototype['properties'] = undefined;
+
+/**
+ * List of resources for SearchItems operation which specify the values to return.
+ * @member {Array.<module:model/SearchItemsResource>} resources
+ */
+SearchItemsRequestContent.prototype['resources'] = undefined;
+
+/**
+ * Indicates the product category to search. SearchIndex values differ by marketplace.
+ * @member {String} searchIndex
+ */
+SearchItemsRequestContent.prototype['searchIndex'] = undefined;
+
+/**
+ * @member {module:model/SortBy} sortBy
+ */
+SearchItemsRequestContent.prototype['sortBy'] = undefined;
+
+/**
+ * Title associated with the item.
+ * @member {String} title
+ */
+SearchItemsRequestContent.prototype['title'] = undefined;
+var _default = exports["default"] = SearchItemsRequestContent;

package/dist/model/SearchItemsResource.d.ts

@@ -0,0 +1,192 @@
+/**
+* Enum class SearchItemsResource.
+* @enum {}
+* @readonly
+*/
+export default class SearchItemsResource {
+    /**
+    * 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: any): SearchItemsResource;
+    /**
+     * 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: "offersV2.listings.availability"
+     * @const
+     */
+    "offersV2.listings.availability": string;
+    /**
+     * value: "offersV2.listings.condition"
+     * @const
+     */
+    "offersV2.listings.condition": string;
+    /**
+     * value: "offersV2.listings.dealDetails"
+     * @const
+     */
+    "offersV2.listings.dealDetails": string;
+    /**
+     * value: "offersV2.listings.isBuyBoxWinner"
+     * @const
+     */
+    "offersV2.listings.isBuyBoxWinner": string;
+    /**
+     * value: "offersV2.listings.loyaltyPoints"
+     * @const
+     */
+    "offersV2.listings.loyaltyPoints": string;
+    /**
+     * value: "offersV2.listings.merchantInfo"
+     * @const
+     */
+    "offersV2.listings.merchantInfo": string;
+    /**
+     * value: "offersV2.listings.price"
+     * @const
+     */
+    "offersV2.listings.price": string;
+    /**
+     * value: "offersV2.listings.type"
+     * @const
+     */
+    "offersV2.listings.type": string;
+    /**
+     * value: "parentASIN"
+     * @const
+     */
+    parentASIN: 'parentASIN';
+    /**
+     * value: "searchRefinements"
+     * @const
+     */
+    searchRefinements: 'searchRefinements';
+}
+/**
+ * *
+ */
+export type SearchItemsResource = 'browseNodeInfo.browseNodes' | 'browseNodeInfo.browseNodes.ancestor' | 'browseNodeInfo.browseNodes.salesRank' | 'browseNodeInfo.websiteSalesRank' | 'customerReviews.count' | 'customerReviews.starRating' | 'images.primary.small' | 'images.primary.medium' | 'images.primary.large' | 'images.primary.highRes' | 'images.variants.small' | 'images.variants.medium' | 'images.variants.large' | 'images.variants.highRes' | 'itemInfo.byLineInfo' | 'itemInfo.contentInfo' | 'itemInfo.contentRating' | 'itemInfo.classifications' | 'itemInfo.externalIds' | 'itemInfo.features' | 'itemInfo.manufactureInfo' | 'itemInfo.productInfo' | 'itemInfo.technicalInfo' | 'itemInfo.title' | 'itemInfo.tradeInInfo' | 'offersV2.listings.availability' | 'offersV2.listings.condition' | 'offersV2.listings.dealDetails' | 'offersV2.listings.isBuyBoxWinner' | 'offersV2.listings.loyaltyPoints' | 'offersV2.listings.merchantInfo' | 'offersV2.listings.price' | 'offersV2.listings.type' | 'parentASIN' | 'searchRefinements';