Source: models/ProductItem.js

  1. /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
  2. /* Copyright (c) 2020 Mobify Research & Development Inc. All rights reserved. */
  3. /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
  5. /**
  6.  * Shop API
  7.  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
  8.  *
  9.  * OpenAPI spec version: 20.4
  10.  *
  11.  *
  12.  * NOTE: This class is auto generated by the swagger code generator program.
  13.  * https://github.com/swagger-api/swagger-codegen.git
  14.  * Do not edit the class manually.
  15.  *
  16.  */
  19. import ApiClient from '../ApiClient'
  20. import OptionItem from './OptionItem'
  21. import PriceAdjustment from './PriceAdjustment'
  22. import ProductListItemReference from './ProductListItemReference'
  28. /**
  29. * The ProductItem model module.
  30. * @module models/ProductItem
  31. * @version 20.4
  32. */
  33. export default class ProductItem {
  34.     /**
  35.     * Constructs a new <code>ProductItem</code>.
  36.     * Document representing a product item.
  37.     * @alias module:models/ProductItem
  38.     * @class
  39.     * @param quantity {Number} The quantity of the products represented by this item.
  40.     */
  42.     constructor(quantity) {
  48.         this.quantity = quantity
  51.     }
  53.     /**
  54.     * Constructs a <code>ProductItem</code> from a plain JavaScript object, optionally creating a new instance.
  55.     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
  56.     * @param {Object} data The plain JavaScript object bearing properties of interest.
  57.     * @param {module:models/ProductItem} obj Optional instance to populate.
  58.     * @return {module:models/ProductItem} The populated <code>ProductItem</code> instance.
  59.     */
  60.     static constructFromObject(data, obj) {
  61.         if (data) {
  62.             obj = obj || new ProductItem()
  68.             if (data.hasOwnProperty('adjusted_tax')) {
  69.                 obj.adjusted_tax = ApiClient.convertToType(data.adjusted_tax, 'Number')
  70.             }
  71.             if (data.hasOwnProperty('base_price')) {
  72.                 obj.base_price = ApiClient.convertToType(data.base_price, 'Number')
  73.             }
  74.             if (data.hasOwnProperty('bonus_discount_line_item_id')) {
  75.                 obj.bonus_discount_line_item_id = ApiClient.convertToType(data.bonus_discount_line_item_id, 'String')
  76.             }
  77.             if (data.hasOwnProperty('bonus_product_line_item')) {
  78.                 obj.bonus_product_line_item = ApiClient.convertToType(data.bonus_product_line_item, 'Boolean')
  79.             }
  80.             if (data.hasOwnProperty('bundled_product_items')) {
  81.                 obj.bundled_product_items = ApiClient.convertToType(data.bundled_product_items, [ProductItem])
  82.             }
  83.             if (data.hasOwnProperty('c_fromStoreId')) {
  84.                 obj.c_fromStoreId = ApiClient.convertToType(data.c_fromStoreId, 'String')
  85.             }
  86.             if (data.hasOwnProperty('gift')) {
  87.                 obj.gift = ApiClient.convertToType(data.gift, 'Boolean')
  88.             }
  89.             if (data.hasOwnProperty('gift_message')) {
  90.                 obj.gift_message = ApiClient.convertToType(data.gift_message, 'String')
  91.             }
  92.             if (data.hasOwnProperty('inventory_id')) {
  93.                 obj.inventory_id = ApiClient.convertToType(data.inventory_id, 'String')
  94.             }
  95.             if (data.hasOwnProperty('item_id')) {
  96.                 obj.item_id = ApiClient.convertToType(data.item_id, 'String')
  97.             }
  98.             if (data.hasOwnProperty('item_text')) {
  99.                 obj.item_text = ApiClient.convertToType(data.item_text, 'String')
  100.             }
  101.             if (data.hasOwnProperty('option_items')) {
  102.                 obj.option_items = ApiClient.convertToType(data.option_items, [OptionItem])
  103.             }
  104.             if (data.hasOwnProperty('price')) {
  105.                 obj.price = ApiClient.convertToType(data.price, 'Number')
  106.             }
  107.             if (data.hasOwnProperty('price_adjustments')) {
  108.                 obj.price_adjustments = ApiClient.convertToType(data.price_adjustments, [PriceAdjustment])
  109.             }
  110.             if (data.hasOwnProperty('price_after_item_discount')) {
  111.                 obj.price_after_item_discount = ApiClient.convertToType(data.price_after_item_discount, 'Number')
  112.             }
  113.             if (data.hasOwnProperty('price_after_order_discount')) {
  114.                 obj.price_after_order_discount = ApiClient.convertToType(data.price_after_order_discount, 'Number')
  115.             }
  116.             if (data.hasOwnProperty('product_id')) {
  117.                 obj.product_id = ApiClient.convertToType(data.product_id, 'String')
  118.             }
  119.             if (data.hasOwnProperty('product_list_item')) {
  120.                 obj.product_list_item = ProductListItemReference.constructFromObject(data.product_list_item)
  121.             }
  122.             if (data.hasOwnProperty('product_name')) {
  123.                 obj.product_name = ApiClient.convertToType(data.product_name, 'String')
  124.             }
  125.             if (data.hasOwnProperty('quantity')) {
  126.                 obj.quantity = ApiClient.convertToType(data.quantity, 'Number')
  127.             }
  128.             if (data.hasOwnProperty('shipment_id')) {
  129.                 obj.shipment_id = ApiClient.convertToType(data.shipment_id, 'String')
  130.             }
  131.             if (data.hasOwnProperty('shipping_item_id')) {
  132.                 obj.shipping_item_id = ApiClient.convertToType(data.shipping_item_id, 'String')
  133.             }
  134.             if (data.hasOwnProperty('tax')) {
  135.                 obj.tax = ApiClient.convertToType(data.tax, 'Number')
  136.             }
  137.             if (data.hasOwnProperty('tax_basis')) {
  138.                 obj.tax_basis = ApiClient.convertToType(data.tax_basis, 'Number')
  139.             }
  140.             if (data.hasOwnProperty('tax_class_id')) {
  141.                 obj.tax_class_id = ApiClient.convertToType(data.tax_class_id, 'String')
  142.             }
  143.             if (data.hasOwnProperty('tax_rate')) {
  144.                 obj.tax_rate = ApiClient.convertToType(data.tax_rate, 'Number')
  145.             }
  146.         }
  147.         return obj
  148.     }
  150.     /**
  151.     * The tax of the product item after adjustments applying.
  152.     * @member {Number} adjusted_tax
  153.     */
  154.     adjusted_tax = undefined;
  155.     /**
  156.     * The base price for the line item, which is the  price of the unit before applying adjustments, in the purchase  currency. The base price may be net or gross of tax depending  on the configured taxation policy.
  157.     * @member {Number} base_price
  158.     */
  159.     base_price = undefined;
  160.     /**
  161.     * The id of the bonus discount line item this bonus product relates to.
  162.     * @member {String} bonus_discount_line_item_id
  163.     */
  164.     bonus_discount_line_item_id = undefined;
  165.     /**
  166.     * A flag indicating whether the product item is a bonus.
  167.     * @member {Boolean} bonus_product_line_item
  168.     */
  169.     bonus_product_line_item = undefined;
  170.     /**
  171.     * The array of bundled product items. Can be empty.
  172.     * @member {Array.<module:models/ProductItem>} bundled_product_items
  173.     */
  174.     bundled_product_items = undefined;
  175.     /**
  176.     * Links the store to the product line item for grouping shipments in the checkout process.
  177.     * @member {String} c_fromStoreId
  178.     */
  179.     c_fromStoreId = undefined;
  180.     /**
  181.     * Returns true if the item is a gift.
  182.     * @member {Boolean} gift
  183.     */
  184.     gift = undefined;
  185.     /**
  186.     * The gift message.
  187.     * @member {String} gift_message
  188.     */
  189.     gift_message = undefined;
  190.     /**
  191.     * The inventory list id associated with this item.
  192.     * @member {String} inventory_id
  193.     */
  194.     inventory_id = undefined;
  195.     /**
  196.     * The item identifier. Use this to identify an item when updating the item quantity or creating a custom price  adjustment for an item.
  197.     * @member {String} item_id
  198.     */
  199.     item_id = undefined;
  200.     /**
  201.     * The text describing the item in more detail.
  202.     * @member {String} item_text
  203.     */
  204.     item_text = undefined;
  205.     /**
  206.     * The array of option items. This array can be empty.
  207.     * @member {Array.<module:models/OptionItem>} option_items
  208.     */
  209.     option_items = undefined;
  210.     /**
  211.     * The price of the line item before applying any adjustments. If the line item is based on net pricing  then the net price is returned. If the line item is based on gross  pricing then the gross price is returned.
  212.     * @member {Number} price
  213.     */
  214.     price = undefined;
  215.     /**
  216.     * Array of price adjustments. Can be empty.
  217.     * @member {Array.<module:models/PriceAdjustment>} price_adjustments
  218.     */
  219.     price_adjustments = undefined;
  220.     /**
  221.     * The price of the product line item after applying all product-level  adjustments. For net pricing the adjusted net price is returned. For gross pricing, the adjusted  gross price is returned.
  222.     * @member {Number} price_after_item_discount
  223.     */
  224.     price_after_item_discount = undefined;
  225.     /**
  226.     * The price of this product line item after considering all  dependent price adjustments and prorating all order-level  price adjustments. For net pricing the net price is returned. For gross  pricing, the gross price is returned.
  227.     * @member {Number} price_after_order_discount
  228.     */
  229.     price_after_order_discount = undefined;
  230.     /**
  231.     *
  232.     * @member {String} product_id
  233.     */
  234.     product_id = undefined;
  235.     /**
  236.     *
  237.     * @member {module:models/ProductListItemReference} product_list_item
  238.     */
  239.     product_list_item = undefined;
  240.     /**
  241.     * The name of the product.
  242.     * @member {String} product_name
  243.     */
  244.     product_name = undefined;
  245.     /**
  246.     * The quantity of the products represented by this item.
  247.     * @member {Number} quantity
  248.     */
  249.     quantity = undefined;
  250.     /**
  251.     * The id of the shipment which includes the product item.
  252.     * @member {String} shipment_id
  253.     */
  254.     shipment_id = undefined;
  255.     /**
  256.     * The reference to the related shipping item if it exists. This is the case if for example when a surcharge is  defined for individual products using a particular a shipping method.
  257.     * @member {String} shipping_item_id
  258.     */
  259.     shipping_item_id = undefined;
  260.     /**
  261.     * The tax of the product item before adjustments applying.
  262.     * @member {Number} tax
  263.     */
  264.     tax = undefined;
  265.     /**
  266.     * The price used to calculate the tax for this product item.
  267.     * @member {Number} tax_basis
  268.     */
  269.     tax_basis = undefined;
  270.     /**
  271.     * The tax class ID for the product item or null  if no tax class ID is associated with the product item.
  272.     * @member {String} tax_class_id
  273.     */
  274.     tax_class_id = undefined;
  275.     /**
  276.     * The tax rate, which is the decimal tax rate to be applied  to the product represented by this item.
  277.     * @member {Number} tax_rate
  278.     */
  279.     tax_rate = undefined;
  288. }