zuora-sdk-js 3.5.0 → 3.6.0

package/src/zuora_api/api/ContactSnapshotsApi.js

@@ -21,7 +21,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * ContactSnapshots service.
 * @module api/ContactSnapshotsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class ContactSnapshotsApi {
 

package/src/zuora_api/api/ContactsApi.js

@@ -24,7 +24,7 @@ import UpdateContactRequest from '../model/UpdateContactRequest';
 /**
 * Contacts service.
 * @module api/ContactsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class ContactsApi {
 

package/src/zuora_api/api/CreditMemosApi.js

@@ -14,7 +14,9 @@
 
 import ApiClient from "../ApiClient";
 import ApplyCreditMemoRequest from '../model/ApplyCreditMemoRequest';
+import AsyncApplyCreditMemoRequest from '../model/AsyncApplyCreditMemoRequest';
 import AsyncOperationResponse from '../model/AsyncOperationResponse';
+import AsyncUnapplyCreditMemoRequest from '../model/AsyncUnapplyCreditMemoRequest';
 import BillingDocumentStatus from '../model/BillingDocumentStatus';
 import BulkCreateCreditMemosRequest from '../model/BulkCreateCreditMemosRequest';
 import BulkCreditMemosResponse from '../model/BulkCreditMemosResponse';
@@ -36,6 +38,7 @@ import GetCreditMemoPartsResponse from '../model/GetCreditMemoPartsResponse';
 import GetCreditMemoPdfStatusBatchResponse from '../model/GetCreditMemoPdfStatusBatchResponse';
 import GetTaxationItemsOfCreditMemoItemResponse from '../model/GetTaxationItemsOfCreditMemoItemResponse';
 import GetTaxationItemsResponse from '../model/GetTaxationItemsResponse';
+import InvoiceSettlementAsyncJobResponse from '../model/InvoiceSettlementAsyncJobResponse';
 import PostCreditMemoRequest from '../model/PostCreditMemoRequest';
 import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 import RefundCreditMemoRequest from '../model/RefundCreditMemoRequest';
@@ -51,7 +54,7 @@ import WriteOffCreditMemoResponse from '../model/WriteOffCreditMemoResponse';
 /**
 * CreditMemos service.
 * @module api/CreditMemosApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CreditMemosApi {
 
@@ -146,6 +149,84 @@ export default class CreditMemosApi {
     }
 
 
+    /**
+     * Async Apply a credit memo
+     * **Note:** This operation is only available if 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.    Asynchronously applies a posted credit memo to one or more invoices   You can apply a credit memo to an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.   When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 300,000.   The maximum number of invoices that you can specify in the request is 1,000   If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000:   (number of invoice items) * number of credit memo items  Otherwise, the First In First Out rule will be used instead of the Proration rule. 
+     * @param {String} credit_memo_key The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. 
+     * @param {module:model/AsyncApplyCreditMemoRequest} body 
+     * @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/InvoiceSettlementAsyncJobResponse} and HTTP response
+     */
+    applyCreditMemoAsyncWithHttpInfo(credit_memo_key, body, opts) {
+      opts = opts || {};
+      let postBody = body;
+      // verify the required parameter 'credit_memo_key' is set
+      if (credit_memo_key === undefined || credit_memo_key === null) {
+        throw new Error("Missing the required parameter 'credit_memo_key' when calling applyCreditMemoAsync");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling applyCreditMemoAsync");
+      }
+
+      let pathParams = {
+        'creditMemoKey': credit_memo_key
+      };
+      let queryParams = {
+      };
+      let 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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = ['application/json'];
+      let accepts = ['application/json'];
+      let returnType = InvoiceSettlementAsyncJobResponse;
+      return this.apiClient.callApi(
+        '/v1/credit-memos/{creditMemoKey}/apply-async', 'PUT',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Async Apply a credit memo
+     * **Note:** This operation is only available if 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.    Asynchronously applies a posted credit memo to one or more invoices   You can apply a credit memo to an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.   When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 300,000.   The maximum number of invoices that you can specify in the request is 1,000   If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000:   (number of invoice items) * number of credit memo items  Otherwise, the First In First Out rule will be used instead of the Proration rule. 
+     * @param {String} credit_memo_key The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. 
+     * @param {module:model/AsyncApplyCreditMemoRequest} body 
+     * @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/InvoiceSettlementAsyncJobResponse}
+     */
+    applyCreditMemoAsync(credit_memo_key, body, opts) {
+      return this.applyCreditMemoAsyncWithHttpInfo(credit_memo_key, body, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Create credit memos
      * **Note:** This operation is only available if 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.  Creates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request.   - If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges.  The credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully.   You can create credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.  Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice. 
@@ -899,6 +980,78 @@ export default class CreditMemosApi {
     }
 
 
+    /**
+     * Get Async Apply Credit Memo Job by Id
+     * **Note:** This operation is only available if 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.    Retrieves information about a specific Async Credit Memo Apply job.  
+     * @param {String} apply_async_job_id The unique ID of a Credit Memo Async Apply Job Id. For example, 8a92ade496140e830196141f6cfa0001. 
+     * @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/InvoiceSettlementAsyncJobResponse} and HTTP response
+     */
+    getApplyCreditMemoAsyncJobWithHttpInfo(apply_async_job_id, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'apply_async_job_id' is set
+      if (apply_async_job_id === undefined || apply_async_job_id === null) {
+        throw new Error("Missing the required parameter 'apply_async_job_id' when calling getApplyCreditMemoAsyncJob");
+      }
+
+      let pathParams = {
+        'applyAsyncJobId': apply_async_job_id
+      };
+      let queryParams = {
+      };
+      let 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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = InvoiceSettlementAsyncJobResponse;
+      return this.apiClient.callApi(
+        '/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Get Async Apply Credit Memo Job by Id
+     * **Note:** This operation is only available if 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.    Retrieves information about a specific Async Credit Memo Apply job.  
+     * @param {String} apply_async_job_id The unique ID of a Credit Memo Async Apply Job Id. For example, 8a92ade496140e830196141f6cfa0001. 
+     * @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/InvoiceSettlementAsyncJobResponse}
+     */
+    getApplyCreditMemoAsyncJob(apply_async_job_id, opts) {
+      return this.getApplyCreditMemoAsyncJobWithHttpInfo(apply_async_job_id, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Retrieve a credit memo
      * **Note:** This operation is only available if 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.   Retrieves the information about a specific credit memo.  For a use case of this operation, see [Get credit memo](https://www.zuora.com/developer/rest-api/general-concepts/authentication//#Get-credit-memo). 
@@ -1795,6 +1948,78 @@ export default class CreditMemosApi {
     }
 
 
+    /**
+     * Get Async Unapply Credit Memo Job by Id
+     * **Note:** This operation is only available if 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.    Retrieves information about a specific Async Credit Memo Unapply job.  
+     * @param {String} unapply_async_job_id The unique ID of a Credit Memo Async Unapply Job Id. For example, 8a92ade496140e830196148cd0af000a. 
+     * @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/InvoiceSettlementAsyncJobResponse} and HTTP response
+     */
+    getUnapplyCreditMemoAsyncJobWithHttpInfo(unapply_async_job_id, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'unapply_async_job_id' is set
+      if (unapply_async_job_id === undefined || unapply_async_job_id === null) {
+        throw new Error("Missing the required parameter 'unapply_async_job_id' when calling getUnapplyCreditMemoAsyncJob");
+      }
+
+      let pathParams = {
+        'unapplyAsyncJobId': unapply_async_job_id
+      };
+      let queryParams = {
+      };
+      let 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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = InvoiceSettlementAsyncJobResponse;
+      return this.apiClient.callApi(
+        '/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Get Async Unapply Credit Memo Job by Id
+     * **Note:** This operation is only available if 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.    Retrieves information about a specific Async Credit Memo Unapply job.  
+     * @param {String} unapply_async_job_id The unique ID of a Credit Memo Async Unapply Job Id. For example, 8a92ade496140e830196148cd0af000a. 
+     * @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/InvoiceSettlementAsyncJobResponse}
+     */
+    getUnapplyCreditMemoAsyncJob(unapply_async_job_id, opts) {
+      return this.getUnapplyCreditMemoAsyncJobWithHttpInfo(unapply_async_job_id, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Post a Credit Memo in async
      * **Note:** This operation is only available if 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. \\n\\nWhether to cancel a credit memo synchronously or asynchronously depends on the number of memo items contained in the credit memo. By default, if a credit memo contains less than 1000 items, the credit memo is canceled synchronously. Otherwise, the credit memo is canceled asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.
@@ -2182,6 +2407,84 @@ export default class CreditMemosApi {
     }
 
 
+    /**
+     * Async Unapply a credit memo
+     * **Note:** This operation is only available if 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.    Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo.   You can unapply a credit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)   When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 300,000.   The maximum number of invoices that you can specify in the request is 1,000 
+     * @param {String} credit_memo_key The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. 
+     * @param {module:model/AsyncUnapplyCreditMemoRequest} body 
+     * @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/InvoiceSettlementAsyncJobResponse} and HTTP response
+     */
+    unapplyCreditMemoAsyncWithHttpInfo(credit_memo_key, body, opts) {
+      opts = opts || {};
+      let postBody = body;
+      // verify the required parameter 'credit_memo_key' is set
+      if (credit_memo_key === undefined || credit_memo_key === null) {
+        throw new Error("Missing the required parameter 'credit_memo_key' when calling unapplyCreditMemoAsync");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling unapplyCreditMemoAsync");
+      }
+
+      let pathParams = {
+        'creditMemoKey': credit_memo_key
+      };
+      let queryParams = {
+      };
+      let 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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = ['application/json'];
+      let accepts = ['application/json'];
+      let returnType = InvoiceSettlementAsyncJobResponse;
+      return this.apiClient.callApi(
+        '/v1/credit-memos/{creditMemoKey}/unapply-async', 'PUT',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Async Unapply a credit memo
+     * **Note:** This operation is only available if 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.    Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo.   You can unapply a credit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)   When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 300,000.   The maximum number of invoices that you can specify in the request is 1,000 
+     * @param {String} credit_memo_key The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. 
+     * @param {module:model/AsyncUnapplyCreditMemoRequest} body 
+     * @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/InvoiceSettlementAsyncJobResponse}
+     */
+    unapplyCreditMemoAsync(credit_memo_key, body, opts) {
+      return this.unapplyCreditMemoAsyncWithHttpInfo(credit_memo_key, body, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Unpost a credit memo
      * **Note:** This operation is only available if 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.   Unposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft.   You can unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). 

package/src/zuora_api/api/CustomEventTriggersApi.js

@@ -24,7 +24,7 @@ import PutEventTriggerRequest from '../model/PutEventTriggerRequest';
 /**
 * CustomEventTriggers service.
 * @module api/CustomEventTriggersApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomEventTriggersApi {
 

package/src/zuora_api/api/CustomExchangeRatesApi.js

@@ -21,7 +21,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * CustomExchangeRates service.
 * @module api/CustomExchangeRatesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomExchangeRatesApi {
 

package/src/zuora_api/api/CustomObjectDefinitionsApi.js

@@ -24,7 +24,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * CustomObjectDefinitions service.
 * @module api/CustomObjectDefinitionsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomObjectDefinitionsApi {
 

package/src/zuora_api/api/CustomObjectJobsApi.js

@@ -23,7 +23,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * CustomObjectJobs service.
 * @module api/CustomObjectJobsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomObjectJobsApi {
 

package/src/zuora_api/api/CustomObjectRecordsApi.js

@@ -29,7 +29,7 @@ import QueryCustomObjectRecordsResponse from '../model/QueryCustomObjectRecordsR
 /**
 * CustomObjectRecords service.
 * @module api/CustomObjectRecordsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomObjectRecordsApi {
 

package/src/zuora_api/api/CustomPaymentMethodTypesApi.js

@@ -23,7 +23,7 @@ import UpdateOpenPaymentMethodTypeRequest from '../model/UpdateOpenPaymentMethod
 /**
 * CustomPaymentMethodTypes service.
 * @module api/CustomPaymentMethodTypesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomPaymentMethodTypesApi {
 

package/src/zuora_api/api/CustomScheduledEventsApi.js

@@ -24,7 +24,7 @@ import PutScheduledEventRequest from '../model/PutScheduledEventRequest';
 /**
 * CustomScheduledEvents service.
 * @module api/CustomScheduledEventsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class CustomScheduledEventsApi {
 

package/src/zuora_api/api/DataBackfillJobApi.js

@@ -24,7 +24,7 @@ import PUTStopBookingDateBackfillJobByIdRequest from '../model/PUTStopBookingDat
 /**
 * DataBackfillJob service.
 * @module api/DataBackfillJobApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DataBackfillJobApi {
 

package/src/zuora_api/api/DataLabelingApi.js

@@ -21,7 +21,7 @@ import SubmitDataLabelingJobResponse from '../model/SubmitDataLabelingJobRespons
 /**
 * DataLabeling service.
 * @module api/DataLabelingApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DataLabelingApi {
 

package/src/zuora_api/api/DataQueriesApi.js

@@ -25,7 +25,7 @@ import SubmitDataQueryResponse from '../model/SubmitDataQueryResponse';
 /**
 * DataQueries service.
 * @module api/DataQueriesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DataQueriesApi {
 

package/src/zuora_api/api/DebitMemosApi.js

@@ -44,7 +44,7 @@ import WriteOffDebitMemoResponse from '../model/WriteOffDebitMemoResponse';
 /**
 * DebitMemos service.
 * @module api/DebitMemosApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DebitMemosApi {
 

package/src/zuora_api/api/DeploymentApi.js

@@ -21,7 +21,7 @@ import RevertDeploymentResponse from '../model/RevertDeploymentResponse';
 /**
 * Deployment service.
 * @module api/DeploymentApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DeploymentApi {
 

package/src/zuora_api/api/DeploymentConfigurationTemplatesApi.js

@@ -26,7 +26,7 @@ import SettingSourceComponent from '../model/SettingSourceComponent';
 /**
 * DeploymentConfigurationTemplates service.
 * @module api/DeploymentConfigurationTemplatesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DeploymentConfigurationTemplatesApi {
 

package/src/zuora_api/api/DescribeApi.js

@@ -20,7 +20,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * Describe service.
 * @module api/DescribeApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class DescribeApi {
 

package/src/zuora_api/api/EInvoicingApi.js

@@ -26,7 +26,7 @@ import ServiceProviderResponse from '../model/ServiceProviderResponse';
 /**
 * EInvoicing service.
 * @module api/EInvoicingApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class EInvoicingApi {
 

package/src/zuora_api/api/ElectronicPaymentsHealthApi.js

@@ -21,7 +21,7 @@ import SystemHealthErrorResponse from '../model/SystemHealthErrorResponse';
 /**
 * ElectronicPaymentsHealth service.
 * @module api/ElectronicPaymentsHealthApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class ElectronicPaymentsHealthApi {
 

package/src/zuora_api/api/FilesApi.js

@@ -20,7 +20,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * Files service.
 * @module api/FilesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class FilesApi {
 

package/src/zuora_api/api/FulfillmentsApi.js

@@ -28,7 +28,7 @@ import UpdateFulfillmentRequest from '../model/UpdateFulfillmentRequest';
 /**
 * Fulfillments service.
 * @module api/FulfillmentsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class FulfillmentsApi {
 

package/src/zuora_api/api/HostedPagesApi.js

@@ -21,7 +21,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * HostedPages service.
 * @module api/HostedPagesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class HostedPagesApi {
 

package/src/zuora_api/api/ImportsApi.js

@@ -24,7 +24,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * Imports service.
 * @module api/ImportsApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class ImportsApi {
 

package/src/zuora_api/api/InvoiceSchedulesApi.js

@@ -27,7 +27,7 @@ import UpdateInvoiceScheduleRequest from '../model/UpdateInvoiceScheduleRequest'
 /**
 * InvoiceSchedules service.
 * @module api/InvoiceSchedulesApi
-* @version 3.5.0
+* @version 3.6.0
 */
 export default class InvoiceSchedulesApi {