zuora-sdk-js 3.2.1 → 3.3.0-beta.1

package/src/zuora_api/api/ObjectQueriesApi.js

@@ -26,6 +26,7 @@ import ExpandedDebitMemo from '../model/ExpandedDebitMemo';
 import ExpandedDebitMemoItem from '../model/ExpandedDebitMemoItem';
 import ExpandedInvoice from '../model/ExpandedInvoice';
 import ExpandedInvoiceItem from '../model/ExpandedInvoiceItem';
+import ExpandedInvoiceSchedule from '../model/ExpandedInvoiceSchedule';
 import ExpandedOrderAction from '../model/ExpandedOrderAction';
 import ExpandedOrderLineItem from '../model/ExpandedOrderLineItem';
 import ExpandedOrders from '../model/ExpandedOrders';
@@ -47,6 +48,7 @@ import ExpandedProductRatePlanChargeTier from '../model/ExpandedProductRatePlanC
 import ExpandedRatePlan from '../model/ExpandedRatePlan';
 import ExpandedRatePlanCharge from '../model/ExpandedRatePlanCharge';
 import ExpandedRatePlanChargeTier from '../model/ExpandedRatePlanChargeTier';
+import ExpandedRatingDetail from '../model/ExpandedRatingDetail';
 import ExpandedRatingResult from '../model/ExpandedRatingResult';
 import ExpandedRefund from '../model/ExpandedRefund';
 import ExpandedRefundApplication from '../model/ExpandedRefundApplication';
@@ -70,6 +72,7 @@ import QueryDailyConsumptionSummarysResponse from '../model/QueryDailyConsumptio
 import QueryDebitMemoItemsResponse from '../model/QueryDebitMemoItemsResponse';
 import QueryDebitMemosResponse from '../model/QueryDebitMemosResponse';
 import QueryInvoiceItemsResponse from '../model/QueryInvoiceItemsResponse';
+import QueryInvoiceSchedulesResponse from '../model/QueryInvoiceSchedulesResponse';
 import QueryInvoicesResponse from '../model/QueryInvoicesResponse';
 import QueryOrderActionsResponse from '../model/QueryOrderActionsResponse';
 import QueryOrderLineItemsResponse from '../model/QueryOrderLineItemsResponse';
@@ -92,6 +95,7 @@ import QueryProductsResponse from '../model/QueryProductsResponse';
 import QueryRatePlanChargeTiersResponse from '../model/QueryRatePlanChargeTiersResponse';
 import QueryRatePlanChargesResponse from '../model/QueryRatePlanChargesResponse';
 import QueryRatePlansResponse from '../model/QueryRatePlansResponse';
+import QueryRatingDetailsResponse from '../model/QueryRatingDetailsResponse';
 import QueryRatingResultsResponse from '../model/QueryRatingResultsResponse';
 import QueryRefundApplicationItemsResponse from '../model/QueryRefundApplicationItemsResponse';
 import QueryRefundApplicationsResponse from '../model/QueryRefundApplicationsResponse';
@@ -106,7 +110,7 @@ import QueryValidityPeriodSummarysResponse from '../model/QueryValidityPeriodSum
 /**
 * ObjectQueries service.
 * @module api/ObjectQueriesApi
-* @version 3.2.1
+* @version 3.3.0-beta.1
 */
 export default class ObjectQueriesApi {
 
@@ -124,7 +128,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Account by key with filters, expands, sort capabilities. Supported expands: billto,soldto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
+     * Query Account by key with filters, expands, sort capabilities. Supported expands: billto,soldto,shipto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
      * @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.  
@@ -183,7 +187,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Account by key with filters, expands, sort capabilities. Supported expands: billto,soldto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
+     * Query Account by key with filters, expands, sort capabilities. Supported expands: billto,soldto,shipto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
      * @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.  
@@ -209,7 +213,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Accounts with filters, expands, sort capabilities. Supported expands: billto,soldto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
+     * Query Accounts with filters, expands, sort capabilities. Supported expands: billto,soldto,shipto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
      * @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. 
@@ -262,7 +266,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Accounts with filters, expands, sort capabilities. Supported expands: billto,soldto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
+     * Query Accounts with filters, expands, sort capabilities. Supported expands: billto,soldto,shipto,defaultpaymentmethod,subscriptions,payments,refunds,creditmemos,debitmemos,invoices,usages,paymentmethods,subscriptions.rateplans,subscriptions.rateplans.rateplancharges.
      * @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. 
@@ -1024,7 +1028,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query CreditMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query CreditMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,credittaxationitems.
      * @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.  
@@ -1083,7 +1087,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query CreditMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query CreditMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,credittaxationitems.
      * @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.  
@@ -1109,7 +1113,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query CreditMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query CreditMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,credittaxationitems.
      * @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. 
@@ -1162,7 +1166,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query CreditMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query CreditMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,credittaxationitems.
      * @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. 
@@ -1690,7 +1694,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query DebitMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query DebitMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,debittaxationitems.
      * @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.  
@@ -1749,7 +1753,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query DebitMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query DebitMemoItem by key with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,debittaxationitems.
      * @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.  
@@ -1775,7 +1779,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query DebitMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query DebitMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,debittaxationitems.
      * @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. 
@@ -1828,7 +1832,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query DebitMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge.
+     * Query DebitMemoItems with filters, expands, sort capabilities. Supported expands: subscription,rateplancharge,subscriptionowner,debittaxationitems.
      * @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. 
@@ -2016,7 +2020,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query InvoiceItem by key with filters, expands, sort capabilities. Supported expands: invoice,subscription,taxationitems,rateplancharge,orderlineitem.
+     * Query InvoiceItem by key with filters, expands, sort capabilities. Supported expands: invoice,subscription,subscriptionowner,taxationitems,rateplancharge,orderlineitem.
      * @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.  
@@ -2075,7 +2079,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query InvoiceItem by key with filters, expands, sort capabilities. Supported expands: invoice,subscription,taxationitems,rateplancharge,orderlineitem.
+     * Query InvoiceItem by key with filters, expands, sort capabilities. Supported expands: invoice,subscription,subscriptionowner,taxationitems,rateplancharge,orderlineitem.
      * @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.  
@@ -2101,7 +2105,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query InvoiceItems with filters, expands, sort capabilities. Supported expands: invoice,subscription,taxationitems,rateplancharge,orderlineitem.
+     * Query InvoiceItems with filters, expands, sort capabilities. Supported expands: invoice,subscription,subscriptionowner,taxationitems,rateplancharge,orderlineitem.
      * @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. 
@@ -2154,7 +2158,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query InvoiceItems with filters, expands, sort capabilities. Supported expands: invoice,subscription,taxationitems,rateplancharge,orderlineitem.
+     * Query InvoiceItems with filters, expands, sort capabilities. Supported expands: invoice,subscription,subscriptionowner,taxationitems,rateplancharge,orderlineitem.
      * @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. 
@@ -2178,6 +2182,169 @@ export default class ObjectQueriesApi {
     }
 
 
+    /**
+     * Query InvoiceSchedule by key with filters, expands, sort capabilities. Supported expands: invoicescheduleitems,invoicescheduleitems.invoice,invoicescheduleitems.creditmemo,rateplancharges.
+     * @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 = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedInvoiceSchedule} and HTTP response
+     */
+    queryInvoiceScheduleByKeyWithHttpInfo(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 queryInvoiceScheduleByKey");
+      }
+
+      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')
+      };
+      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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = ExpandedInvoiceSchedule;
+      return this.apiClient.callApi(
+        '/object-query/invoice-schedules/{key}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Query InvoiceSchedule by key with filters, expands, sort capabilities. Supported expands: invoicescheduleitems,invoicescheduleitems.invoice,invoicescheduleitems.creditmemo,rateplancharges.
+     * @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.   (default to '2024-05-20')
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ExpandedInvoiceSchedule}
+     */
+    queryInvoiceScheduleByKey(key, opts) {
+      return this.queryInvoiceScheduleByKeyWithHttpInfo(key, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Query InvoiceSchedules with filters, expands, sort capabilities. Supported expands: invoicescheduleitems,invoicescheduleitems.invoice,invoicescheduleitems.creditmemo,rateplancharges.
+     * @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 = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryInvoiceSchedulesResponse} and HTTP response
+     */
+    queryInvoiceSchedulesWithHttpInfo(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')
+      };
+      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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = QueryInvoiceSchedulesResponse;
+      return this.apiClient.callApi(
+        '/object-query/invoice-schedules', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Query InvoiceSchedules with filters, expands, sort capabilities. Supported expands: invoicescheduleitems,invoicescheduleitems.invoice,invoicescheduleitems.creditmemo,rateplancharges.
+     * @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.   (default to '2024-05-20')
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QueryInvoiceSchedulesResponse}
+     */
+    queryInvoiceSchedules(opts) {
+      return this.queryInvoiceSchedulesWithHttpInfo(opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Query Invoices with filters, expands, sort capabilities. Supported expands: account,billtocontact,invoiceitems,invoiceitems.subscription,invoiceitems.subscription.account.
      * @param {Object} opts Optional parameters
@@ -2909,7 +3076,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Payment by key with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications.
+     * Query Payment by key with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications,paymentscheduleitempayments,paymentscheduleitempayments.paymentscheduleitem.
      * @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.  
@@ -2968,7 +3135,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Payment by key with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications.
+     * Query Payment by key with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications,paymentscheduleitempayments,paymentscheduleitempayments.paymentscheduleitem.
      * @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.  
@@ -3568,7 +3735,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query PaymentScheduleItem by key with filters, expands, sort capabilities. Supported expands: N/A.
+     * Query PaymentScheduleItem by key with filters, expands, sort capabilities. Supported expands: paymentscheduleitempayments,paymentscheduleitempayments.payment.
      * @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.  
@@ -3627,7 +3794,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query PaymentScheduleItem by key with filters, expands, sort capabilities. Supported expands: N/A.
+     * Query PaymentScheduleItem by key with filters, expands, sort capabilities. Supported expands: paymentscheduleitempayments,paymentscheduleitempayments.payment.
      * @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.  
@@ -3653,7 +3820,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query PaymentScheduleItems with filters, expands, sort capabilities. Supported expands: N/A.
+     * Query PaymentScheduleItems with filters, expands, sort capabilities. Supported expands: paymentscheduleitempayments,paymentscheduleitempayments.payment.
      * @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. 
@@ -3706,7 +3873,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query PaymentScheduleItems with filters, expands, sort capabilities. Supported expands: N/A.
+     * Query PaymentScheduleItems with filters, expands, sort capabilities. Supported expands: paymentscheduleitempayments,paymentscheduleitempayments.payment.
      * @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. 
@@ -3809,7 +3976,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Payments with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications.
+     * Query Payments with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications,paymentscheduleitempayments,paymentscheduleitempayments.paymentscheduleitem.
      * @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. 
@@ -3862,7 +4029,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Payments with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications.
+     * Query Payments with filters, expands, sort capabilities. Supported expands: account,account.billto,account.soldto,paymentmethod,paymentapplications,paymentscheduleitempayments,paymentscheduleitempayments.paymentscheduleitem.
      * @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. 
@@ -5679,6 +5846,169 @@ export default class ObjectQueriesApi {
     }
 
 
+    /**
+     * Query RatingDetail by key with filters, expands, sort capabilities. Supported expands: N/A.
+     * @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 = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ExpandedRatingDetail} and HTTP response
+     */
+    queryRatingDetailByKeyWithHttpInfo(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 queryRatingDetailByKey");
+      }
+
+      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')
+      };
+      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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = ExpandedRatingDetail;
+      return this.apiClient.callApi(
+        '/object-query/rating-details/{key}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Query RatingDetail by key with filters, expands, sort capabilities. Supported expands: N/A.
+     * @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.   (default to '2024-05-20')
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ExpandedRatingDetail}
+     */
+    queryRatingDetailByKey(key, opts) {
+      return this.queryRatingDetailByKeyWithHttpInfo(key, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Query RatingDetails with filters, expands, sort capabilities. Supported expands: N/A.
+     * @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 = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueryRatingDetailsResponse} and HTTP response
+     */
+    queryRatingDetailsWithHttpInfo(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')
+      };
+      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']
+      };
+      let formParams = {
+      };
+
+      let authNames = ['bearerAuth'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = QueryRatingDetailsResponse;
+      return this.apiClient.callApi(
+        '/object-query/rating-details', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Query RatingDetails with filters, expands, sort capabilities. Supported expands: N/A.
+     * @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.   (default to '2024-05-20')
+     * @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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QueryRatingDetailsResponse}
+     */
+    queryRatingDetails(opts) {
+      return this.queryRatingDetailsWithHttpInfo(opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Query RatingResult by key with filters, expands, sort capabilities. Supported expands: account,rateplancharge,subscription,invoiceitem.
      * @param {String} key Object ID or Number.
@@ -6332,7 +6662,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Subscription by key with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.paymentmethods,order.
+     * Query Subscription by key with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.shipto,account.paymentmethods,order.
      * @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.  
@@ -6391,7 +6721,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Subscription by key with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.paymentmethods,order.
+     * Query Subscription by key with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.shipto,account.paymentmethods,order.
      * @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.  
@@ -6417,7 +6747,7 @@ export default class ObjectQueriesApi {
 
 
     /**
-     * Query Subscriptions with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.paymentmethods,order.
+     * Query Subscriptions with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.shipto,account.paymentmethods,order.
      * @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. 
@@ -6470,7 +6800,7 @@ export default class ObjectQueriesApi {
     }
 
     /**
-     * Query Subscriptions with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.paymentmethods,order.
+     * Query Subscriptions with filters, expands, sort capabilities. Supported expands: account,invoiceowner,billtocontact,invoiceitems,rateplans,rateplans.rateplancharges,rateplans.rateplancharges.rateplanchargetiers,account.billto,account.soldto,account.shipto,account.paymentmethods,order.
      * @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.