zuora-sdk-js 3.2.1 → 3.3.0

package/src/zuora_api/api/OmniChannelSubscriptionsApi.js

@@ -0,0 +1,264 @@
+/**
+ * Zuora API Reference
+ * REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
+ *
+ * The version of the OpenAPI document: 2024-05-20
+ * Contact: docs@zuora.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+
+import ApiClient from "../ApiClient";
+import CommonErrorResponse from '../model/CommonErrorResponse';
+import CommonResponse from '../model/CommonResponse';
+import CreateOmniChannelSubscriptionRequest from '../model/CreateOmniChannelSubscriptionRequest';
+import CreateOmniChannelSubscriptionResponse from '../model/CreateOmniChannelSubscriptionResponse';
+import GetOmniChannelSubscriptionResponse from '../model/GetOmniChannelSubscriptionResponse';
+import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
+
+/**
+* OmniChannelSubscriptions service.
+* @module api/OmniChannelSubscriptionsApi
+* @version 3.3.0
+*/
+export default class OmniChannelSubscriptionsApi {
+
+    /**
+    * Constructs a new OmniChannelSubscriptionsApi. 
+    * @alias module:api/OmniChannelSubscriptionsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient) {
+        this.apiClient = apiClient || ApiClient.instance;
+    }
+
+
+
+    /**
+     * Create a subscription
+     * This REST API reference describes how to create or update Omni Channel Subscription for a customer account. You can also create a new customer account and assign it to the new Omni Channel Subscription. 
+     * @param {module:model/CreateOmniChannelSubscriptionRequest} request 
+     * @param {Object} opts Optional parameters
+     * @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
+     * @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/CreateOmniChannelSubscriptionResponse} and HTTP response
+     */
+    createOmniChannelSubscriptionWithHttpInfo(request, opts) {
+      opts = opts || {};
+      let postBody = request;
+      // verify the required parameter 'request' is set
+      if (request === undefined || request === null) {
+        throw new Error("Missing the required parameter 'request' when calling createOmniChannelSubscription");
+      }
+
+      let pathParams = {
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+        'Idempotency-Key': opts['idempotency_key'],
+        '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 = CreateOmniChannelSubscriptionResponse;
+      return this.apiClient.callApi(
+        '/v1/omni-channel-subscriptions', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Create a subscription
+     * This REST API reference describes how to create or update Omni Channel Subscription for a customer account. You can also create a new customer account and assign it to the new Omni Channel Subscription. 
+     * @param {module:model/CreateOmniChannelSubscriptionRequest} request 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
+     * @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/CreateOmniChannelSubscriptionResponse}
+     */
+    createOmniChannelSubscription(request, opts) {
+      return this.createOmniChannelSubscriptionWithHttpInfo(request, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Delete an Omni Channel Subscription
+     * Deletes a specified Omni Channel Subscription.
+     * @param {String} subscription_key The key of the Omni Channel Subscription to be deleted.
+     * @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/CommonResponse} and HTTP response
+     */
+    deleteOmniChannelSubscriptionWithHttpInfo(subscription_key, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'subscription_key' is set
+      if (subscription_key === undefined || subscription_key === null) {
+        throw new Error("Missing the required parameter 'subscription_key' when calling deleteOmniChannelSubscription");
+      }
+
+      let pathParams = {
+        'subscriptionKey': subscription_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 = [];
+      let accepts = ['application/json'];
+      let returnType = CommonResponse;
+      return this.apiClient.callApi(
+        '/v1/omni-channel-subscriptions/{subscriptionKey}', 'DELETE',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Delete an Omni Channel Subscription
+     * Deletes a specified Omni Channel Subscription.
+     * @param {String} subscription_key The key of the Omni Channel Subscription to be deleted.
+     * @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/CommonResponse}
+     */
+    deleteOmniChannelSubscription(subscription_key, opts) {
+      return this.deleteOmniChannelSubscriptionWithHttpInfo(subscription_key, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Retrieve an Omni Channel Subscription
+     * Retrieves the information about a specific Omni Channel Subscription. 
+     * @param {String} subscription_key The key of the Omni Channel Subscription to be retrieved.
+     * @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 {Boolean} [get_account_details] Retrieves the details of an account of the Order.
+     * @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/GetOmniChannelSubscriptionResponse} and HTTP response
+     */
+    getOmniChannelSubscriptionWithHttpInfo(subscription_key, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'subscription_key' is set
+      if (subscription_key === undefined || subscription_key === null) {
+        throw new Error("Missing the required parameter 'subscription_key' when calling getOmniChannelSubscription");
+      }
+
+      let pathParams = {
+        'subscriptionKey': subscription_key
+      };
+      let queryParams = {
+        'getAccountDetails': opts['get_account_details']
+      };
+      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 = GetOmniChannelSubscriptionResponse;
+      return this.apiClient.callApi(
+        '/v1/omni-channel-subscriptions/{subscriptionKey}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Retrieve an Omni Channel Subscription
+     * Retrieves the information about a specific Omni Channel Subscription. 
+     * @param {String} subscription_key The key of the Omni Channel Subscription to be retrieved.
+     * @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 {Boolean} opts.get_account_details Retrieves the details of an account of the Order.
+     * @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/GetOmniChannelSubscriptionResponse}
+     */
+    getOmniChannelSubscription(subscription_key, opts) {
+      return this.getOmniChannelSubscriptionWithHttpInfo(subscription_key, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+}

package/src/zuora_api/api/OperationsApi.js

@@ -28,7 +28,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * Operations service.
 * @module api/OperationsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class OperationsApi {
 

package/src/zuora_api/api/OrderActionsApi.js

@@ -21,7 +21,7 @@ import UpdateOrderActionRequest from '../model/UpdateOrderActionRequest';
 /**
 * OrderActions service.
 * @module api/OrderActionsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class OrderActionsApi {
 

package/src/zuora_api/api/OrderLineItemsApi.js

@@ -24,7 +24,7 @@ import UpdateOrderLineItemRequest from '../model/UpdateOrderLineItemRequest';
 /**
 * OrderLineItems service.
 * @module api/OrderLineItemsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class OrderLineItemsApi {
 

package/src/zuora_api/api/OrdersApi.js

@@ -21,6 +21,7 @@ import CreateOrderAsyncRequest from '../model/CreateOrderAsyncRequest';
 import CreateOrderAsyncResponse from '../model/CreateOrderAsyncResponse';
 import CreateOrderRequest from '../model/CreateOrderRequest';
 import CreateOrderResponse from '../model/CreateOrderResponse';
+import DeleteOrderAsyncResponse from '../model/DeleteOrderAsyncResponse';
 import GetAsyncOrderJobResponse from '../model/GetAsyncOrderJobResponse';
 import GetOrderResponse from '../model/GetOrderResponse';
 import GetOrdersResponse from '../model/GetOrdersResponse';
@@ -40,7 +41,7 @@ import UpdateSubscriptionCustomFieldsRequest from '../model/UpdateSubscriptionCu
 /**
 * Orders service.
 * @module api/OrdersApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class OrdersApi {
 
@@ -429,6 +430,81 @@ export default class OrdersApi {
     }
 
 
+    /**
+     * Async Delete an order
+     * **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend\" target=\"_blank\">Subscribe and Amend</a> customer, we recommend you enable <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization\" target=\"_blank\">Orders Harmonization</a> to access the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders\" target=\"_blank\">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders\" target=\"_blank\">new features</a> on Zuora Billing.  **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.          Deletes a specified order.   * All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.   * All the order line items created in this order are deleted.  You are not allowed to delete an order if the charges that are affected by this order are invoiced. 
+     * @param {String} order_number The number of the order to be deleted.
+     * @param {Object} opts Optional parameters
+     * @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
+     * @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/DeleteOrderAsyncResponse} and HTTP response
+     */
+    deleteOrderAsynchronouslyWithHttpInfo(order_number, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'order_number' is set
+      if (order_number === undefined || order_number === null) {
+        throw new Error("Missing the required parameter 'order_number' when calling deleteOrderAsynchronously");
+      }
+
+      let pathParams = {
+        'orderNumber': order_number
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+        'Idempotency-Key': opts['idempotency_key'],
+        '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 = DeleteOrderAsyncResponse;
+      return this.apiClient.callApi(
+        '/v1/async/orders/{orderNumber}', 'DELETE',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Async Delete an order
+     * **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend\" target=\"_blank\">Subscribe and Amend</a> customer, we recommend you enable <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization\" target=\"_blank\">Orders Harmonization</a> to access the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders\" target=\"_blank\">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders\" target=\"_blank\">new features</a> on Zuora Billing.  **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.          Deletes a specified order.   * All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.   * All the order line items created in this order are deleted.  You are not allowed to delete an order if the charges that are affected by this order are invoiced. 
+     * @param {String} order_number The number of the order to be deleted.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
+     * @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/DeleteOrderAsyncResponse}
+     */
+    deleteOrderAsynchronously(order_number, opts) {
+      return this.deleteOrderAsynchronouslyWithHttpInfo(order_number, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Retrieve the status and response of a job
      * **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend\" target=\"_blank\">Subscribe and Amend</a> customer, we recommend you enable <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization\" target=\"_blank\">Orders Harmonization</a> to access the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders\" target=\"_blank\">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders\" target=\"_blank\">new features</a> on Zuora Billing.  **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.         Get the status and response of an asynchronous job. Currently, an asynchronous job created by \"Create an order asynchronously\" or \"Preview an order asynchronously\" is supported. 

package/src/zuora_api/api/PaymentAuthorizationApi.js

@@ -24,7 +24,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentAuthorization service.
 * @module api/PaymentAuthorizationApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentAuthorizationApi {
 

package/src/zuora_api/api/PaymentGatewayReconciliationApi.js

@@ -26,7 +26,7 @@ import SettlePaymentRequest from '../model/SettlePaymentRequest';
 /**
 * PaymentGatewayReconciliation service.
 * @module api/PaymentGatewayReconciliationApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentGatewayReconciliationApi {
 

package/src/zuora_api/api/PaymentGatewaysApi.js

@@ -15,13 +15,15 @@
 import ApiClient from "../ApiClient";
 import CommonErrorResponse from '../model/CommonErrorResponse';
 import CommonResponse from '../model/CommonResponse';
+import CreatePaymentPredebitNotifyRequest from '../model/CreatePaymentPredebitNotifyRequest';
+import CreatePaymentPredebitNotifyResponse from '../model/CreatePaymentPredebitNotifyResponse';
 import PaymentGatewaysResponse from '../model/PaymentGatewaysResponse';
 import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 
 /**
 * PaymentGateways service.
 * @module api/PaymentGatewaysApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentGatewaysApi {
 
@@ -38,6 +40,77 @@ export default class PaymentGatewaysApi {
 
 
 
+    /**
+     * Trigger a pre-debit notification
+     * Triggers a pre-debit notification for an invoice and sends a request to the gateway. This is currently applicable/functional ONLY for the Adyen payment gateway. 
+     * @param {module:model/CreatePaymentPredebitNotifyRequest} 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/CreatePaymentPredebitNotifyResponse} and HTTP response
+     */
+    createPredebitNotificationWithHttpInfo(request, opts) {
+      opts = opts || {};
+      let postBody = request;
+      // verify the required parameter 'request' is set
+      if (request === undefined || request === null) {
+        throw new Error("Missing the required parameter 'request' when calling createPredebitNotification");
+      }
+
+      let pathParams = {
+      };
+      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 = CreatePaymentPredebitNotifyResponse;
+      return this.apiClient.callApi(
+        '/v1/payment-gateways/pre-debit-notification', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Trigger a pre-debit notification
+     * Triggers a pre-debit notification for an invoice and sends a request to the gateway. This is currently applicable/functional ONLY for the Adyen payment gateway. 
+     * @param {module:model/CreatePaymentPredebitNotifyRequest} 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/CreatePaymentPredebitNotifyResponse}
+     */
+    createPredebitNotification(request, opts) {
+      return this.createPredebitNotificationWithHttpInfo(request, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * List all payment gateways
      * Retrieves the basic information about all the payment gateways. 
@@ -76,7 +149,7 @@ export default class PaymentGatewaysApi {
       let accepts = ['application/json'];
       let returnType = PaymentGatewaysResponse;
       return this.apiClient.callApi(
-        '/v1/paymentgateways', 'GET',
+        '/v1/payment-gateways', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         authNames, contentTypes, accepts, returnType, null
       );

package/src/zuora_api/api/PaymentMethodSnapshotsApi.js

@@ -22,7 +22,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentMethodSnapshots service.
 * @module api/PaymentMethodSnapshotsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentMethodSnapshotsApi {
 

package/src/zuora_api/api/PaymentMethodTransactionLogsApi.js

@@ -22,7 +22,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentMethodTransactionLogs service.
 * @module api/PaymentMethodTransactionLogsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentMethodTransactionLogsApi {
 

package/src/zuora_api/api/PaymentMethodUpdaterApi.js

@@ -23,7 +23,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentMethodUpdater service.
 * @module api/PaymentMethodUpdaterApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentMethodUpdaterApi {
 

package/src/zuora_api/api/PaymentMethodsApi.js

@@ -34,7 +34,7 @@ import VerifyPaymentMethodResponse from '../model/VerifyPaymentMethodResponse';
 /**
 * PaymentMethods service.
 * @module api/PaymentMethodsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentMethodsApi {
 

package/src/zuora_api/api/PaymentRunsApi.js

@@ -26,7 +26,7 @@ import UpdatePaymentRunRequest from '../model/UpdatePaymentRunRequest';
 /**
 * PaymentRuns service.
 * @module api/PaymentRunsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentRunsApi {
 

package/src/zuora_api/api/PaymentSchedulesApi.js

@@ -34,7 +34,7 @@ import UpdatePaymentScheduleRequest from '../model/UpdatePaymentScheduleRequest'
 /**
 * PaymentSchedules service.
 * @module api/PaymentSchedulesApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentSchedulesApi {
 

package/src/zuora_api/api/PaymentTransactionLogsApi.js

@@ -22,7 +22,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentTransactionLogs service.
 * @module api/PaymentTransactionLogsApi
-* @version 3.2.1
+* @version 3.3.0
 */
 export default class PaymentTransactionLogsApi {