zuora-sdk-js 3.3.0 → 3.4.0

package/docs/Job.md

@@ -0,0 +1,34 @@
+# ZuoraSdkJs.Job
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Job id | [optional] 
+**import_type** | [**JobType**](JobType.md) |  | [optional] 
+**uploaded_file_id** | **String** | Id of uploaded file | [optional] 
+**uploaded_file_name** | **String** | Name of uploaded file | [optional] 
+**uploaded_file_url** | **String** |  | [optional] 
+**uploaded_file_size** | **String** |  | [optional] 
+**input_file_size** | **Number** |  | [optional] 
+**output_size** | **String** |  | [optional] 
+**output_type** | **String** |  | [optional] 
+**output_file_size** | **Number** |  | [optional] 
+**uploaded_by** | **String** |  | [optional] 
+**uploaded_on** | **Date** |  | [optional] 
+**completed_on** | **Date** |  | [optional] 
+**started_processing_on** | **Date** |  | [optional] 
+**result_file_id** | **String** |  | [optional] 
+**result_file_name** | **String** |  | [optional] 
+**result_file_url** | **String** |  | [optional] 
+**total_count** | **Number** |  | [optional] 
+**failed_count** | **Number** |  | [optional] 
+**status** | [**DataBackfillJobStatus**](DataBackfillJobStatus.md) |  | [optional] 
+**failure_message** | **String** |  | [optional] 
+**processed_count** | **Number** |  | [optional] 
+**success_count** | **Number** |  | [optional] 
+**remaining_time** | **Number** |  | [optional] 
+**remaining_time_text** | **String** |  | [optional] 
+**completed_percentage** | **Number** |  | [optional] 
+
+

package/docs/JobStatus.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.JobStatus
+
+## Enum
+
+
+* `Processing` (value: `"Processing"`)
+
+* `Failed` (value: `"Failed"`)
+
+* `Completed` (value: `"Completed"`)
+
+

package/docs/JobType.md

@@ -0,0 +1,16 @@
+# ZuoraSdkJs.JobType
+
+## Enum
+
+
+* `ProductRatePlanCharge` (value: `"ProductRatePlanCharge"`)
+
+* `RatePlanCharge` (value: `"RatePlanCharge"`)
+
+* `InvoiceDetail` (value: `"InvoiceDetail"`)
+
+* `MemoDetail` (value: `"MemoDetail"`)
+
+* `InvoiceItemAdjustment` (value: `"InvoiceItemAdjustment"`)
+
+

package/docs/JournalEntryItemType.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.JournalEntryItemType
+
+## Enum
+
+
+* `Credit` (value: `"Credit"`)
+
+* `Debit` (value: `"Debit"`)
+
+

package/docs/JournalEntryStatus.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.JournalEntryStatus
+
+## Enum
+
+
+* `Created` (value: `"Created"`)
+
+* `Cancelled` (value: `"Cancelled"`)
+
+

package/docs/JournalRunStatus.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.JournalRunStatus
+
+## Enum
+
+
+* `Pending` (value: `"Pending"`)
+
+* `Processing` (value: `"Processing"`)
+
+* `Completed` (value: `"Completed"`)
+
+* `Error` (value: `"Error"`)
+
+* `CancelInprogress` (value: `"CancelInprogress"`)
+
+* `Cancelled` (value: `"Cancelled"`)
+
+* `DeleteInprogress` (value: `"DeleteInprogress"`)
+
+

package/docs/JournalRunTransactionType.md

@@ -0,0 +1,64 @@
+# ZuoraSdkJs.JournalRunTransactionType
+
+## Enum
+
+
+* `Invoice Item` (value: `"Invoice Item"`)
+
+* `Taxation Item` (value: `"Taxation Item"`)
+
+* `Invoice Item Adjustment (Invoice)` (value: `"Invoice Item Adjustment (Invoice)"`)
+
+* `Invoice Item Adjustment (Tax)` (value: `"Invoice Item Adjustment (Tax)"`)
+
+* `Invoice Adjustment` (value: `"Invoice Adjustment"`)
+
+* `Electronic Payment` (value: `"Electronic Payment"`)
+
+* `External Payment` (value: `"External Payment"`)
+
+* `Electronic Refund` (value: `"Electronic Refund"`)
+
+* `External Refund` (value: `"External Refund"`)
+
+* `Electronic Credit Balance Payment` (value: `"Electronic Credit Balance Payment"`)
+
+* `External Credit Balance Payment` (value: `"External Credit Balance Payment"`)
+
+* `Electronic Credit Balance Refund` (value: `"Electronic Credit Balance Refund"`)
+
+* `External Credit Balance Refund` (value: `"External Credit Balance Refund"`)
+
+* `Credit Balance Adjustment (Applied from Credit Balance)` (value: `"Credit Balance Adjustment (Applied from Credit Balance)"`)
+
+* `Credit Balance Adjustment (Transferred to Credit Balance)` (value: `"Credit Balance Adjustment (Transferred to Credit Balance)"`)
+
+* `Revenue Event Item` (value: `"Revenue Event Item"`)
+
+* `Debit Memo Item (Charge)` (value: `"Debit Memo Item (Charge)"`)
+
+* `Debit Memo Item (Tax)` (value: `"Debit Memo Item (Tax)"`)
+
+* `Credit Memo Item (Charge)` (value: `"Credit Memo Item (Charge)"`)
+
+* `Credit Memo Item (Tax)` (value: `"Credit Memo Item (Tax)"`)
+
+* `Credit Memo Application Item` (value: `"Credit Memo Application Item"`)
+
+* `Electronic Payment Application` (value: `"Electronic Payment Application"`)
+
+* `External Payment Application` (value: `"External Payment Application"`)
+
+* `Electronic Refund Application` (value: `"Electronic Refund Application"`)
+
+* `External Refund Application` (value: `"External Refund Application"`)
+
+* `Electronic Payment Application Item` (value: `"Electronic Payment Application Item"`)
+
+* `External Payment Application Item` (value: `"External Payment Application Item"`)
+
+* `Electronic Refund Application Item` (value: `"Electronic Refund Application Item"`)
+
+* `External Refund Application Item` (value: `"External Refund Application Item"`)
+
+

package/docs/JournalRunsApi.md

@@ -0,0 +1,270 @@
+# ZuoraSdkJs.JournalRunsApi
+
+All URIs are relative to *https://rest.zuora.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancelJournalRun**](JournalRunsApi.md#cancelJournalRun) | **PUT** /v1/journal-runs/{jr-number}/cancel | Cancel a journal run
+[**createJournalRun**](JournalRunsApi.md#createJournalRun) | **POST** /v1/journal-runs | Create a journal run
+[**deleteJournalRun**](JournalRunsApi.md#deleteJournalRun) | **DELETE** /v1/journal-runs/{jr-number} | Delete a journal run
+[**getJournalRun**](JournalRunsApi.md#getJournalRun) | **GET** /v1/journal-runs/{jr-number} | Retrieve a journal run
+
+
+
+## cancelJournalRun
+
+> CommonResponse cancelJournalRun(jr_number, opts)
+
+Cancel a journal run
+
+This reference describes how to cancel a journal run using the REST API.            The summary journal entries in the journal run are canceled asynchronously. See the \"Example\" section below for details.            You must have the \"Cancel Journal Run\" Zuora Finance user permission enabled to cancel journal runs.  ### Notes When you cancel a journal run, the summary journal entries associated with that journal run are canceled asynchronously. A response of `{ \"success\": true }` means only that the specified journal run has a status of \"Pending\", \"Error\", or \"Completed\" and therefore can be canceled, but does not mean that the whole journal run was successfully canceled.  For example, let's say you want to cancel journal run JR-00000075. The journal run status is \"Completed\" and it contains ten journal entries. One of the journal entries has its Transferred to Accounting status set to \"Yes\", meaning that the entry cannot be canceled. The workflow might go as follows: 1. You make an API call to cancel the journal run. 2. The journal run status is \"Completed\", so you receive a response of `{ \"success\": true }`. 3. Zuora begins asynchronously canceling journal entries associated with the journal run. The journal entry whose Transferred to Accounting status is \"Yes\" fails to be canceled. The cancelation process continues, and the other journal entries are successfully canceled. 4. The journal run status remains as \"Completed\". The status does not change to \"Canceled\" because the journal run still contains a journey entry that is not canceled. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.JournalRunsApi();
+let jr_number = "jr_number_example"; // String | Journal run number. Must be a valid journal run number in the format JR-00000001.  You can only cancel a journal run whose status is \"Pending\", \"Error\", or \"Completed\". 
+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. 
+  '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_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 (`'`). 
+  '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_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. 
+};
+apiInstance.cancelJournalRun(jr_number, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jr_number** | **String**| Journal run number. Must be a valid journal run number in the format JR-00000001.  You can only cancel a journal run whose status is \"Pending\", \"Error\", or \"Completed\".  | 
+ **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] 
+ **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] 
+ **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_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] 
+
+### Return type
+
+[**CommonResponse**](CommonResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## createJournalRun
+
+> CreateJournalRunResponse createJournalRun(request, opts)
+
+Create a journal run
+
+This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.JournalRunsApi();
+let request = new ZuoraSdkJs.CreateJournalRunRequest(); // CreateJournalRunRequest | 
+let opts = {
+  'idempotency_key': "idempotency_key_example", // String | 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.  
+  '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. 
+  '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_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 (`'`). 
+  '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_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. 
+};
+apiInstance.createJournalRun(request, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**CreateJournalRunRequest**](CreateJournalRunRequest.md)|  | 
+ **idempotency_key** | **String**| 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.   | [optional] 
+ **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] 
+ **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] 
+ **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_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] 
+
+### Return type
+
+[**CreateJournalRunResponse**](CreateJournalRunResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deleteJournalRun
+
+> CommonResponse deleteJournalRun(jr_number, opts)
+
+Delete a journal run
+
+This reference describes how to delete a journal run using the REST API.                         You can only delete journal runs that have already been canceled.                         You must have the \"Delete Cancelled Journal Run\" Zuora Finance user permission enabled to delete journal runs. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.JournalRunsApi();
+let jr_number = "jr_number_example"; // String | Journal run number. Must be a valid journal run number in the format `JR-00000001`. 
+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. 
+  '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_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 (`'`). 
+  '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_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. 
+};
+apiInstance.deleteJournalRun(jr_number, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jr_number** | **String**| Journal run number. Must be a valid journal run number in the format `JR-00000001`.  | 
+ **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] 
+ **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] 
+ **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_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] 
+
+### Return type
+
+[**CommonResponse**](CommonResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getJournalRun
+
+> GetJournalRunResponse getJournalRun(jr_number, opts)
+
+Retrieve a journal run
+
+This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.JournalRunsApi();
+let jr_number = "jr_number_example"; // String | Journal run number. Must be a valid journal run number in the format `JR-00000001`. 
+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. 
+  '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_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 (`'`). 
+  '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_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. 
+};
+apiInstance.getJournalRun(jr_number, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jr_number** | **String**| Journal run number. Must be a valid journal run number in the format `JR-00000001`.  | 
+ **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] 
+ **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] 
+ **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_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] 
+
+### Return type
+
+[**GetJournalRunResponse**](GetJournalRunResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/LastTerm.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.LastTerm
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period** | **Number** | Specify only when the termType is 'TERMED'. | [optional] 
+**period_type** | [**TermPeriodType**](TermPeriodType.md) |  | [optional] 
+**start_date** | **String** | The start date of the current term. You can change the term start date of a renewed subscription through a T&Cs order action. However, when changing it to an earlier date, this date must not be earlier than the term start date of the current term before this T&Cs.  | [optional] 
+**end_date** | **String** | End date of the current term, in YYYY-MM-DD format.  | [optional] 
+**term_type** | [**TermType**](TermType.md) |  | 
+
+

package/docs/Linkage.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.Linkage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**linkage_type** | [**LinkageLinkageType**](LinkageLinkageType.md) |  | [optional] 
+**source_task_id** | **Number** | the task that spawned the target task | [optional] 
+**source_workflow_id** | **Number** | the workflow the target task is associated with | [optional] 
+**target_task_id** | **Number** | the task that the source task is linked to. | [optional] 
+
+

package/docs/LinkageLinkageType.md

@@ -0,0 +1,22 @@
+# ZuoraSdkJs.LinkageLinkageType
+
+## Enum
+
+
+* `Start` (value: `"Start"`)
+
+* `Success` (value: `"Success"`)
+
+* `Failure` (value: `"Failure"`)
+
+* `Iterate` (value: `"Iterate"`)
+
+* `True` (value: `"True"`)
+
+* `False` (value: `"False"`)
+
+* `Approve` (value: `"Approve"`)
+
+* `Reject` (value: `"Reject"`)
+
+

package/docs/ListAllSettingsResponse.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.ListAllSettingsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**settings** | [**[SettingItemWithOperationsInformation]**](SettingItemWithOperationsInformation.md) |  | [optional] 
+
+

package/docs/ListOfExchangeRates.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.ListOfExchangeRates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**CURRENCY** | **String** | The exchange rate on the **providerExchangeRateDate**. The field name is the ISO currency code of the currency, for example, `EUR`.  There may be more than one currency returned for a given **providerExchangeRateDate**. If the rate for a certain currency is not available on the **providerExchangeRateDate**, the currency is not returned in the response.  | [optional] 
+**provider_exchange_rate_date** | **String** | The date of the exchange rate used. The date is in `yyyy-mm-dd` format.  Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.  | [optional] 
+
+

package/docs/ListPriceBase.md

@@ -0,0 +1,18 @@
+# ZuoraSdkJs.ListPriceBase
+
+## Enum
+
+
+* `Billing Period` (value: `"Per Billing Period"`)
+
+* `Month` (value: `"Per Month"`)
+
+* `Week` (value: `"Per Week"`)
+
+* `Year` (value: `"Per Year"`)
+
+* `Specific Months` (value: `"Per Specific Months"`)
+
+* `Validity Period` (value: `"Per Validity Period"`)
+
+

package/docs/MappingResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.MappingResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mapping** | **Object** |  | [optional] 
+**dateformat** | **String** |  | [optional] [default to 'DD-MM-YYYY']
+
+