zuora-sdk-js 3.8.0 → 3.9.0-beta.2

package/src/zuora_api/model/UpsertCreateCommitmentInputAllOfSegments.js

@@ -0,0 +1,213 @@
+/**
+ * Zuora API Reference
+ * REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
+ *
+ * The version of the OpenAPI document: 2025-08-12
+ * Contact: docs@zuora.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import AssociationRule from './AssociationRule';
+import CommitmentSegmentInput from './CommitmentSegmentInput';
+
+/**
+ * The UpsertCreateCommitmentInputAllOfSegments model module.
+ * @module model/UpsertCreateCommitmentInputAllOfSegments
+ * @version 3.9.0-beta.2
+ */
+class UpsertCreateCommitmentInputAllOfSegments {
+    /**
+     * Constructs a new <code>UpsertCreateCommitmentInputAllOfSegments</code>.
+     * @alias module:model/UpsertCreateCommitmentInputAllOfSegments
+     * @implements module:model/CommitmentSegmentInput
+     * @param start_date {String} 
+     * @param end_date {String} 
+     * @param cycle_amount {Number} 
+     */
+    constructor(start_date, end_date, cycle_amount) { 
+        CommitmentSegmentInput.initialize(this, start_date, end_date, cycle_amount);
+        UpsertCreateCommitmentInputAllOfSegments.initialize(this, start_date, end_date, cycle_amount);
+    }
+
+    /**
+     * 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.
+     */
+    static initialize(obj, start_date, end_date, cycle_amount) { 
+        obj['startDate'] = start_date;
+        obj['endDate'] = end_date;
+        obj['cycleAmount'] = cycle_amount;
+    }
+
+
+    /**
+     * Create a <code>UpsertCreateCommitmentInputAllOfSegments</code> from a plain JavaScript object.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {module:model/UpsertCreateCommitmentInputAllOfSegments} The populated <code>UpsertCreateCommitmentInputAllOfSegments</code> instance.
+     */
+    static fromObject(data) { 
+        return UpsertCreateCommitmentInputAllOfSegments.constructFromObject(data, null);
+    }
+
+    /**
+     * Constructs a <code>UpsertCreateCommitmentInputAllOfSegments</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/UpsertCreateCommitmentInputAllOfSegments} obj Optional instance to populate.
+     * @return {module:model/UpsertCreateCommitmentInputAllOfSegments} The populated <code>UpsertCreateCommitmentInputAllOfSegments</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new UpsertCreateCommitmentInputAllOfSegments();
+            CommitmentSegmentInput.constructFromObject(data, obj);
+
+            if (data.hasOwnProperty('commitmentSegmentNumber')) {
+                obj['commitmentSegmentNumber'] = ApiClient.convertToType(data['commitmentSegmentNumber'], 'String');
+            }
+            if (data.hasOwnProperty('startDate')) {
+                obj['startDate'] = ApiClient.convertToType(data['startDate'], 'String');
+            }
+            if (data.hasOwnProperty('endDate')) {
+                obj['endDate'] = ApiClient.convertToType(data['endDate'], 'String');
+            }
+            if (data.hasOwnProperty('associationRule')) {
+                obj['associationRule'] = AssociationRule.constructFromObject(data['associationRule']);
+            }
+            if (data.hasOwnProperty('customFields')) {
+                obj['customFields'] = ApiClient.convertToType(data['customFields'], {'String': Object});
+            }
+            if (data.hasOwnProperty('cycleAmount')) {
+                obj['cycleAmount'] = ApiClient.convertToType(data['cycleAmount'], 'Number');
+            }
+            if (data.hasOwnProperty('action')) {
+                obj['action'] = ApiClient.convertToType(data['action'], 'String');
+            }
+        }
+        return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpsertCreateCommitmentInputAllOfSegments</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>UpsertCreateCommitmentInputAllOfSegments</code>.
+     */
+    static validateJSON(data) {
+        // check to make sure all required properties are present in the JSON string
+        for (const property of UpsertCreateCommitmentInputAllOfSegments.RequiredProperties) {
+            if (!data.hasOwnProperty(property)) {
+                throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+            }
+        }
+        // ensure the json data is a string
+        if (data['commitmentSegmentNumber'] && !(typeof data['commitmentSegmentNumber'] === 'string' || data['commitmentSegmentNumber'] instanceof String)) {
+            throw new Error("Expected the field `commitmentSegmentNumber` to be a primitive type in the JSON string but got " + data['commitmentSegmentNumber']);
+        }
+        // validate the optional field `associationRule`
+        if (data['associationRule']) { // data not null
+          AssociationRule.validateJSON(data['associationRule']);
+        }
+        // ensure the json data is a string
+        if (data['action'] && !(typeof data['action'] === 'string' || data['action'] instanceof String)) {
+            throw new Error("Expected the field `action` to be a primitive type in the JSON string but got " + data['action']);
+        }
+
+        return true;
+    }
+
+
+}
+
+UpsertCreateCommitmentInputAllOfSegments.RequiredProperties = ["startDate", "endDate", "cycleAmount"];
+
+/**
+ * The number of the Commitment Segment.
+ * @member {String} commitmentSegmentNumber
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['commitmentSegmentNumber'] = undefined;
+
+/**
+ * @member {String} startDate
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['startDate'] = undefined;
+
+/**
+ * @member {String} endDate
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['endDate'] = undefined;
+
+/**
+ * @member {module:model/AssociationRule} associationRule
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['associationRule'] = undefined;
+
+/**
+ * Container for custom fields of an commitment Segment object.
+ * @member {Object.<String, Object>} customFields
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['customFields'] = undefined;
+
+/**
+ * @member {Number} cycleAmount
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['cycleAmount'] = undefined;
+
+/**
+ * @member {module:model/UpsertCreateCommitmentInputAllOfSegments.ActionEnum} action
+ */
+UpsertCreateCommitmentInputAllOfSegments.prototype['action'] = undefined;
+
+
+// Implement CommitmentSegmentInput interface:
+/**
+ * The number of the Commitment Segment.
+ * @member {String} commitmentSegmentNumber
+ */
+CommitmentSegmentInput.prototype['commitmentSegmentNumber'] = undefined;
+/**
+ * @member {String} startDate
+ */
+CommitmentSegmentInput.prototype['startDate'] = undefined;
+/**
+ * @member {String} endDate
+ */
+CommitmentSegmentInput.prototype['endDate'] = undefined;
+/**
+ * @member {module:model/AssociationRule} associationRule
+ */
+CommitmentSegmentInput.prototype['associationRule'] = undefined;
+/**
+ * Container for custom fields of an commitment Segment object.
+ * @member {Object.<String, Object>} customFields
+ */
+CommitmentSegmentInput.prototype['customFields'] = undefined;
+/**
+ * @member {Number} cycleAmount
+ */
+CommitmentSegmentInput.prototype['cycleAmount'] = undefined;
+
+
+
+/**
+ * Allowed values for the <code>action</code> property.
+ * @enum {String}
+ * @readonly
+ */
+UpsertCreateCommitmentInputAllOfSegments['ActionEnum'] = {
+
+    /**
+     * value: "create"
+     * @const
+     */
+    "create": "create"
+};
+
+
+
+export default UpsertCreateCommitmentInputAllOfSegments;
+

package/src/zuora_api/model/UpsertCreateCommitmentSegmentInput.js

@@ -0,0 +1,198 @@
+/**
+ * Zuora API Reference
+ * REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
+ *
+ * The version of the OpenAPI document: 2025-08-12
+ * Contact: docs@zuora.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import ActionType from './ActionType';
+import AssociationRule from './AssociationRule';
+import CommitmentSegmentInput from './CommitmentSegmentInput';
+
+/**
+ * The UpsertCreateCommitmentSegmentInput model module.
+ * @module model/UpsertCreateCommitmentSegmentInput
+ * @version 3.9.0-beta.2
+ */
+class UpsertCreateCommitmentSegmentInput {
+    /**
+     * Constructs a new <code>UpsertCreateCommitmentSegmentInput</code>.
+     * create a new segment
+     * @alias module:model/UpsertCreateCommitmentSegmentInput
+     * @implements module:model/CommitmentSegmentInput
+     * @param start_date {String} 
+     * @param end_date {String} 
+     * @param cycle_amount {Number} 
+     * @param action {module:model/ActionType} 
+     */
+    constructor(start_date, end_date, cycle_amount, action) { 
+        CommitmentSegmentInput.initialize(this, start_date, end_date, cycle_amount);
+        UpsertCreateCommitmentSegmentInput.initialize(this, start_date, end_date, cycle_amount, action);
+    }
+
+    /**
+     * 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.
+     */
+    static initialize(obj, start_date, end_date, cycle_amount, action) { 
+        obj['startDate'] = start_date;
+        obj['endDate'] = end_date;
+        obj['cycleAmount'] = cycle_amount;
+        obj['action'] = action;
+    }
+
+
+    /**
+     * Create a <code>UpsertCreateCommitmentSegmentInput</code> from a plain JavaScript object.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {module:model/UpsertCreateCommitmentSegmentInput} The populated <code>UpsertCreateCommitmentSegmentInput</code> instance.
+     */
+    static fromObject(data) { 
+        return UpsertCreateCommitmentSegmentInput.constructFromObject(data, null);
+    }
+
+    /**
+     * Constructs a <code>UpsertCreateCommitmentSegmentInput</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/UpsertCreateCommitmentSegmentInput} obj Optional instance to populate.
+     * @return {module:model/UpsertCreateCommitmentSegmentInput} The populated <code>UpsertCreateCommitmentSegmentInput</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new UpsertCreateCommitmentSegmentInput();
+            CommitmentSegmentInput.constructFromObject(data, obj);
+
+            if (data.hasOwnProperty('commitmentSegmentNumber')) {
+                obj['commitmentSegmentNumber'] = ApiClient.convertToType(data['commitmentSegmentNumber'], 'String');
+            }
+            if (data.hasOwnProperty('startDate')) {
+                obj['startDate'] = ApiClient.convertToType(data['startDate'], 'String');
+            }
+            if (data.hasOwnProperty('endDate')) {
+                obj['endDate'] = ApiClient.convertToType(data['endDate'], 'String');
+            }
+            if (data.hasOwnProperty('associationRule')) {
+                obj['associationRule'] = AssociationRule.constructFromObject(data['associationRule']);
+            }
+            if (data.hasOwnProperty('customFields')) {
+                obj['customFields'] = ApiClient.convertToType(data['customFields'], {'String': Object});
+            }
+            if (data.hasOwnProperty('cycleAmount')) {
+                obj['cycleAmount'] = ApiClient.convertToType(data['cycleAmount'], 'Number');
+            }
+            if (data.hasOwnProperty('action')) {
+                obj['action'] = ActionType.constructFromObject(data['action']);
+            }
+        }
+        return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpsertCreateCommitmentSegmentInput</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>UpsertCreateCommitmentSegmentInput</code>.
+     */
+    static validateJSON(data) {
+        // check to make sure all required properties are present in the JSON string
+        for (const property of UpsertCreateCommitmentSegmentInput.RequiredProperties) {
+            if (!data.hasOwnProperty(property)) {
+                throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+            }
+        }
+        // ensure the json data is a string
+        if (data['commitmentSegmentNumber'] && !(typeof data['commitmentSegmentNumber'] === 'string' || data['commitmentSegmentNumber'] instanceof String)) {
+            throw new Error("Expected the field `commitmentSegmentNumber` to be a primitive type in the JSON string but got " + data['commitmentSegmentNumber']);
+        }
+        // validate the optional field `associationRule`
+        if (data['associationRule']) { // data not null
+          AssociationRule.validateJSON(data['associationRule']);
+        }
+
+        return true;
+    }
+
+
+}
+
+UpsertCreateCommitmentSegmentInput.RequiredProperties = ["startDate", "endDate", "cycleAmount", "action"];
+
+/**
+ * The number of the Commitment Segment.
+ * @member {String} commitmentSegmentNumber
+ */
+UpsertCreateCommitmentSegmentInput.prototype['commitmentSegmentNumber'] = undefined;
+
+/**
+ * @member {String} startDate
+ */
+UpsertCreateCommitmentSegmentInput.prototype['startDate'] = undefined;
+
+/**
+ * @member {String} endDate
+ */
+UpsertCreateCommitmentSegmentInput.prototype['endDate'] = undefined;
+
+/**
+ * @member {module:model/AssociationRule} associationRule
+ */
+UpsertCreateCommitmentSegmentInput.prototype['associationRule'] = undefined;
+
+/**
+ * Container for custom fields of an commitment Segment object.
+ * @member {Object.<String, Object>} customFields
+ */
+UpsertCreateCommitmentSegmentInput.prototype['customFields'] = undefined;
+
+/**
+ * @member {Number} cycleAmount
+ */
+UpsertCreateCommitmentSegmentInput.prototype['cycleAmount'] = undefined;
+
+/**
+ * @member {module:model/ActionType} action
+ */
+UpsertCreateCommitmentSegmentInput.prototype['action'] = undefined;
+
+
+// Implement CommitmentSegmentInput interface:
+/**
+ * The number of the Commitment Segment.
+ * @member {String} commitmentSegmentNumber
+ */
+CommitmentSegmentInput.prototype['commitmentSegmentNumber'] = undefined;
+/**
+ * @member {String} startDate
+ */
+CommitmentSegmentInput.prototype['startDate'] = undefined;
+/**
+ * @member {String} endDate
+ */
+CommitmentSegmentInput.prototype['endDate'] = undefined;
+/**
+ * @member {module:model/AssociationRule} associationRule
+ */
+CommitmentSegmentInput.prototype['associationRule'] = undefined;
+/**
+ * Container for custom fields of an commitment Segment object.
+ * @member {Object.<String, Object>} customFields
+ */
+CommitmentSegmentInput.prototype['customFields'] = undefined;
+/**
+ * @member {Number} cycleAmount
+ */
+CommitmentSegmentInput.prototype['cycleAmount'] = undefined;
+
+
+
+
+export default UpsertCreateCommitmentSegmentInput;
+

package/src/zuora_api/model/UpsertUpdateCommitmentInput.js

@@ -0,0 +1,185 @@
+/**
+ * Zuora API Reference
+ * REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
+ *
+ * The version of the OpenAPI document: 2025-08-12
+ * Contact: docs@zuora.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import ActionType from './ActionType';
+import AssociationRule from './AssociationRule';
+import UpsertCommitmentSegmentInput from './UpsertCommitmentSegmentInput';
+
+/**
+ * The UpsertUpdateCommitmentInput model module.
+ * @module model/UpsertUpdateCommitmentInput
+ * @version 3.9.0-beta.2
+ */
+class UpsertUpdateCommitmentInput {
+    /**
+     * Constructs a new <code>UpsertUpdateCommitmentInput</code>.
+     * Update the existing commitment by the commitment number.
+     * @alias module:model/UpsertUpdateCommitmentInput
+     * @param action {module:model/ActionType} 
+     * @param commitment_number {String} The number of the Commitment.
+     */
+    constructor(action, commitment_number) { 
+        
+        UpsertUpdateCommitmentInput.initialize(this, action, commitment_number);
+    }
+
+    /**
+     * 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.
+     */
+    static initialize(obj, action, commitment_number) { 
+        obj['action'] = action;
+        obj['commitmentNumber'] = commitment_number;
+    }
+
+
+    /**
+     * Create a <code>UpsertUpdateCommitmentInput</code> from a plain JavaScript object.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {module:model/UpsertUpdateCommitmentInput} The populated <code>UpsertUpdateCommitmentInput</code> instance.
+     */
+    static fromObject(data) { 
+        return UpsertUpdateCommitmentInput.constructFromObject(data, null);
+    }
+
+    /**
+     * Constructs a <code>UpsertUpdateCommitmentInput</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/UpsertUpdateCommitmentInput} obj Optional instance to populate.
+     * @return {module:model/UpsertUpdateCommitmentInput} The populated <code>UpsertUpdateCommitmentInput</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new UpsertUpdateCommitmentInput();
+
+            if (data.hasOwnProperty('action')) {
+                obj['action'] = ActionType.constructFromObject(data['action']);
+            }
+            if (data.hasOwnProperty('commitmentNumber')) {
+                obj['commitmentNumber'] = ApiClient.convertToType(data['commitmentNumber'], 'String');
+            }
+            if (data.hasOwnProperty('name')) {
+                obj['name'] = ApiClient.convertToType(data['name'], 'String');
+            }
+            if (data.hasOwnProperty('description')) {
+                obj['description'] = ApiClient.convertToType(data['description'], 'String');
+            }
+            if (data.hasOwnProperty('defaultAssociationRule')) {
+                obj['defaultAssociationRule'] = AssociationRule.constructFromObject(data['defaultAssociationRule']);
+            }
+            if (data.hasOwnProperty('customFields')) {
+                obj['customFields'] = ApiClient.convertToType(data['customFields'], {'String': Object});
+            }
+            if (data.hasOwnProperty('segments')) {
+                obj['segments'] = ApiClient.convertToType(data['segments'], [UpsertCommitmentSegmentInput]);
+            }
+        }
+        return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpsertUpdateCommitmentInput</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>UpsertUpdateCommitmentInput</code>.
+     */
+    static validateJSON(data) {
+        // check to make sure all required properties are present in the JSON string
+        for (const property of UpsertUpdateCommitmentInput.RequiredProperties) {
+            if (!data.hasOwnProperty(property)) {
+                throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+            }
+        }
+        // ensure the json data is a string
+        if (data['commitmentNumber'] && !(typeof data['commitmentNumber'] === 'string' || data['commitmentNumber'] instanceof String)) {
+            throw new Error("Expected the field `commitmentNumber` to be a primitive type in the JSON string but got " + data['commitmentNumber']);
+        }
+        // ensure the json data is a string
+        if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
+            throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
+        }
+        // ensure the json data is a string
+        if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
+            throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
+        }
+        // validate the optional field `defaultAssociationRule`
+        if (data['defaultAssociationRule']) { // data not null
+          AssociationRule.validateJSON(data['defaultAssociationRule']);
+        }
+        if (data['segments']) { // data not null
+            // ensure the json data is an array
+            if (!Array.isArray(data['segments'])) {
+                throw new Error("Expected the field `segments` to be an array in the JSON data but got " + data['segments']);
+            }
+            // validate the optional field `segments` (array)
+            for (const item of data['segments']) {
+                UpsertCommitmentSegmentInput.validateJSON(item);
+            };
+        }
+
+        return true;
+    }
+
+
+}
+
+UpsertUpdateCommitmentInput.RequiredProperties = ["action", "commitmentNumber"];
+
+/**
+ * @member {module:model/ActionType} action
+ */
+UpsertUpdateCommitmentInput.prototype['action'] = undefined;
+
+/**
+ * The number of the Commitment.
+ * @member {String} commitmentNumber
+ */
+UpsertUpdateCommitmentInput.prototype['commitmentNumber'] = undefined;
+
+/**
+ * The value to update. Set to null to clear the existing value.
+ * @member {String} name
+ */
+UpsertUpdateCommitmentInput.prototype['name'] = undefined;
+
+/**
+ * The value to update. Set to null to clear the existing value.
+ * @member {String} description
+ */
+UpsertUpdateCommitmentInput.prototype['description'] = undefined;
+
+/**
+ * @member {module:model/AssociationRule} defaultAssociationRule
+ */
+UpsertUpdateCommitmentInput.prototype['defaultAssociationRule'] = undefined;
+
+/**
+ * Container for custom fields of an commitment Segment object.
+ * @member {Object.<String, Object>} customFields
+ */
+UpsertUpdateCommitmentInput.prototype['customFields'] = undefined;
+
+/**
+ * @member {Array.<module:model/UpsertCommitmentSegmentInput>} segments
+ */
+UpsertUpdateCommitmentInput.prototype['segments'] = undefined;
+
+
+
+
+
+
+export default UpsertUpdateCommitmentInput;
+