xi_sdk_resellers/dist/model/OrderCreateRequestShipmentDetails.js

Ingram Micro - Xvantage Integration (XI) Node.Js Server-side SDK.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
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); } /**
 * XI Sdk Resellers
 * For Resellers seeking to innovate with Ingram Micro's API solutions, automate your eCommerce experience with our array of API's and webhooks to craft a seamless journey for your customers.
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 *
 */
/**
 * The OrderCreateRequestShipmentDetails model module.
 * @module model/OrderCreateRequestShipmentDetails
 * @version 1.0.0
 */
var OrderCreateRequestShipmentDetails = /*#__PURE__*/function () {
  /**
   * Constructs a new <code>OrderCreateRequestShipmentDetails</code>.
   * Shipping details for the order provided by the customer.
   * @alias module:model/OrderCreateRequestShipmentDetails
   */
  function OrderCreateRequestShipmentDetails() {
    _classCallCheck(this, OrderCreateRequestShipmentDetails);
    OrderCreateRequestShipmentDetails.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(OrderCreateRequestShipmentDetails, null, [{
    key: "initialize",
    value: function initialize(obj) {}

    /**
     * Constructs a <code>OrderCreateRequestShipmentDetails</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/OrderCreateRequestShipmentDetails} obj Optional instance to populate.
     * @return {module:model/OrderCreateRequestShipmentDetails} The populated <code>OrderCreateRequestShipmentDetails</code> instance.
     */
  }, {
    key: "constructFromObject",
    value: function constructFromObject(data, obj) {
      if (data) {
        obj = obj || new OrderCreateRequestShipmentDetails();
        if (data.hasOwnProperty('carrierCode')) {
          obj['carrierCode'] = _ApiClient["default"].convertToType(data['carrierCode'], 'String');
        }
        if (data.hasOwnProperty('freightAccountNumber')) {
          obj['freightAccountNumber'] = _ApiClient["default"].convertToType(data['freightAccountNumber'], 'String');
        }
        if (data.hasOwnProperty('shipComplete')) {
          obj['shipComplete'] = _ApiClient["default"].convertToType(data['shipComplete'], 'String');
        }
        if (data.hasOwnProperty('requestedDeliveryDate')) {
          obj['requestedDeliveryDate'] = _ApiClient["default"].convertToType(data['requestedDeliveryDate'], 'Date');
        }
        if (data.hasOwnProperty('signatureRequired')) {
          obj['signatureRequired'] = _ApiClient["default"].convertToType(data['signatureRequired'], 'Boolean');
        }
        if (data.hasOwnProperty('shippingInstructions')) {
          obj['shippingInstructions'] = _ApiClient["default"].convertToType(data['shippingInstructions'], 'String');
        }
      }
      return obj;
    }

    /**
     * Validates the JSON data with respect to <code>OrderCreateRequestShipmentDetails</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>OrderCreateRequestShipmentDetails</code>.
     */
  }, {
    key: "validateJSON",
    value: function validateJSON(data) {
      // ensure the json data is a string
      if (data['carrierCode'] && !(typeof data['carrierCode'] === 'string' || data['carrierCode'] instanceof String)) {
        throw new Error("Expected the field `carrierCode` to be a primitive type in the JSON string but got " + data['carrierCode']);
      }
      // ensure the json data is a string
      if (data['freightAccountNumber'] && !(typeof data['freightAccountNumber'] === 'string' || data['freightAccountNumber'] instanceof String)) {
        throw new Error("Expected the field `freightAccountNumber` to be a primitive type in the JSON string but got " + data['freightAccountNumber']);
      }
      // ensure the json data is a string
      if (data['shipComplete'] && !(typeof data['shipComplete'] === 'string' || data['shipComplete'] instanceof String)) {
        throw new Error("Expected the field `shipComplete` to be a primitive type in the JSON string but got " + data['shipComplete']);
      }
      // ensure the json data is a string
      if (data['shippingInstructions'] && !(typeof data['shippingInstructions'] === 'string' || data['shippingInstructions'] instanceof String)) {
        throw new Error("Expected the field `shippingInstructions` to be a primitive type in the JSON string but got " + data['shippingInstructions']);
      }
      return true;
    }
  }]);
}();
/**
 * The code for the shipping carrier for the line item.
 * @member {String} carrierCode
 */
OrderCreateRequestShipmentDetails.prototype['carrierCode'] = undefined;

/**
 * The reseller 's shipping account number with carrier. Used to bill the shipping carrier directly from the reseller's account with the carrier.
 * @member {String} freightAccountNumber
 */
OrderCreateRequestShipmentDetails.prototype['freightAccountNumber'] = undefined;

/**
 * Specifies whether the shipment will be shipped only when all products are fulfilled. The value of this field along with acceptBackOrder field decides the value of backorderflag. If this field is set, acceptBackOrder field is ignored. Possible values for this field are true, C, P, E.    With value as true or C, backorderflag will be set as C.    With value as P, or E, backorderflag will be set as P or E respectively.    C = Ship complete at distribution level.    P = ship complete at line level.    E = ship complete across all distributions. 
 * @member {String} shipComplete
 */
OrderCreateRequestShipmentDetails.prototype['shipComplete'] = undefined;

/**
 * The reseller-requested delivery date in UTC format. Delivery date is not guaranteed.
 * @member {Date} requestedDeliveryDate
 */
OrderCreateRequestShipmentDetails.prototype['requestedDeliveryDate'] = undefined;

/**
 * Specifies whether a signature is required for delivery. Default is False.
 * @member {Boolean} signatureRequired
 */
OrderCreateRequestShipmentDetails.prototype['signatureRequired'] = undefined;

/**
 * @member {String} shippingInstructions
 */
OrderCreateRequestShipmentDetails.prototype['shippingInstructions'] = undefined;
var _default = exports["default"] = OrderCreateRequestShipmentDetails;