zuora-sdk-js 3.6.0 → 3.7.0

package/docs/CreditMemosResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **creditmemos** | [**[CreditMemo]**](CreditMemo.md) | Container for credit memos.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/CustomEventTriggersApi.md

@@ -212,7 +212,7 @@ Name | Type | Description  | Notes
 
 Create an event trigger
 
-When you create an event trigger, you must specify the base object and define the trigger condition.  ### Specify the base object Use `baseObject` field to specify which object to define a trigger on. You can define an event trigger on any of the following objects:    * Account   * AccountingCode   * AccountingPeriod   * Amendment   * BillingRun   * Contact   * CreditBalanceAdjustment   * CreditMemo   * CreditMemoApplication   * CreditMemoApplicationItem   * CreditMemoItem   * DebitMemo   * DebitMemoItem   * Feature   * Invoice   * InvoiceAdjustment   * InvoiceItem   * InvoiceItemAdjustment   * JournalEntry   * JournalEntryItem   * Order   * OrderAction   * OrderLineItem   * Payment   * PaymentApplication   * PaymentMethod   * PaymentPart   * PaymentSchedule   * PaymentScheduleItem   * PrepaidValidityPeriodSummary   * Product   * ProductFeature   * ProductRatePlan   * ProductRatePlanCharge   * ProductRatePlanChargeTier   * RatePlan   * RatePlanCharge   * RatePlanChargeTier   * Refund   * RefundApplication   * RevenueEvent   * RevenueEventItem   * RevenueSchedule   * RevenueScheduleItem   * Subscription   * SubscriptionProductFeature   * TaxationItem   * UpdaterDetail   * Usage  #### Tenant level base objects and tenant level event triggers Zuora identifies the following base objects as the tenant level base objects:    * AccountingCode   * AccountingPeriod   * BillingRun   * Feature   * JournalEntry   * JournalEntryItem   * Product   * ProductFeature   * ProductRatePlan   * ProductRatePlanCharge   * ProductRatePlanChargeTier  Event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications.   **Note:** Tenant level event triggers and system notifications are only available in the default profile.          ### Define the trigger condition The `condition` field is a [JEXL](http://commons.apache.org/proper/commons-jexl/) expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on.  **Note:** The condition cannot contain fields from [data source](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) objects that are joined to the object that the trigger is defined on.  For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000:  ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000```  Where:    * `changeType` is a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values of `changeType` are `INSERT`, `UPDATE`,  and `Delete`.   * `Invoice.Status` is the value of the Invoice object's `Status` field after the change occurred.   * `Invoice.Status_old` is the value of the Invoice object's `Status` field before the change occurred.  In the above example, the value of `baseObject` is `Invoice`.  #### Limitations   This event trigger has the following limitations:  * The INSERT change type is not supported on RatePlan base objects.  * The INSERT change type is not supported on SubscriptionProductFeature base objects.  * When creating custom events, you cannot match fields of the RatePlanCharge object against constant values for the `condition` field. For example, the following condition will cause errors: `RatePlanCharge.ShippingProcessStatus__c == 'Shipping Confirmed'`, where `Shipping Confirmed` is a constant value.  * Fields on objects are case-sensitive. For example, `PaymentMethod.createdbyid` can result in errors. The correct format is `PaymentMethod.CreatedById`.   * A condition cannot contain fields from data source objects that are joined to the base object.  * Do not create duplicate events because they will be either merged or deleted. Zuora considers events that have the same trigger condition as duplicate events, regardless of event type names.   See [Custom Events](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Z_Custom_Events) for more information.  
+When you create an event trigger, you must specify the base object and define the trigger condition.  ### Specify the base object Use `baseObject` field to specify which object to define a trigger on. You can define an event trigger on any of the following objects:    * Account   * AccountingCode   * AccountingPeriod   * Amendment   * BillingRun   * Contact   * CreditBalanceAdjustment   * CreditMemo   * CreditMemoApplication   * CreditMemoApplicationItem   * CreditMemoItem   * DebitMemo   * DebitMemoItem   * Feature   * Invoice   * InvoiceAdjustment   * InvoiceItem   * InvoiceItemAdjustment   * JournalEntry   * JournalEntryItem   * Order   * OrderAction   * OrderLineItem   * Payment   * PaymentApplication   * PaymentMethod   * PaymentPart   * PaymentSchedule   * PaymentScheduleItem   * PrepaidValidityPeriodSummary   * Product   * ProductFeature   * ProductRatePlan   * ProductRatePlanCharge   * ProductRatePlanChargeTier   * RatePlan   * RatePlanCharge   * RatePlanChargeTier   * Refund   * RefundApplication   * RevenueEvent   * RevenueEventItem   * RevenueSchedule   * RevenueScheduleItem   * Subscription   * SubscriptionProductFeature   * TaxationItem   * UpdaterDetail   * Usage  #### Tenant level base objects and tenant level event triggers Zuora identifies the following base objects as the tenant level base objects: n  * AccountingCode   * AccountingPeriod   * BillingRun   * Feature   * JournalEntry   * JournalEntryItem   * Product   * ProductFeature   * ProductRatePlan   * ProductRatePlanCharge   * ProductRatePlanChargeTier  Event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications.   **Note:** Tenant level event triggers and system notifications are only available in the default profile.          ### Define the trigger condition The `condition` field is a [JEXL](http://commons.apache.org/proper/commons-jexl/) expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on.  **Note:** The condition cannot contain fields from [data source](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) objects that are joined to the object that the trigger is defined on.  For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000:  ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000```  Where:    * `changeType` is a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values of `changeType` are `INSERT`, `UPDATE`,  and `Delete`.   * `Invoice.Status` is the value of the Invoice object's `Status` field after the change occurred.   * `Invoice.Status_old` is the value of the Invoice object's `Status` field before the change occurred.  In the above example, the value of `baseObject` is `Invoice`.  #### Limitations   This event trigger has the following limitations: n* The INSERT change type is not supported on RatePlan base objects.  * The INSERT change type is not supported on SubscriptionProductFeature base objects. n* When creating custom events, you cannot match fields of the RatePlanCharge object against constant values for the `condition` field. For example, the following condition will cause errors: `RatePlanCharge.ShippingProcessStatus__c == 'Shipping Confirmed'`, where `Shipping Confirmed` is a constant value.  * Fields on objects are case-sensitive. For example, `PaymentMethod.createdbyid` can result in errors. The correct format is `PaymentMethod.CreatedById`.   * A condition cannot contain fields from data source objects that are joined to the base object. n* Do not create duplicate events because they will be either merged or deleted. Zuora considers events that have the same trigger condition as duplicate events, regardless of event type names.   See [Custom Events](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Z_Custom_Events) for more information.  
 
 ### Example
 

package/docs/CustomExchangeRatesApi.md

@@ -27,8 +27,8 @@ bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.CustomExchangeRatesApi();
 let currency = "currency_example"; // String | The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency.  The value must be a three-letter currency code, for example, USD.  
-let start_date = "start_date_example"; // String | Start date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date. 
-let end_date = "end_date_example"; // String | End date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date. 
+let start_date = "start_date_example"; // String | Start date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date.
+let end_date = "end_date_example"; // String | End date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -52,8 +52,8 @@ apiInstance.getCustomExchangeRates(currency, start_date, end_date, opts).then((d
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **currency** | **String**| The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency.  The value must be a three-letter currency code, for example, USD.   | 
- **start_date** | **String**| Start date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date.  | 
- **end_date** | **String**| End date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date.  | 
+ **start_date** | **String**| Start date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date. | 
+ **end_date** | **String**| End date of the date range for which you want to get exchange rates.  The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 

package/docs/CustomObjectCustomFieldDefinition.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **display_name** | **Boolean** | Indicates whether to use this field as the display name of the custom object when being linked to another custom object.  This field applies only to the Text custom field type:  - The `type` field is `string`. - The `enum` field is not specified.  | [optional] 
 **format** | **String** | The data format of the custom field | [optional] 
 **label** | **String** | The UI label of the custom field | [optional] 
-**max_length** | **Number** | The maximum length of string that can be stored in the custom field.  This field applies only to the following custom field types:  - Text:   - The `type` field is `string`.   - The `format` field is not specified or is `url`.   - The `enum` field is not specified. - Picklist:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is not specified or is `false`. - Multiselect:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is `true`.  | [optional] 
+**max_length** | **Number** | The maximum length of string that can be stored in the custom field.  nThis field applies only to the following custom field types:  - Text:  - The `type` field is `string`.   - The `format` field is not specified or is `url`.   - The `enum` field is not specified. - Picklist:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is not specified or is `false`. - Multiselect:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is `true`.  | [optional] 
 **multiselect** | **Boolean** | Indicates whether this is a multiselect custom field.  This field applies only to the Picklist or Multiselect custom field types:  - The `type` field is `string`. - The `maxLength` field is specified. - The `enum` field is specified.  | [optional] 
 **origin** | [**CustomObjectCustomFieldDefinitionOrigin**](CustomObjectCustomFieldDefinitionOrigin.md) |  | [optional] 
 **type** | **String** | The data type of the custom field | [optional] 

package/docs/CustomObjectCustomFieldDefinitionUpdate.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **display_name** | **Boolean** | Indicates whether to use this field as the display name of the custom object when being linked to another custom object.  This field applies only to the Text custom field type:  - The `type` field is `string`. - The `enum` field is not specified.  | [optional] 
 **format** | **String** | The data format of the custom field | [optional] 
 **label** | **String** | The UI label of the custom field | [optional] 
-**max_length** | **Number** | The maximum length of string that can be stored in the custom field.  This field applies only to the following custom field types:  - Text:   - The `type` field is `string`.   - The `format` field is not specified or is `url`.   - The `enum` field is not specified. - Picklist:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is not specified or is `false`. - Multiselect:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is `true`.  If the custom field is filterable, the value of `maxLength` must be 512 or less.  | [optional] 
+**max_length** | **Number** | The maximum length of string that can be stored in the custom field.  nThis field applies only to the following custom field types:  - Text:  - The `type` field is `string`.   - The `format` field is not specified or is `url`.   - The `enum` field is not specified. - Picklist:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is not specified or is `false`. - Multiselect:   - The `type` field is `string`.   - The `enum` field is specified.   - The `multiselect` field is `true`.  If the custom field is filterable, the value of `maxLength` must be 512 or less.  | [optional] 
 **multiselect** | **Boolean** | Indicates whether this is a multiselect custom field.  This field applies only to the creation of Picklist or Multiselect custom fields:  - The action `type` field is `addField`. - The definition `type` field is `string`. - The `maxLength` field is specified. - The `enum` field is specified.  | [optional] 
 **origin** | [**CustomObjectCustomFieldDefinitionUpdateOrigin**](CustomObjectCustomFieldDefinitionUpdateOrigin.md) |  | [optional] 
 **type** | **String** | The data type of the custom field | [optional] 

package/docs/CustomObjectDefinitionsApi.md

@@ -101,7 +101,7 @@ let opts = {
   'zuora_entity_ids': "zuora_entity_ids_example", // String | 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. 
   'authorization': "authorization_example", // String | 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). 
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
-  'select': "select_example", // String | If you set `select` to `type`, the response will only contain the `type` of each custom object. 
+  'select': "select_example", // String | If you set `select` to `type`, the response will only contain the `type` of each custom object.
   'zuora_org_ids': "zuora_org_ids_example" // String | 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. 
 };
 apiInstance.getAllCustomObjectDefinitionsInNamespace(opts).then((data) => {
@@ -123,7 +123,7 @@ Name | Type | Description  | Notes
  **zuora_entity_ids** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
- **select** | **String**| If you set `select` to `type`, the response will only contain the `type` of each custom object.  | [optional] 
+ **select** | **String**| If you set `select` to `type`, the response will only contain the `type` of each custom object. | [optional] 
  **zuora_org_ids** | **String**| 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.  | [optional] 
 
 ### Return type

package/docs/CustomObjectRecordsApi.md

@@ -20,7 +20,7 @@ Method | HTTP request | Description
 
 Delete a custom object record
 
-Deletes a custom object record of the given type and ID.  Note that 200 response will be returned under either of the following conditions: * The record is identified and successfully deleted * The record could not be found  Note that the record is deleted immediately and, therefore, will not be retained upon successful deletion. 
+Deletes a custom object record of the given type and ID.  Note that 200 response will be returned under either of the following conditions: * The record is identified and successfully deleted * The record could not be found nNote that the record is deleted immediately and, therefore, will not be retained upon successful deletion. 
 
 ### Example
 
@@ -106,8 +106,8 @@ let opts = {
   'zuora_entity_ids': "zuora_entity_ids_example", // String | 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. 
   'authorization': "authorization_example", // String | 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). 
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
-  'q': "q_example", // String | The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information.  Note that the `q` parameter only applies to filterable fields. 
-  'ids': "ids_example", // String | UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example:  `GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1` 
+  'q': "q_example", // String | The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information.  Note that the `q` parameter only applies to filterable fields.
+  'ids': "ids_example", // String | UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example:  `GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1`
   'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. 
   'page_size': 20, // Number | The number of records returned per page in the response. 
   'cursor': "cursor_example", // String | The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid.
@@ -133,8 +133,8 @@ Name | Type | Description  | Notes
  **zuora_entity_ids** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
- **q** | **String**| The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information.  Note that the `q` parameter only applies to filterable fields.  | [optional] 
- **ids** | **String**| UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example:  `GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1`  | [optional] 
+ **q** | **String**| The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information.  Note that the `q` parameter only applies to filterable fields. | [optional] 
+ **ids** | **String**| UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example:  `GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1` | [optional] 
  **page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.  | [optional] [default to 1]
  **page_size** | **Number**| The number of records returned per page in the response.  | [optional] [default to 20]
  **cursor** | **String**| The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid. | [optional] 
@@ -226,7 +226,7 @@ Name | Type | Description  | Notes
 
 Partially update a custom object record
 
-Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in [RFC 7386](https://tools.ietf.org/html/rfc7386).  ### Limitations   * The storage of empty strings in records is not supported. * Null values must be formatted as the following example:    ```   {     \"records\": [       {         \"fieldName__c\": null       }     ]   }   ``` 
+Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in [RFC 7386](https://tools.ietf.org/html/rfc7386). n### Limitations   * The storage of empty strings in records is not supported. * Null values must be formatted as the following example:    ```   {     \"records\": [       {         \"fieldName__c\": null       }     ]   }   ``` 
 
 ### Example
 

package/docs/CustomObjectRecordsWithError.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **Number** | See [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code) for details.  | [optional] 
+**code** | **Number** | See [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code) for details. | [optional] 
 **message** | **String** |  | [optional] 
 **record** | [**CustomObjectRecordWithAllFields**](CustomObjectRecordWithAllFields.md) |  | [optional] 
 

package/docs/CustomPaymentMethodTypesApi.md

@@ -96,8 +96,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.CustomPaymentMethodTypesApi();
-let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`. 
-let revision_number = 56; // Number | The revision number of the draft revision to be retrieved. 
+let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`.
+let revision_number = 56; // Number | The revision number of the draft revision to be retrieved.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -120,8 +120,8 @@ apiInstance.getOpenPaymentMethodTypeRevision(payment_method_type_name, revision_
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`.  | 
- **revision_number** | **Number**| The revision number of the draft revision to be retrieved.  | 
+ **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`. | 
+ **revision_number** | **Number**| The revision number of the draft revision to be retrieved. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -162,7 +162,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.CustomPaymentMethodTypesApi();
-let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`. 
+let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -185,7 +185,7 @@ apiInstance.getPublishedOpenPaymentMethodType(payment_method_type_name, opts).th
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`.  | 
+ **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -226,7 +226,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.CustomPaymentMethodTypesApi();
-let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`. 
+let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -249,7 +249,7 @@ apiInstance.publishOpenPaymentMethodType(payment_method_type_name, opts).then((d
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`.  | 
+ **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -290,7 +290,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.CustomPaymentMethodTypesApi();
-let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`. 
+let payment_method_type_name = "payment_method_type_name_example"; // String | The API name of the custom payment method type, such as `AmazonPay__c_12368`.
 let body = new ZuoraSdkJs.UpdateOpenPaymentMethodTypeRequest(); // UpdateOpenPaymentMethodTypeRequest | 
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
@@ -314,7 +314,7 @@ apiInstance.updateOpenPaymentMethodType(payment_method_type_name, body, opts).th
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`.  | 
+ **payment_method_type_name** | **String**| The API name of the custom payment method type, such as `AmazonPay__c_12368`. | 
  **body** | [**UpdateOpenPaymentMethodTypeRequest**](UpdateOpenPaymentMethodTypeRequest.md)|  | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 

package/docs/CustomRates.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**currency** | **String** | The currency code for either Reporting or Home currency.  **Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later.  | 
-**custom_fx_rate** | **Number** | The Custom FX conversion rate between Home/Reporting and Transactional currency items.  **Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later.  | 
-**rate_date** | **String** | The date on which a particular currency rate is fixed or obtained on.  **Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later.  | [optional] 
+**currency** | **String** | The currency code for either Reporting or Home currency.   **Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later. | 
+**custom_fx_rate** | **Number** | The Custom FX conversion rate between Home/Reporting and Transactional currency items.   **Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later. | 
+**rate_date** | **String** | The date on which a particular currency rate is fixed or obtained on.   **Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later. | [optional] 
 
 

package/docs/DataBackfillJobApi.md

@@ -233,7 +233,7 @@ let apiInstance = new ZuoraSdkJs.DataBackfillJobApi();
 let job_id = "job_id_example"; // String | ID of job to stop
 let opts = {
   'zuora_org_ids': "zuora_org_ids_example", // String | 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. 
-  'put_stop_booking_date_backfill_job_by_id_request': Stopping // PUTStopBookingDateBackfillJobByIdRequest | 
+  'put_stop_booking_date_backfill_job_by_id_request': {"status":"Stopping"} // PUTStopBookingDateBackfillJobByIdRequest | 
 };
 apiInstance.pUTStopDataBackfillJobById(job_id, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);

package/docs/DataLabelingApi.md

@@ -28,7 +28,7 @@ bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.DataLabelingApi();
 let authorization = "authorization_example"; // String | 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). 
-let job_id = "job_id_example"; // String | Identifier of the data labeling job. 
+let job_id = "job_id_example"; // String | Identifier of the data labeling job.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -49,7 +49,7 @@ apiInstance.getDataLabelingJob(authorization, job_id, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **String**| 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).  | 
- **job_id** | **String**| Identifier of the data labeling job.  | 
+ **job_id** | **String**| Identifier of the data labeling job. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **zuora_entity_ids** | **String**| 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.  | [optional] 

package/docs/DataQueriesApi.md

@@ -29,7 +29,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.DataQueriesApi();
-let job_id = "job_id_example"; // String | Internal identifier of the query job. 
+let job_id = "job_id_example"; // String | Internal identifier of the query job.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -52,7 +52,7 @@ apiInstance.deleteDataQueryJob(job_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **job_id** | **String**| Internal identifier of the query job.  | 
+ **job_id** | **String**| Internal identifier of the query job. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -93,7 +93,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.DataQueriesApi();
-let job_id = "job_id_example"; // String | Internal identifier of the query job. 
+let job_id = "job_id_example"; // String | Internal identifier of the query job.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -116,7 +116,7 @@ apiInstance.getDataQueryJob(job_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **job_id** | **String**| Internal identifier of the query job.  | 
+ **job_id** | **String**| Internal identifier of the query job. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -163,7 +163,7 @@ let opts = {
   'authorization': "authorization_example", // String | 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). 
   'zuora_entity_ids': "zuora_entity_ids_example", // String | 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. 
   'zuora_track_id': "zuora_track_id_example", // String | 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 (`'`). 
-  'query_status': "query_status_example", // String | Filters the list of query jobs by status. 
+  'query_status': "query_status_example", // String | Filters the list of query jobs by status.
   'page_size': 20, // Number | The number of records returned per page in the response. 
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
   'zuora_org_ids': "zuora_org_ids_example" // String | 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. 
@@ -186,7 +186,7 @@ Name | Type | Description  | Notes
  **authorization** | **String**| 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).  | [optional] 
  **zuora_entity_ids** | **String**| 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.  | [optional] 
  **zuora_track_id** | **String**| 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 (`'`).  | [optional] 
- **query_status** | **String**| Filters the list of query jobs by status.  | [optional] 
+ **query_status** | **String**| Filters the list of query jobs by status. | [optional] 
  **page_size** | **Number**| The number of records returned per page in the response.  | [optional] [default to 20]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
  **zuora_org_ids** | **String**| 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.  | [optional] 

package/docs/DataQueryJob.md

@@ -8,13 +8,13 @@ Name | Type | Description | Notes
 **id** | **String** | Internal identifier of the query job.  | [optional] 
 **query** | **String** | The query that was submitted.  | [optional] 
 **source_data** | [**SubmitDataQueryRequestSourceData**](SubmitDataQueryRequestSourceData.md) |  | [optional] 
-**remaining_retries** | **Number** | The number of times that Zuora will retry the query if Zuora is unable to perform the query.  | [optional] 
+**remaining_retries** | **Number** | The number of times that Zuora will retry the query if Zuora is unable to perform the query. | [optional] 
 **updated_on** | **Date** | Date and time when the query job was last updated, in ISO 8601 format.  | [optional] 
 **use_index_join** | **Boolean** | Indicates whether to use Index Join.  | [optional] 
-**data_file** | **String** | The URL of the query results. Only applicable if the value of the `queryStatus` field is `completed`.  | [optional] 
-**output_rows** | **Number** | The number of rows the query results. Only applicable if the value of the `queryStatus` field is `completed`.  | [optional] 
-**processing_time** | **Number** | Processing time of the query job, in milliseconds. Only applicable if the value of the `queryStatus` field is `completed`.  | [optional] 
-**query_status** | **String** | Status of the query job.  * `submitted` - query submitted to query service for processing * `accepted` - query accepted by the query service * `in_progress` - query executed by the query service * `completed` - query execution completed by the query service * `failed` - query unable to be processed by the query service * `cancelled` - query cancelled by the user  If the value of this field is `completed`, the `dataFile` field contains the location of the query results.  If the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](#operation/Delete_DataQueryJob) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`.  | [optional] 
+**data_file** | **String** | The URL of the query results. Only applicable if the value of the `queryStatus` field is `completed`. | [optional] 
+**output_rows** | **Number** | The number of rows the query results. Only applicable if the value of the `queryStatus` field is `completed`. | [optional] 
+**processing_time** | **Number** | Processing time of the query job, in milliseconds. Only applicable if the value of the `queryStatus` field is `completed`. | [optional] 
+**query_status** | **String** | Status of the query job.   * `submitted` - query submitted to query service for processing  * `accepted` - query accepted by the query service  * `in_progress` - query executed by the query service  * `completed` - query execution completed by the query service  * `failed` - query unable to be processed by the query service  * `cancelled` - query cancelled by the user   If the value of this field is `completed`, the `dataFile` field contains the location of the query results.   If the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](#operation/Delete_DataQueryJob) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`. | [optional] 
 
 
 

package/docs/DataQueryJobCancelled.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **id** | **String** | Internal identifier of the query job.  | [optional] 
 **query** | **String** | The query that was submitted.  | [optional] 
 **source_data** | [**SubmitDataQueryRequestSourceData**](SubmitDataQueryRequestSourceData.md) |  | [optional] 
-**remaining_retries** | **Number** | The number of times that Zuora will retry the query if Zuora is unable to perform the query.  | [optional] 
+**remaining_retries** | **Number** | The number of times that Zuora will retry the query if Zuora is unable to perform the query. | [optional] 
 **updated_on** | **Date** | Date and time when the query job was last updated, in ISO 8601 format.  | [optional] 
 **use_index_join** | **Boolean** | Indicates whether to use Index Join.  | [optional] 
 **query_status** | **String** | Status of the query job.  | [optional] 

package/docs/DataQueryJobCommon.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **id** | **String** | Internal identifier of the query job.  | [optional] 
 **query** | **String** | The query that was submitted.  | [optional] 
 **source_data** | [**SubmitDataQueryRequestSourceData**](SubmitDataQueryRequestSourceData.md) |  | [optional] 
-**remaining_retries** | **Number** | The number of times that Zuora will retry the query if Zuora is unable to perform the query.  | [optional] 
+**remaining_retries** | **Number** | The number of times that Zuora will retry the query if Zuora is unable to perform the query. | [optional] 
 **updated_on** | **Date** | Date and time when the query job was last updated, in ISO 8601 format.  | [optional] 
 **use_index_join** | **Boolean** | Indicates whether to use Index Join.  | [optional] 
 

package/docs/DebitMemo.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **account_id** | **String** | The ID of the customer account associated with the debit memo. | [optional] 
 **account_number** | **String** | The number of the customer account associated with the debit memo. | [optional] 
 **amount** | **Number** | The total amount of the debit memo. | [optional] 

package/docs/DebitMemoDueDate.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**due_date** | **String** | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.  | [optional] 
-**id** | **String** | The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001.  | [optional] 
-**memo_key** | **String** | The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001. If `memoKey` is set, `id` will be ignored.  | [optional] 
+**due_date** | **String** | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. | [optional] 
+**id** | **String** | The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001. | [optional] 
+**memo_key** | **String** | The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001. If `memoKey` is set, `id` will be ignored. | [optional] 
 
 

package/docs/DebitMemoItemFromChargeDetailFinanceInformation.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability. | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. | [optional] 
 **revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
 
 

package/docs/DebitMemoItemFromInvoiceItemFinanceInformation.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability. | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. | [optional] 
 **revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
 
 

package/docs/DebitMemoItemResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **amount** | **Number** | The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax. | [optional] 
 **amount_without_tax** | **Number** | The debit memo item amount excluding tax. | [optional] 
 **applied_to_item_id** | **String** | The parent debit memo item that this debit memo items is applied to if this item is discount. | [optional] 

package/docs/DebitMemoItemTaxationItems.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**[GetDebitMemoTaxItemNew]**](GetDebitMemoTaxItemNew.md) | List of taxation items.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 
 

package/docs/DebitMemoItemsResponse.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **items** | [**[DebitMemoItem]**](DebitMemoItem.md) | Container for debit memo items.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 
 

package/docs/DebitMemoObjectNSFields.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 
 

package/docs/DebitMemoResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **account_id** | **String** | The ID of the customer account associated with the debit memo. | [optional] 
 **account_number** | **String** | The number of the customer account associated with the debit memo. | [optional] 
 **amount** | **Number** | The total amount of the debit memo. | [optional] 
@@ -53,8 +53,8 @@ Name | Type | Description | Notes
 **organization_label** | **String** | organization label.  | [optional] 
 **currency** | **String** | Currency code. | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the debit memo. | [optional] 
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional]