amazon-pa-api5-node-ts/src/model/GetItemsRequest.mts

ProductAdvertisingAPI 5.0 NodeJS SDK rewritten in 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
 *
 */

/**
 * The GetItemsRequest model module.
 * @module model/GetItemsRequest
 * @version 1.0.0
 */

import { ApiClient } from "../ApiClient.mjs";
import { Condition } from "./Condition.mjs";
import { GetItemsResource } from "./GetItemsResource.mjs";
import { ItemIdType } from "./ItemIdType.mjs";
import { Marketplace } from "./Marketplace.mjs";
import { Merchant } from "./Merchant.mjs";
import { OfferCount } from "./OfferCount.mjs";
import { PartnerType } from "./PartnerType.mjs";
import { Properties } from "./Properties.mjs";

/**
 * Constructs a new <code>GetItemsRequest</code>.
 * @alias module:model/GetItemsRequest
 * @class
 * @param itemIds {Array.<String>} 
 * @param partnerTag {String} 
 * @param partnerType {module:model/PartnerType} 
 */
export class GetItemsRequest {
  /**
   * @member {module:model/Condition} Condition
   */
  public Condition?: Condition;
  /**
   * @member {String} CurrencyOfPreference
   */
  public CurrencyOfPreference?: string;
  /**
   * @member {Array.<String>} ItemIds
   */
  public ItemIds?: string[];
  /**
   * @member {module:model/ItemIdType} ItemIdType|string
   */
  public ItemIdType?: ItemIdType|string;
  /**
   * @member {Array.<String>} LanguagesOfPreference
   */
  public LanguagesOfPreference?: string[];
  /**
   * When specifying a string literal, use the correct URL from https://webservices.amazon.com/paapi5/documentation/locale-reference.html.
   * Otherwise refer to the values in MarketplaceValues.
   * @member {String} Marketplace|string
   */
  public Marketplace?: Marketplace|string;
  /**
   * @member {module:model/Merchant} Merchant
   */
  public Merchant?: Merchant;
  /**
   * @member {module:model/OfferCount} OfferCount
   */
  public OfferCount?: OfferCount;
  /**
   * @member {String} PartnerTag
   */
  public PartnerTag?: string;
  /**
   * @member {module:model/PartnerType} PartnerType
   */
  public PartnerType?: PartnerType;
  /**
   * @member {module:model/Properties} Properties
   */
  public Properties?: Properties;
  /**
   * @member {Array.<module:model/GetItemsResource>} Resources
   */
  public Resources?: GetItemsResource[]|string[];

  // not sure if this is ever relevant:
  // public constructor(itemIds, partnerTag, partnerType) {
  //   this.ItemIds = itemIds;
  //   this.PartnerTag = partnerTag;
  //   this.PartnerType = partnerType;
  // };

  /**
   * Constructs a <code>GetItemsRequest</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/GetItemsRequest} obj Optional instance to populate.
   * @return {module:model/GetItemsRequest} The populated <code>GetItemsRequest</code> instance.
   */
  public static constructFromObject(data: any, obj?: GetItemsRequest) {
    if (data) {
      obj = obj || new GetItemsRequest();

      if (data.hasOwnProperty('Condition')) {
        obj.Condition = Condition.constructFromObject(data['Condition']);
      }
      if (data.hasOwnProperty('CurrencyOfPreference')) {
        obj.CurrencyOfPreference = ApiClient.convertToType(data['CurrencyOfPreference'], 'String');
      }
      if (data.hasOwnProperty('ItemIds')) {
        obj.ItemIds = ApiClient.convertToType(data['ItemIds'], ['String']);
      }
      if (data.hasOwnProperty('ItemIdType')) {
        obj.ItemIdType = ItemIdType.constructFromObject(data['ItemIdType']);
      }
      if (data.hasOwnProperty('LanguagesOfPreference')) {
        obj.LanguagesOfPreference = ApiClient.convertToType(data['LanguagesOfPreference'], ['String']);
      }
      if (data.hasOwnProperty('Marketplace')) {
        obj.Marketplace = ApiClient.convertToType(data['Marketplace'], 'String');
      }
      if (data.hasOwnProperty('Merchant')) {
        obj.Merchant = Merchant.constructFromObject(data['Merchant']);
      }
      if (data.hasOwnProperty('OfferCount')) {
        obj.OfferCount = OfferCount.constructFromObject(data['OfferCount']);
      }
      if (data.hasOwnProperty('PartnerTag')) {
        obj.PartnerTag = ApiClient.convertToType(data['PartnerTag'], 'String');
      }
      if (data.hasOwnProperty('PartnerType')) {
        obj.PartnerType = PartnerType.constructFromObject(data['PartnerType']);
      }
      if (data.hasOwnProperty('Properties')) {
        obj.Properties = Properties.constructFromObject(data['Properties']);
      }
      if (data.hasOwnProperty('Resources')) {
        obj.Resources = ApiClient.convertToType(data['Resources'], [GetItemsResource]);
      }
    }
    return obj;
  }
};