upstox-js-sdk/src/model/BatchExecutionSummary.js

The official Node Js client for communicating with the Upstox API

/*
 * OpenAPI definition
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: v0
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 *
 * Swagger Codegen version: 3.0.62
 *
 * Do not edit the class manually.
 *
 */
import {ApiClient} from '../ApiClient';

/**
 * The BatchExecutionSummary model module.
 * @module model/BatchExecutionSummary
 * @version v0
 */
export class BatchExecutionSummary {
  /**
   * Constructs a new <code>BatchExecutionSummary</code>.
   * Execution summary for cancel or exit order request
   * @alias module:model/BatchExecutionSummary
   * @class
   */
  constructor() {
  }

  /**
   * Constructs a <code>BatchExecutionSummary</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/BatchExecutionSummary} obj Optional instance to populate.
   * @return {module:model/BatchExecutionSummary} The populated <code>BatchExecutionSummary</code> instance.
   */
  static constructFromObject(data, obj) {
    if (data) {
      obj = obj || new BatchExecutionSummary();
      if (data.hasOwnProperty('total'))
        obj.total = ApiClient.convertToType(data['total'], 'Number');
      if (data.hasOwnProperty('success'))
        obj.success = ApiClient.convertToType(data['success'], 'Number');
      if (data.hasOwnProperty('error'))
        obj.error = ApiClient.convertToType(data['error'], 'Number');
    }
    return obj;
  }
}

/**
 * The total number of order lines present in the payload.
 * @member {Number} total
 */
BatchExecutionSummary.prototype.total = undefined;

/**
 * The number of order lines that were successfully placed without any errors.
 * @member {Number} success
 */
BatchExecutionSummary.prototype.success = undefined;

/**
 * The number of order lines that encountered errors during processing, despite their payloads being valid.
 * @member {Number} error
 */
BatchExecutionSummary.prototype.error = undefined;