zuora-sdk-js 3.0.0 → 3.2.0-beta.0

package/dist/zuora_api/api/CustomPaymentMethodTypesApi.js

@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * CustomPaymentMethodTypes service.
 * @module api/CustomPaymentMethodTypesApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var CustomPaymentMethodTypesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/CustomScheduledEventsApi.js

@@ -33,7 +33,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * CustomScheduledEvents service.
 * @module api/CustomScheduledEventsApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var CustomScheduledEventsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/DataBackfillJobApi.js

@@ -33,7 +33,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * DataBackfillJob service.
 * @module api/DataBackfillJobApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var DataBackfillJobApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/DataQueriesApi.js

@@ -34,7 +34,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * DataQueries service.
 * @module api/DataQueriesApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var DataQueriesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/DebitMemosApi.js

@@ -30,6 +30,8 @@ var _ProxyUnauthorizedResponse = _interopRequireDefault(require("../model/ProxyU
 var _UpdateDebitMemoRequest = _interopRequireDefault(require("../model/UpdateDebitMemoRequest"));
 var _UpdateDebitMemosDueDatesRequest = _interopRequireDefault(require("../model/UpdateDebitMemosDueDatesRequest"));
 var _UploadFileResponse = _interopRequireDefault(require("../model/UploadFileResponse"));
+var _WriteOffDebitMemoRequest = _interopRequireDefault(require("../model/WriteOffDebitMemoRequest"));
+var _WriteOffDebitMemoResponse = _interopRequireDefault(require("../model/WriteOffDebitMemoResponse"));
 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"); }
@@ -51,7 +53,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * DebitMemos service.
 * @module api/DebitMemosApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var DebitMemosApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -1825,5 +1827,77 @@ var DebitMemosApi = exports["default"] = /*#__PURE__*/function () {
         return response_and_data.data;
       });
     }
+
+    /**
+     * Write off an debit memo
+     * 
+     * @param {String} debit_memo_key  
+     * @param {module:model/WriteOffDebitMemoRequest} request 
+     * @param {Object} opts Optional parameters
+     * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} [zuora_track_id] A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WriteOffDebitMemoResponse} and HTTP response
+     */
+  }, {
+    key: "writeOffDebitMemoWithHttpInfo",
+    value: function writeOffDebitMemoWithHttpInfo(debit_memo_key, request, opts) {
+      opts = opts || {};
+      var postBody = request;
+      // verify the required parameter 'debit_memo_key' is set
+      if (debit_memo_key === undefined || debit_memo_key === null) {
+        throw new Error("Missing the required parameter 'debit_memo_key' when calling writeOffDebitMemo");
+      }
+      // verify the required parameter 'request' is set
+      if (request === undefined || request === null) {
+        throw new Error("Missing the required parameter 'request' when calling writeOffDebitMemo");
+      }
+      var pathParams = {
+        'debitMemoKey': debit_memo_key
+      };
+      var queryParams = {};
+      var headerParams = {
+        'Accept-Encoding': opts['accept_encoding'],
+        'Content-Encoding': opts['content_encoding'],
+        'Authorization': opts['authorization'],
+        'Zuora-Track-Id': opts['zuora_track_id'],
+        'Zuora-Entity-Ids': opts['zuora_entity_ids'],
+        'Zuora-Version': opts['zuora_version'],
+        'Zuora-Org-Ids': opts['zuora_org_ids']
+      };
+      var formParams = {};
+      var authNames = ['bearerAuth'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _WriteOffDebitMemoResponse["default"];
+      return this.apiClient.callApi('/v1/debitmemos/{debitMemoKey}/write-off', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Write off an debit memo
+     * 
+     * @param {String} debit_memo_key  
+     * @param {module:model/WriteOffDebitMemoRequest} request 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} opts.zuora_track_id A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} opts.zuora_version The minor version of the Zuora REST API.   (default to '2024-05-20')
+     * @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WriteOffDebitMemoResponse}
+     */
+  }, {
+    key: "writeOffDebitMemo",
+    value: function writeOffDebitMemo(debit_memo_key, request, opts) {
+      return this.writeOffDebitMemoWithHttpInfo(debit_memo_key, request, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
   }]);
 }();

package/dist/zuora_api/api/DescribeApi.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Describe service.
 * @module api/DescribeApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var DescribeApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/EInvoicingApi.js

@@ -35,7 +35,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * EInvoicing service.
 * @module api/EInvoicingApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var EInvoicingApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/ElectronicPaymentsHealthApi.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * ElectronicPaymentsHealth service.
 * @module api/ElectronicPaymentsHealthApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var ElectronicPaymentsHealthApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/FilesApi.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Files service.
 * @module api/FilesApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var FilesApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -83,7 +83,7 @@ var FilesApi = exports["default"] = /*#__PURE__*/function () {
       var formParams = {};
       var authNames = ['bearerAuth'];
       var contentTypes = [];
-      var accepts = ['multipart/form-data', 'application/json'];
+      var accepts = ['application/octet-stream', 'application/json'];
       var returnType = File;
       return this.apiClient.callApi('/v1/files/{file-id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }

package/dist/zuora_api/api/FulfillmentsApi.js

@@ -37,7 +37,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Fulfillments service.
 * @module api/FulfillmentsApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var FulfillmentsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/HostedPagesApi.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * HostedPages service.
 * @module api/HostedPagesApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var HostedPagesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/ImportsApi.js

@@ -33,7 +33,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Imports service.
 * @module api/ImportsApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var ImportsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/InvoiceSchedulesApi.js

@@ -34,7 +34,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * InvoiceSchedules service.
 * @module api/InvoiceSchedulesApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var InvoiceSchedulesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/InvoicesApi.js

@@ -54,7 +54,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Invoices service.
 * @module api/InvoicesApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/JournalRunsApi.js

@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * JournalRuns service.
 * @module api/JournalRunsApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var JournalRunsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/MassUpdaterApi.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * MassUpdater service.
 * @module api/MassUpdaterApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var MassUpdaterApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/NotificationsApi.js

@@ -46,7 +46,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Notifications service.
 * @module api/NotificationsApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var NotificationsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/zuora_api/api/OAuthApi.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * OAuth service.
 * @module api/OAuthApi
-* @version 3.0.0
+* @version 3.2.0-beta.0
 */
 var OAuthApi = exports["default"] = /*#__PURE__*/function () {
   /**