zuora-sdk-js 3.13.0 → 3.14.0-beta.2

package/dist/zuora_api/model/WriteOffInvoiceResponse.js

@@ -5,9 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _CommonResponse = _interopRequireDefault(require("./CommonResponse"));
+var _FailedReason = _interopRequireDefault(require("./FailedReason"));
 var _WriteOffInvoiceResponseCreditMemo = _interopRequireDefault(require("./WriteOffInvoiceResponseCreditMemo"));
 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 _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 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; }
@@ -27,15 +32,17 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The WriteOffInvoiceResponse model module.
  * @module model/WriteOffInvoiceResponse
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var WriteOffInvoiceResponse = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>WriteOffInvoiceResponse</code>.
    * @alias module:model/WriteOffInvoiceResponse
+   * @implements module:model/CommonResponse
    */
   function WriteOffInvoiceResponse() {
     _classCallCheck(this, WriteOffInvoiceResponse);
+    _CommonResponse["default"].initialize(this);
     WriteOffInvoiceResponse.initialize(this);
   }
 
@@ -71,12 +78,22 @@ var WriteOffInvoiceResponse = /*#__PURE__*/function () {
     value: function constructFromObject(data, obj) {
       if (data) {
         obj = obj || new WriteOffInvoiceResponse();
-        if (data.hasOwnProperty('creditMemo')) {
-          obj['creditMemo'] = _WriteOffInvoiceResponseCreditMemo["default"].constructFromObject(data['creditMemo']);
+        _CommonResponse["default"].constructFromObject(data, obj);
+        if (data.hasOwnProperty('processId')) {
+          obj['processId'] = _ApiClient["default"].convertToType(data['processId'], 'String');
+        }
+        if (data.hasOwnProperty('requestId')) {
+          obj['requestId'] = _ApiClient["default"].convertToType(data['requestId'], 'String');
+        }
+        if (data.hasOwnProperty('reasons')) {
+          obj['reasons'] = _ApiClient["default"].convertToType(data['reasons'], [_FailedReason["default"]]);
         }
         if (data.hasOwnProperty('success')) {
           obj['success'] = _ApiClient["default"].convertToType(data['success'], 'Boolean');
         }
+        if (data.hasOwnProperty('creditMemo')) {
+          obj['creditMemo'] = _WriteOffInvoiceResponseCreditMemo["default"].constructFromObject(data['creditMemo']);
+        }
       }
       return obj;
     }
@@ -89,6 +106,35 @@ var WriteOffInvoiceResponse = /*#__PURE__*/function () {
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['processId'] && !(typeof data['processId'] === 'string' || data['processId'] instanceof String)) {
+        throw new Error("Expected the field `processId` to be a primitive type in the JSON string but got " + data['processId']);
+      }
+      // ensure the json data is a string
+      if (data['requestId'] && !(typeof data['requestId'] === 'string' || data['requestId'] instanceof String)) {
+        throw new Error("Expected the field `requestId` to be a primitive type in the JSON string but got " + data['requestId']);
+      }
+      if (data['reasons']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['reasons'])) {
+          throw new Error("Expected the field `reasons` to be an array in the JSON data but got " + data['reasons']);
+        }
+        // validate the optional field `reasons` (array)
+        var _iterator = _createForOfIteratorHelper(data['reasons']),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            _FailedReason["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        ;
+      }
       // validate the optional field `creditMemo`
       if (data['creditMemo']) {
         // data not null
@@ -98,14 +144,54 @@ var WriteOffInvoiceResponse = /*#__PURE__*/function () {
     }
   }]);
 }();
+/**
+ * The Id of the process that handle the operation. 
+ * @member {String} processId
+ */
+WriteOffInvoiceResponse.prototype['processId'] = undefined;
+
+/**
+ * Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. 
+ * @member {String} requestId
+ */
+WriteOffInvoiceResponse.prototype['requestId'] = undefined;
+
+/**
+ * @member {Array.<module:model/FailedReason>} reasons
+ */
+WriteOffInvoiceResponse.prototype['reasons'] = undefined;
+
+/**
+ * Indicates whether the call succeeded. 
+ * @member {Boolean} success
+ * @default true
+ */
+WriteOffInvoiceResponse.prototype['success'] = true;
+
 /**
  * @member {module:model/WriteOffInvoiceResponseCreditMemo} creditMemo
  */
 WriteOffInvoiceResponse.prototype['creditMemo'] = undefined;
 
+// Implement CommonResponse interface:
+/**
+ * The Id of the process that handle the operation. 
+ * @member {String} processId
+ */
+_CommonResponse["default"].prototype['processId'] = undefined;
+/**
+ * Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. 
+ * @member {String} requestId
+ */
+_CommonResponse["default"].prototype['requestId'] = undefined;
+/**
+ * @member {Array.<module:model/FailedReason>} reasons
+ */
+_CommonResponse["default"].prototype['reasons'] = undefined;
 /**
- * Returns `true` if the request was processed successfully. 
+ * Indicates whether the call succeeded. 
  * @member {Boolean} success
+ * @default true
  */
-WriteOffInvoiceResponse.prototype['success'] = undefined;
+_CommonResponse["default"].prototype['success'] = true;
 var _default = exports["default"] = WriteOffInvoiceResponse;

package/dist/zuora_api/model/WriteOffInvoiceResponseCreditMemo.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The WriteOffInvoiceResponseCreditMemo model module.
  * @module model/WriteOffInvoiceResponseCreditMemo
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var WriteOffInvoiceResponseCreditMemo = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/WriteOffOptions.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The WriteOffOptions model module.
  * @module model/WriteOffOptions
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var WriteOffOptions = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/WriteOffResultTransaction.js

@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The WriteOffResultTransaction model module.
  * @module model/WriteOffResultTransaction
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var WriteOffResultTransaction = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/WriteOffResults.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The WriteOffResults model module.
  * @module model/WriteOffResults
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var WriteOffResults = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/ZObject.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The ZObject model module.
  * @module model/ZObject
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var ZObject = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/model/ZObjectUpdate.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The ZObjectUpdate model module.
  * @module model/ZObjectUpdate
- * @version 3.13.0
+ * @version 3.14.0-beta.2
  */
 var ZObjectUpdate = /*#__PURE__*/function () {
   /**

package/docs/AccountSummaryResponse.md

@@ -4,6 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **basic_info** | [**AccountSummaryBasicInfo**](AccountSummaryBasicInfo.md) |  | [optional] 
 **bill_to_contact** | [**Contact**](Contact.md) |  | [optional] 
 **invoices** | [**[AccountSummaryInvoice]**](AccountSummaryInvoice.md) | Container for invoices. Only returns the last 6 invoices.  | [optional] 
@@ -11,7 +15,6 @@ Name | Type | Description | Notes
 **sold_to_contact** | [**Contact**](Contact.md) |  | [optional] 
 **ship_to_contact** | [**Contact**](Contact.md) |  | [optional] 
 **subscriptions** | [**[AccountSummarySubscription]**](AccountSummarySubscription.md) | Container for subscriptions.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **tax_info** | [**TaxInfo**](TaxInfo.md) |  | [optional] 
 **usage** | [**[AccountSummaryUsage]**](AccountSummaryUsage.md) | Container for usage data. Only returns the last 6 months of usage.   **Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field. | [optional] 
 

package/docs/BillingDocumentQueryResponseElement.md

@@ -4,8 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **documents** | [**[GetBillingDocumentsResponse]**](GetBillingDocumentsResponse.md) | Container for billing documents.  | [optional] 
 **next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/BillingDocumentStatus.md

@@ -15,4 +15,6 @@
 
 * `PendingForTax` (value: `"PendingForTax"`)
 
+* `Split` (value: `"Split"`)
+
 

package/docs/BulkPaymentOptionItem.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.BulkPaymentOptionItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription_id** | **String** | The ID of the subscription for which the payment profile will be created or updated.  | 
+**payment_gateway_id** | **String** | Specifies by ID the payment gateway to be assigned to the subscription.  | [optional] 
+**payment_method_id** | **String** | Specifies by ID the payment method to be assigned to the subscription.  | [optional] 
+
+

package/docs/BulkPaymentProfileRequest.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.BulkPaymentProfileRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bulk_payment_option_items** | [**[BulkPaymentOptionItem]**](BulkPaymentOptionItem.md) | Array of payment profile items to create or update. Maximum of 50 items allowed.  | 
+
+

package/docs/BulkPaymentProfileResponse.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.BulkPaymentProfileResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** | Indicates whether the overall bulk operation was successful. Returns `true` if all payment profiles were processed successfully. Returns `false` if any payment profile failed to process.  Note: This field is only present in 200 and 4XX responses, not in 500 errors.  | [optional] 
+**process_id** | **String** | Process ID for tracking the request (only present in error responses).  | [optional] 
+**request_id** | **String** | Request ID for tracking the request (only present in error responses).  | [optional] 
+**reasons** | [**[BulkPaymentProfileResponseReasonsInner]**](BulkPaymentProfileResponseReasonsInner.md) | Error reasons if the operation failed. Present in both 4XX and 500 error responses.  | [optional] 
+
+

package/docs/BulkPaymentProfileResponseReasonsInner.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.BulkPaymentProfileResponseReasonsInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code | [optional] 
+**message** | **String** | Error message | [optional] 
+
+

package/docs/CancelAuthorizationResponse.md

@@ -4,10 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **gateway_order_id** | **String** | The order ID for the specific gateway.   The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field. | [optional] 
 **result_code** | **String** | The result code of the request.    0 indicates that the request succeeded, and the following values indicate that the request failed:   - 1: The request is declined.   - 7: The field format is not correct.   - 10: Client connection has timed out.   - 11: Host connection has timed out.   - 12: Processor connection has timed out.   - 13: Gateway server is busy.   - 20: The card type is not supported.   - 21: The merchant account information is invalid.   - 22: A generic error occurred on the processor.   - 40: The card type has not been set up yet.   - 41: The limit for a single transaction is exceeded.   - 42: Address checking failed.   - 43: Card security code checking failed.   - 44: Failed due to the gateway security setting.   - 45: Fraud protection is declined.   - 46: Address checking or card security code checking failed (for Authorize.net gateway only).   - 47: The maximum amount is exceeded (for Authorize.net gateway only).   - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).   - 49: Card security code checking failed (for Authorize.net gateway only).   - 60: User authentication failed.   - 61: The currency code is invalid.   - 62: The transaction ID is invalid.   - 63: The credit card number is invalid.   - 64: The card expiration date is invalid.   - 65: The transaction is duplicated.   - 66: Credit transaction error.   - 67: Void transaction error.   - 90: A valid amount is required.   - 91: The BA code is invalid.   - 92: The account number is invalid.   - 93: The ACH transaction is not accepted by the merchant.   - 94: An error occurred for the ACH transaction.   - 95: The version parameter is invalid.   - 96: The transaction type is invalid.   - 97: The transaction method is invalid.   - 98: The bank account type is invalid.   - 99: The authorization code is invalid.   - 200: General transaction error.   - 500: The transaction is queued for submission.   - 999: Unknown error.   - -1: An error occurred in gateway communication.   - -2: Idempotency is not supported.   - -3: Inquiry call is not supported. | [optional] 
 **result_message** | **String** | The corresponding request ID. | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded. | [optional] 
 **transaction_id** | **String** | The ID of the transaction. | [optional] 
 
 

package/docs/CancelSubscriptionResponse.md

@@ -4,13 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **cancelled_date** | **String** | The date that the subscription was canceled. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
 **credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.   **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
 **invoice_id** | **String** | ID of the invoice, if one is generated.  | [optional] 
 **paid_amount** | **Number** | Amount paid.  | [optional] 
 **payment_id** | **String** | ID of the payment, if a payment is collected.  | [optional] 
 **subscription_id** | **String** | The subscription ID. It is available for Orders Harmonization and Subscribe/Amend Tenants.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **total_delta_mrr** | **Number** | Change in the subscription monthly recurring revenue as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 
 **total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 
 **order_number** | **String** | The order number. It is available for Orders Tenants.  | [optional] 

package/docs/ChargeRemoval.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.ChargeRemoval
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_number** | **String** | The number of the charge to be removed. This must be an optional charge in a bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | 
+**description** | **String** | Description of why the charge is being removed.  **Note:** This field does not accept JavaScript or HTML script content for security reasons.  | [optional] 
+
+

package/docs/CommitmentBaseAttributes.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **type** | [**CommitmentTypeEnum**](CommitmentTypeEnum.md) |  | 
 **description** | **String** |  | [optional] 
 **priority** | **Number** | It defines the evaluation order of the commitment, the lower the number, the higher the priority. When two commitments have the same priority, the one with the earlier created time will be evaluated first. | [optional] 
-**association_rules** | [**[AssociationRule]**](AssociationRule.md) |  | [optional] 
 **eligible_account_conditions** | [**Condition**](Condition.md) |  | 
 **eligible_charge_conditions** | [**Condition**](Condition.md) |  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of an commitment object. | [optional] 

package/docs/CommitmentInput.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **type** | [**CommitmentTypeEnum**](CommitmentTypeEnum.md) |  | 
 **description** | **String** |  | [optional] 
 **priority** | **Number** | It defines the evaluation order of the commitment, the lower the number, the higher the priority. When two commitments have the same priority, the one with the earlier created time will be evaluated first. | [optional] 
-**association_rules** | [**[AssociationRule]**](AssociationRule.md) |  | [optional] 
 **eligible_account_conditions** | [**Condition**](Condition.md) |  | 
 **eligible_charge_conditions** | [**Condition**](Condition.md) |  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of an commitment object. | [optional] 
@@ -33,7 +32,7 @@ Name | Type | Description | Notes
 **tax_mode** | **String** | The taxMode of a charge.  Values: * `TaxExclusive` * `TaxInclusive` This field is available when the field 'taxable' is set to true.  | [optional] 
 **currency** | **String** |  | 
 **periods** | [**[CommitmentPeriodInput]**](CommitmentPeriodInput.md) |  | [optional] 
-**period_alignment_option** | [**PeriodAlignmentOptionEnum**](PeriodAlignmentOptionEnum.md) |  | 
+**period_alignment_option** | [**PeriodAlignmentOptionEnum**](PeriodAlignmentOptionEnum.md) |  | [optional] 
 **specific_period_alignment_date** | **String** |  | [optional] 
 **schedules** | [**[CommitmentScheduleInput]**](CommitmentScheduleInput.md) |  | 
 

package/docs/CreateAccountingCodeResponse.md

@@ -4,7 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **id** | **String** | ID of the newly created accounting code.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateAccountingPeriodResponse.md

@@ -4,7 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **id** | **String** | ID of the newly-created accounting period.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateBillingDocumentFilesDeletionJobResponse.md

@@ -4,8 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **id** | **String** | The unique ID of the billing document file deletion job.  | [optional] 
 **status** | [**CreateBillingDocumentFilesDeletionJobStatus**](CreateBillingDocumentFilesDeletionJobStatus.md) |  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/CreateBillingPreviewResponse.md

@@ -4,9 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **account_id** | **String** | ID of the customer account to which the billing preview applies.  | [optional] 
 **credit_memo_items** | [**[CreateBillingPreviewCreditMemoItem]**](CreateBillingPreviewCreditMemoItem.md) | An array of credit memo items returned as the result of the billing preivew request.   **Note:** The credit memo items are only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
 **invoice_items** | [**[CreateBillingPreviewInvoiceItem]**](CreateBillingPreviewInvoiceItem.md) | An array of invoice items returned as the result of the billing preview request. | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateHostedPageRequest.md

@@ -0,0 +1,46 @@
+# ZuoraSdkJs.CreateHostedPageRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of payment method that the hosted page will support.   Valid values: - `hp_creditcard` - For credit card payments - `hp_ach` - For ACH (Automated Clearing House) payments - `hp_directdebituk` - For bank transfer payments (UK Direct Debit) - `hp_sepa` - For SEPA payments - `hp_paypal` - For PayPal payments - `hp_directentryau` - For Direct Entry AU payments - `hp_betalingsservice` - For Betalingsservice payments - `hp_autogiro` - For Autogiro payments - `hp_directdebitnz` - For Direct Debit NZ payments - `hp_pad` - For PAD payments - `hp_ccref` - For credit card reference transactions  | 
+**page_name** | **String** | The display name for the hosted payment page. This name will be used for identification purposes in the Zuora UI.  | 
+**domain** | **String** | The domain where the hosted payment page will be accessible. Must be a valid URL format.  Example: `https://example.com`  | 
+**gateway** | **String** | The name or identifier of the payment gateway that will process payments from this hosted page.  The gateway must be configured and active in your Zuora tenant.  | 
+**callback_path** | **String** | The callback URL path that will be used after payment processing is completed.  This path will be appended to the domain to form the complete callback URL.  Example: `/callback` will result in `https://example.com/callback`  | [optional] 
+**allow_sub_domain** | **Boolean** | Specifies whether the hosted page can be accessed from subdomains of the specified domain.  - `true` - Allow access from subdomains (e.g., `pay.example.com`) - `false` - Only allow access from the exact domain specified  | [optional] [default to false]
+**display_fields** | **[String]** | An array of field names that should be displayed on the hosted payment page.  Common field options include: - `cardHolderName` - Cardholder's name - `address1` - Primary address line - `address2` - Secondary address line   - `city` - City - `state` - State or province - `zipcode` - ZIP or postal code - `country` - Country - `phone` - Phone number - `email` - Email address  | [optional] 
+**require_fields** | **[String]** | An array of field names that are required to be filled out on the hosted payment page. All fields specified in this array must also be included in the `displayFields` array.  | [optional] 
+**css** | **String** | Custom CSS styling that will be applied to the hosted payment page. Use this to customize the appearance and branding of the page to match your website.  Example: ```css body { font-family: Arial, sans-serif; } .form-container { max-width: 500px; margin: 0 auto; } ```  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `creditcard` (value: `"hp_creditcard"`)
+
+* `ach` (value: `"hp_ach"`)
+
+* `directdebituk` (value: `"hp_directdebituk"`)
+
+* `sepa` (value: `"hp_sepa"`)
+
+* `paypal` (value: `"hp_paypal"`)
+
+* `directentryau` (value: `"hp_directentryau"`)
+
+* `betalingsservice` (value: `"hp_betalingsservice"`)
+
+* `autogiro` (value: `"hp_autogiro"`)
+
+* `directdebitnz` (value: `"hp_directdebitnz"`)
+
+* `pad` (value: `"hp_pad"`)
+
+* `ccref` (value: `"hp_ccref"`)
+
+
+
+

package/docs/CreateHostedPageResponse.md

@@ -0,0 +1,42 @@
+# ZuoraSdkJs.CreateHostedPageResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
+**id** | **String** | Unique identifier of the Payment Page that Zuora assigns when it is created.  | [optional] 
+**page_name** | **String** | Name of the Payment Page that was specified during the page configuration.  | [optional] 
+**page_type** | **String** | Payment method type of this Payment Page.  Valid values: - `Credit Card` - For credit card payments - `ACH` - For ACH (Automated Clearing House) payments   - `Bank Transfer` - For bank transfer payments  | [optional] 
+**page_version** | **Number** | Version of the Payment Page. Always 2 for Payment Pages 2.0.  | [optional] 
+**domain** | **String** | The domain where the hosted payment page is accessible.  | [optional] 
+**callback_path** | **String** | The callback URL path that is used after payment processing is completed.  | [optional] 
+**gateway** | **String** | The name or identifier of the payment gateway that processes payments from this hosted page.  | [optional] 
+**allow_sub_domain** | **Boolean** | Indicates whether the hosted page can be accessed from subdomains of the specified domain.  | [optional] 
+
+
+
+## Enum: PageTypeEnum
+
+
+* `Credit Card` (value: `"Credit Card"`)
+
+* `ACH` (value: `"ACH"`)
+
+* `Bank Transfer` (value: `"Bank Transfer"`)
+
+
+
+
+
+## Enum: PageVersionEnum
+
+
+* `2` (value: `2`)
+
+
+
+

package/docs/CreateInvoiceCollectResponse.md

@@ -4,10 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **amount_collected** | **Number** | Payment amount applied.  | [optional] 
 **credit_memos** | [**[CreateInvoiceCollectCreditMemos]**](CreateInvoiceCollectCreditMemos.md) | Information on one or more credit memos associated with this operation.  | [optional] 
 **invoices** | [**[CreateInvoiceCollectInvoices]**](CreateInvoiceCollectInvoices.md) | Information on one or more invoices associated with this operation.  | [optional] 
 **payment_id** | **String** | Payment ID.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateJournalEntryResponse.md

@@ -4,7 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **journal_entry_number** | **String** | Journal entry number in the format JE-00000001.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateJournalRunResponse.md

@@ -4,7 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **journal_run_number** | **String** | Journal run number.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateMassUpdateResponse.md

@@ -4,7 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **bulk_key** | **String** | String of 32 characters that identifies the mass action. The bulkKey is generated before the mass action is processed. You can use the bulkKey to Get the Mass Action Result. | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/CreateOrderRatePlanUpdate.md

@@ -5,6 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[CreateOrderChargeUpdate]**](CreateOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. | [optional] 
+**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan. | [optional] 
+**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of charge removals for the UpdateProduct order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed. | [optional] 
 **external_catalog_plan_id** | **String** | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 

package/docs/CreateOrderUpdateProduct.md

@@ -5,6 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[CreateOrderChargeUpdate]**](CreateOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. | [optional] 
+**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan. | [optional] 
+**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of charge removals for the UpdateProduct order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed. | [optional] 
 **external_catalog_plan_id** | **String** | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional]