zuora-sdk-js 3.17.0 → 3.18.0-beta.2

package/src/zuora_api/api/ObjectQueriesApi.js

@@ -18,6 +18,7 @@ import ExpandedAccount from '../model/ExpandedAccount';
 import ExpandedAmendment from '../model/ExpandedAmendment';
 import ExpandedBillingRun from '../model/ExpandedBillingRun';
 import ExpandedBundle from '../model/ExpandedBundle';
+import ExpandedChildCommitment from '../model/ExpandedChildCommitment';
 import ExpandedCommitment from '../model/ExpandedCommitment';
 import ExpandedCommitmentAssociatedAccount from '../model/ExpandedCommitmentAssociatedAccount';
 import ExpandedCommitmentAssociatedItem from '../model/ExpandedCommitmentAssociatedItem';
@@ -78,6 +79,7 @@ import QueryAccountsResponse from '../model/QueryAccountsResponse';
 import QueryAmendmentsResponse from '../model/QueryAmendmentsResponse';
 import QueryBillingRunsResponse from '../model/QueryBillingRunsResponse';
 import QueryBundlesResponse from '../model/QueryBundlesResponse';
+import QueryChildCommitmentsResponse from '../model/QueryChildCommitmentsResponse';
 import QueryCommitmentAssociatedAccountsResponse from '../model/QueryCommitmentAssociatedAccountsResponse';
 import QueryCommitmentAssociatedItemsResponse from '../model/QueryCommitmentAssociatedItemsResponse';
 import QueryCommitmentPeriodsResponse from '../model/QueryCommitmentPeriodsResponse';
@@ -138,7 +140,7 @@ import QueryValidityPeriodSummarysResponse from '../model/QueryValidityPeriodSum
 /**
 * ObjectQueries service.
 * @module api/ObjectQueriesApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class ObjectQueriesApi {
 
@@ -879,6 +881,187 @@ export default class ObjectQueriesApi {
     }
 
 
+    /**
+     * Query ChildCommitment by key with filters, expands, sort capabilities. Supported expands: childcommitment.
+     * @param {String} key Object ID or Number.
+     * @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} [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} [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_version] 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. 
+     * @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
+     * @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
+     * @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
+     * @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
+     * @param {Array.<String>} [filter] A case-sensitive filter on the list.
+     * @param {Array.<String>} [fields] A case-insensitive query parameter that allows you to specify which fields are returned in the response.
+     * @param {Boolean} [include_null_fields] An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedChildCommitment} and HTTP response
+     */
+    queryChildCommitmentByKeyWithHttpInfo(key, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'key' is set
+      if (key === undefined || key === null) {
+        throw new Error("Missing the required parameter 'key' when calling queryChildCommitmentByKey");
+      }
+
+      let pathParams = {
+        'key': key
+      };
+      let queryParams = {
+        'pageSize': opts['page_size'],
+        'cursor': opts['cursor'],
+        'sort[]': this.apiClient.buildCollectionParam(opts['sort'], 'multi'),
+        'expand[]': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),
+        'filter[]': this.apiClient.buildCollectionParam(opts['filter'], 'multi'),
+        'fields[]': this.apiClient.buildCollectionParam(opts['fields'], 'multi'),
+        'includeNullFields': opts['include_null_fields']
+      };
+      let headerParams = {
+        'Idempotency-Key': opts['idempotency_key'],
+        'Accept-Encoding': opts['accept_encoding'],
+        'Content-Encoding': opts['content_encoding'],
+        'Zuora-Track-Id': opts['zuora_track_id'],
+        'Zuora-Entity-Ids': opts['zuora_entity_ids'],
+        'Authorization': opts['authorization'],
+        '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 = ExpandedChildCommitment;
+      return this.apiClient.callApi(
+        '/object-query/child-commitments/{key}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Query ChildCommitment by key with filters, expands, sort capabilities. Supported expands: childcommitment.
+     * @param {String} key Object ID or Number.
+     * @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.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.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_version The minor version of the Zuora REST API.  
+     * @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. 
+     * @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
+     * @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
+     * @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
+     * @param {Array.<String>} opts.expand Allows you to expand responses by including related object information in a single call.
+     * @param {Array.<String>} opts.filter A case-sensitive filter on the list.
+     * @param {Array.<String>} opts.fields A case-insensitive query parameter that allows you to specify which fields are returned in the response.
+     * @param {Boolean} opts.include_null_fields An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ExpandedChildCommitment}
+     */
+    queryChildCommitmentByKey(key, opts) {
+      return this.queryChildCommitmentByKeyWithHttpInfo(key, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Query ChildCommitments with filters, expands, sort capabilities. Supported expands: childcommitment.
+     * @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} [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} [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_version] 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. 
+     * @param {Number} [page_size] The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
+     * @param {String} [cursor] A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
+     * @param {Array.<String>} [sort] A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
+     * @param {Array.<String>} [expand] Allows you to expand responses by including related object information in a single call.
+     * @param {Array.<String>} [filter] A case-sensitive filter on the list.
+     * @param {Array.<String>} [fields] A case-insensitive query parameter that allows you to specify which fields are returned in the response.
+     * @param {Boolean} [include_null_fields] An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryChildCommitmentsResponse} and HTTP response
+     */
+    queryChildCommitmentsWithHttpInfo(opts) {
+      opts = opts || {};
+      let postBody = null;
+
+      let pathParams = {
+      };
+      let queryParams = {
+        'pageSize': opts['page_size'],
+        'cursor': opts['cursor'],
+        'sort[]': this.apiClient.buildCollectionParam(opts['sort'], 'multi'),
+        'expand[]': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),
+        'filter[]': this.apiClient.buildCollectionParam(opts['filter'], 'multi'),
+        'fields[]': this.apiClient.buildCollectionParam(opts['fields'], 'multi'),
+        'includeNullFields': opts['include_null_fields']
+      };
+      let headerParams = {
+        'Idempotency-Key': opts['idempotency_key'],
+        'Accept-Encoding': opts['accept_encoding'],
+        'Content-Encoding': opts['content_encoding'],
+        'Zuora-Track-Id': opts['zuora_track_id'],
+        'Zuora-Entity-Ids': opts['zuora_entity_ids'],
+        'Authorization': opts['authorization'],
+        '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 = QueryChildCommitmentsResponse;
+      return this.apiClient.callApi(
+        '/object-query/child-commitments', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Query ChildCommitments with filters, expands, sort capabilities. Supported expands: childcommitment.
+     * @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.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.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_version The minor version of the Zuora REST API.  
+     * @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. 
+     * @param {Number} opts.page_size The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
+     * @param {String} opts.cursor A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
+     * @param {Array.<String>} opts.sort A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
+     * @param {Array.<String>} opts.expand Allows you to expand responses by including related object information in a single call.
+     * @param {Array.<String>} opts.filter A case-sensitive filter on the list.
+     * @param {Array.<String>} opts.fields A case-insensitive query parameter that allows you to specify which fields are returned in the response.
+     * @param {Boolean} opts.include_null_fields An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QueryChildCommitmentsResponse}
+     */
+    queryChildCommitments(opts) {
+      return this.queryChildCommitmentsWithHttpInfo(opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Query CommitmentAssociatedAccount by key with filters, expands, sort capabilities. Supported expands: commitment,account.
      * @param {String} key Object ID or Number.
@@ -1242,7 +1425,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Commitment by key with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments.
+     * Query Commitment by key with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments,childcommitments,childcommitments.childcommitment.
      * @param {String} key Object ID or Number.
      * @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.  
@@ -1307,7 +1490,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Commitment by key with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments.
+     * Query Commitment by key with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments,childcommitments,childcommitments.childcommitment.
      * @param {String} key Object ID or Number.
      * @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.  
@@ -1879,7 +2062,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Commitments with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments.
+     * Query Commitments with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments,childcommitments,childcommitments.childcommitment.
      * @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. 
@@ -1938,7 +2121,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Commitments with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments.
+     * Query Commitments with filters, expands, sort capabilities. Supported expands: commitmentowner,account,commitmentschedules,commitmentschedules.commitmentperiods,commitmentassociatedaccounts,commitmentassociatedaccounts.account,commitmentassociateditems,commitmentassociateditems.invoiceowner,commitmentschedules.prepaymentdefinitions,commitmentschedules.commitmentperiods.prepayments,childcommitments,childcommitments.childcommitment.
      * @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. 

package/src/zuora_api/api/OmniChannelSubscriptionsApi.js

@@ -23,7 +23,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * OmniChannelSubscriptions service.
 * @module api/OmniChannelSubscriptionsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class OmniChannelSubscriptionsApi {
 

package/src/zuora_api/api/OperationsApi.js

@@ -28,7 +28,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * Operations service.
 * @module api/OperationsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 export default class OrderLineItemsApi {
 

package/src/zuora_api/api/OrdersApi.js

@@ -42,7 +42,7 @@ import UpdateSubscriptionCustomFieldsRequest from '../model/UpdateSubscriptionCu
 /**
 * Orders service.
 * @module api/OrdersApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class OrdersApi {
 

package/src/zuora_api/api/PaymentAuthorizationApi.js

@@ -24,7 +24,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentAuthorization service.
 * @module api/PaymentAuthorizationApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 export default class PaymentGatewayReconciliationApi {
 

package/src/zuora_api/api/PaymentGatewaysApi.js

@@ -23,7 +23,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentGateways service.
 * @module api/PaymentGatewaysApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class PaymentGatewaysApi {
 

package/src/zuora_api/api/PaymentMethodSnapshotsApi.js

@@ -22,7 +22,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * PaymentMethodSnapshots service.
 * @module api/PaymentMethodSnapshotsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 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.17.0
+* @version 3.18.0-beta.2
 */
 export default class PaymentTransactionLogsApi {
 

package/src/zuora_api/api/PaymentsApi.js

@@ -36,7 +36,7 @@ import UpdatePaymentRequest from '../model/UpdatePaymentRequest';
 /**
 * Payments service.
 * @module api/PaymentsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class PaymentsApi {
 

package/src/zuora_api/api/ProductRatePlanChargeTiersApi.js

@@ -24,7 +24,7 @@ import UpdateProductRatePlanChargeTierRequest from '../model/UpdateProductRatePl
 /**
 * ProductRatePlanChargeTiers service.
 * @module api/ProductRatePlanChargeTiersApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class ProductRatePlanChargeTiersApi {
 

package/src/zuora_api/api/ProductRatePlanChargesApi.js

@@ -28,7 +28,7 @@ import UpdateProductRatePlanChargeRequest from '../model/UpdateProductRatePlanCh
 /**
 * ProductRatePlanCharges service.
 * @module api/ProductRatePlanChargesApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class ProductRatePlanChargesApi {
 

package/src/zuora_api/api/ProductRatePlansApi.js

@@ -28,7 +28,7 @@ import UpdateProductRatePlanRequest from '../model/UpdateProductRatePlanRequest'
 /**
 * ProductRatePlans service.
 * @module api/ProductRatePlansApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class ProductRatePlansApi {
 

package/src/zuora_api/api/ProductsApi.js

@@ -27,7 +27,7 @@ import UpdateProductRequest from '../model/UpdateProductRequest';
 /**
 * Products service.
 * @module api/ProductsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class ProductsApi {
 

package/src/zuora_api/api/RSASignaturesApi.js

@@ -24,7 +24,7 @@ import RSASignatureResponse from '../model/RSASignatureResponse';
 /**
 * RSASignatures service.
 * @module api/RSASignaturesApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RSASignaturesApi {
 

package/src/zuora_api/api/RampsApi.js

@@ -25,7 +25,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * Ramps service.
 * @module api/RampsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RampsApi {
 

package/src/zuora_api/api/RatePlansApi.js

@@ -21,7 +21,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * RatePlans service.
 * @module api/RatePlansApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RatePlansApi {
 

package/src/zuora_api/api/RefundsApi.js

@@ -28,7 +28,7 @@ import UpdateRefundRequest from '../model/UpdateRefundRequest';
 /**
 * Refunds service.
 * @module api/RefundsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RefundsApi {
 

package/src/zuora_api/api/RegenerateApi.js

@@ -23,7 +23,7 @@ import RegenerateTransactionObjectResponse from '../model/RegenerateTransactionO
 /**
 * Regenerate service.
 * @module api/RegenerateApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RegenerateApi {
 

package/src/zuora_api/api/RevenueAccountingCodesApi.js

@@ -22,7 +22,7 @@ import RevproAccountingCodes from '../model/RevproAccountingCodes';
 /**
 * RevenueAccountingCodes service.
 * @module api/RevenueAccountingCodesApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RevenueAccountingCodesApi {
 

package/src/zuora_api/api/RevenueIntegrationApi.js

@@ -54,7 +54,7 @@ import UploadRevenueFileResponse from '../model/UploadRevenueFileResponse';
 /**
 * RevenueIntegration service.
 * @module api/RevenueIntegrationApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class RevenueIntegrationApi {
 

package/src/zuora_api/api/SequenceSetsApi.js

@@ -26,7 +26,7 @@ import UpdateSequenceSetResponse from '../model/UpdateSequenceSetResponse';
 /**
 * SequenceSets service.
 * @module api/SequenceSetsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SequenceSetsApi {
 

package/src/zuora_api/api/SettingsApi.js

@@ -22,7 +22,7 @@ import SettingsBatchResponse from '../model/SettingsBatchResponse';
 /**
 * Settings service.
 * @module api/SettingsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SettingsApi {
 

package/src/zuora_api/api/SignUpApi.js

@@ -22,7 +22,7 @@ import SignUpResponse from '../model/SignUpResponse';
 /**
 * SignUp service.
 * @module api/SignUpApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SignUpApi {
 

package/src/zuora_api/api/SubscriptionChangeLogsApi.js

@@ -22,7 +22,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * SubscriptionChangeLogs service.
 * @module api/SubscriptionChangeLogsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SubscriptionChangeLogsApi {
 

package/src/zuora_api/api/SubscriptionsApi.js

@@ -41,7 +41,7 @@ import UpdateSubscriptionResponse from '../model/UpdateSubscriptionResponse';
 /**
 * Subscriptions service.
 * @module api/SubscriptionsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SubscriptionsApi {
 

package/src/zuora_api/api/SummaryJournalEntriesApi.js

@@ -27,7 +27,7 @@ import UpdateJournalEntryWorkflowRequest from '../model/UpdateJournalEntryWorkfl
 /**
 * SummaryJournalEntries service.
 * @module api/SummaryJournalEntriesApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SummaryJournalEntriesApi {
 

package/src/zuora_api/api/SummaryStatementsApi.js

@@ -19,7 +19,7 @@ import ProxyUnauthorizedResponse from '../model/ProxyUnauthorizedResponse';
 /**
 * SummaryStatements service.
 * @module api/SummaryStatementsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class SummaryStatementsApi {
 

package/src/zuora_api/api/TaxationItemsApi.js

@@ -25,7 +25,7 @@ import UpdateTaxationItemRequest from '../model/UpdateTaxationItemRequest';
 /**
 * TaxationItems service.
 * @module api/TaxationItemsApi
-* @version 3.17.0
+* @version 3.18.0-beta.2
 */
 export default class TaxationItemsApi {