npm - @novu/api - Versions diffs - 1.6.1-rc.0 → 1.7.0 - Mend

@novu/api 1.6.1-rc.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (266) hide show

package/docs/sdks/groups/README.md CHANGED Viewed

@@ -5,8 +5,8 @@
 ### Available Operations
-* [delete](#delete) - Delete translation group
-* [retrieve](#retrieve) - Get translation group
+* [delete](#delete) - Delete a translation group
+* [retrieve](#retrieve) - Retrieve a translation group
 ## delete
@@ -23,7 +23,7 @@ const novu = new Novu({
 });
 async function run() {
-  await novu.translations.groups.delete("workflow", "<id>");
+  await novu.translations.groups.delete("workflow", "welcome-email");
 }
@@ -46,7 +46,7 @@ const novu = new NovuCore({
 });
 async function run() {
-  const res = await translationsGroupsDelete(novu, "workflow", "<id>");
+  const res = await translationsGroupsDelete(novu, "workflow", "welcome-email");
   if (res.ok) {
     const { value: result } = res;
@@ -60,14 +60,14 @@ run();
 ### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `resourceType`                                                                                                                                                                 | [operations.ResourceType](../../models/operations/resourcetype.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | Resource type                                                                                                                                                                  |
-| `resourceId`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Resource ID                                                                                                                                                                    |
-| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    | Example                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `resourceType`                                                                                                                                                                 | [operations.ResourceType](../../models/operations/resourcetype.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | Resource type                                                                                                                                                                  | [object Object]                                                                                                                                                                |
+| `resourceId`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Resource ID                                                                                                                                                                    | [object Object]                                                                                                                                                                |
+| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |                                                                                                                                                                                |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |                                                                                                                                                                                |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |                                                                                                                                                                                |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |                                                                                                                                                                                |
 ### Response
@@ -81,7 +81,7 @@ run();
 ## retrieve
-Retrieves a single translation group by resourceId and resourceType
+Retrieves a single translation group by resource type (workflow) and resource ID (workflowId)
 ### Example Usage
@@ -94,7 +94,7 @@ const novu = new Novu({
 });
 async function run() {
-  const result = await novu.translations.groups.retrieve("workflow", "<id>");
+  const result = await novu.translations.groups.retrieve("workflow", "welcome-email");
   console.log(result);
 }
@@ -117,7 +117,7 @@ const novu = new NovuCore({
 });
 async function run() {
-  const res = await translationsGroupsRetrieve(novu, "workflow", "<id>");
+  const res = await translationsGroupsRetrieve(novu, "workflow", "welcome-email");
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -131,14 +131,14 @@ run();
 ### Parameters
-| Parameter                                                                                                                                                                            | Type                                                                                                                                                                                 | Required                                                                                                                                                                             | Description                                                                                                                                                                          |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `resourceType`                                                                                                                                                                       | [operations.TranslationControllerGetTranslationGroupEndpointPathParamResourceType](../../models/operations/translationcontrollergettranslationgroupendpointpathparamresourcetype.md) | :heavy_check_mark:                                                                                                                                                                   | Resource type                                                                                                                                                                        |
-| `resourceId`                                                                                                                                                                         | *string*                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                   | Resource ID                                                                                                                                                                          |
-| `idempotencyKey`                                                                                                                                                                     | *string*                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                   | A header for idempotency purposes                                                                                                                                                    |
-| `options`                                                                                                                                                                            | RequestOptions                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                   | Used to set various options for making HTTP requests.                                                                                                                                |
-| `options.fetchOptions`                                                                                                                                                               | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.       |
-| `options.retries`                                                                                                                                                                    | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                   | Enables retrying HTTP requests under certain failure conditions.                                                                                                                     |
+| Parameter                                                                                                                                                                            | Type                                                                                                                                                                                 | Required                                                                                                                                                                             | Description                                                                                                                                                                          | Example                                                                                                                                                                              |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `resourceType`                                                                                                                                                                       | [operations.TranslationControllerGetTranslationGroupEndpointPathParamResourceType](../../models/operations/translationcontrollergettranslationgroupendpointpathparamresourcetype.md) | :heavy_check_mark:                                                                                                                                                                   | Resource type                                                                                                                                                                        | [object Object]                                                                                                                                                                      |
+| `resourceId`                                                                                                                                                                         | *string*                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                   | Resource ID                                                                                                                                                                          | [object Object]                                                                                                                                                                      |
+| `idempotencyKey`                                                                                                                                                                     | *string*                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                   | A header for idempotency purposes                                                                                                                                                    |                                                                                                                                                                                      |
+| `options`                                                                                                                                                                            | RequestOptions                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                   | Used to set various options for making HTTP requests.                                                                                                                                |                                                                                                                                                                                      |
+| `options.fetchOptions`                                                                                                                                                               | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.       |                                                                                                                                                                                      |
+| `options.retries`                                                                                                                                                                    | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                   | Enables retrying HTTP requests under certain failure conditions.                                                                                                                     |                                                                                                                                                                                      |
 ### Response

package/docs/sdks/master/README.md CHANGED Viewed

@@ -5,13 +5,13 @@
 ### Available Operations
-* [retrieve](#retrieve) - Get master translations JSON
+* [retrieve](#retrieve) - Retrieve master translations JSON
 * [import](#import) - Import master translations JSON
 * [upload](#upload) - Upload master translations JSON file
 ## retrieve
-Get all translations for a locale in master JSON format organized by namespace and resource
+Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)
 ### Example Usage
@@ -81,7 +81,7 @@ run();
 ## import
-Import translations from master JSON format for a specific locale
+Import translations for multiple workflows from master JSON format for a specific locale
 ### Example Usage
@@ -157,7 +157,7 @@ run();
 ## upload
-Upload a master JSON file containing translations. Locale is automatically detected from filename (e.g., en_US.json)
+Upload a master JSON file containing translations for multiple workflows. Locale is automatically detected from filename (e.g., en_US.json)
 ### Example Usage

package/docs/sdks/preferences/README.md CHANGED Viewed

@@ -103,7 +103,74 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.preferences.update({
-    channels: {},
+    schedule: {
+      isEnabled: true,
+      weeklySchedule: {
+        monday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        tuesday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        wednesday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        thursday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        friday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        saturday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        sunday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+      },
+    },
   }, "<id>");
   console.log(result);
@@ -128,7 +195,74 @@ const novu = new NovuCore({
 async function run() {
   const res = await subscribersPreferencesUpdate(novu, {
-    channels: {},
+    schedule: {
+      isEnabled: true,
+      weeklySchedule: {
+        monday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        tuesday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        wednesday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        thursday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        friday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        saturday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+        sunday: {
+          isEnabled: true,
+          hours: [
+            {
+              start: "09:00 AM",
+              end: "05:00 PM",
+            },
+          ],
+        },
+      },
+    },
   }, "<id>");
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/translations/README.md CHANGED Viewed

@@ -8,14 +8,14 @@ Used to localize your notifications to different languages.
 ### Available Operations
-* [create](#create) - Create or update translation
-* [retrieve](#retrieve) - Get single translation
-* [delete](#delete) - Delete translation
+* [create](#create) - Create a translation
+* [retrieve](#retrieve) - Retrieve a translation
+* [delete](#delete) - Delete a translation
 * [upload](#upload) - Upload translation files
 ## create
-Create or update a translation for a specific workflow and locale
+Create a translation for a specific workflow and locale, if the translation already exists, it will be updated
 ### Example Usage
@@ -95,7 +95,7 @@ run();
 ## retrieve
-Get a specific translation by resource type, resource ID and locale
+Retrieve a specific translation by resource type, resource ID and locale
 ### Example Usage
@@ -110,8 +110,8 @@ const novu = new Novu({
 async function run() {
   const result = await novu.translations.retrieve({
     resourceType: "workflow",
-    resourceId: "<id>",
-    locale: "fi",
+    resourceId: "welcome-email",
+    locale: "en_US",
   });
   console.log(result);
@@ -137,8 +137,8 @@ const novu = new NovuCore({
 async function run() {
   const res = await translationsRetrieve(novu, {
     resourceType: "workflow",
-    resourceId: "<id>",
-    locale: "fi",
+    resourceId: "welcome-email",
+    locale: "en_US",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -249,7 +249,7 @@ run();
 ## upload
-Upload one or more JSON translation files for a specific workflow. The file name must be the locale, e.g. en_US.json
+Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json
 ### Example Usage
@@ -307,7 +307,7 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `uploadTranslationsRequestDto`                                                                                                                                                 | [components.UploadTranslationsRequestDto](../../models/components/uploadtranslationsrequestdto.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | Translation upload details                                                                                                                                                     |
+| `uploadTranslationsRequestDto`                                                                                                                                                 | [components.UploadTranslationsRequestDto](../../models/components/uploadtranslationsrequestdto.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | Translation files upload body details                                                                                                                                          |
 | `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |

package/examples/package-lock.json CHANGED Viewed

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@novu/api",
-      "version": "1.6.1-rc.0",
+      "version": "1.7.0",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/funcs/translationsCreate.d.ts CHANGED Viewed

@@ -8,10 +8,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Create or update translation
+ * Create a translation
  *
  * @remarks
- * Create or update a translation for a specific workflow and locale
+ * Create a translation for a specific workflow and locale, if the translation already exists, it will be updated
  */
 export declare function translationsCreate(client: NovuCore, createTranslationRequestDto: components.CreateTranslationRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<components.TranslationResponseDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsCreate.d.ts.map

package/funcs/translationsCreate.js CHANGED Viewed

@@ -47,10 +47,10 @@ const components = __importStar(require("../models/components/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Create or update translation
+ * Create a translation
  *
  * @remarks
- * Create or update a translation for a specific workflow and locale
+ * Create a translation for a specific workflow and locale, if the translation already exists, it will be updated
  */
 function translationsCreate(client, createTranslationRequestDto, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, createTranslationRequestDto, idempotencyKey, options));

package/funcs/translationsDelete.d.ts CHANGED Viewed

@@ -8,7 +8,7 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Delete translation
+ * Delete a translation
  *
  * @remarks
  * Delete a specific translation by resource type, resource ID and locale

package/funcs/translationsDelete.js CHANGED Viewed

@@ -47,7 +47,7 @@ const url_js_1 = require("../lib/url.js");
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Delete translation
+ * Delete a translation
  *
  * @remarks
  * Delete a specific translation by resource type, resource ID and locale

package/funcs/translationsGroupsDelete.d.ts CHANGED Viewed

@@ -8,7 +8,7 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Delete translation group
+ * Delete a translation group
  *
  * @remarks
  * Delete an entire translation group and all its translations

package/funcs/translationsGroupsDelete.js CHANGED Viewed

@@ -47,7 +47,7 @@ const url_js_1 = require("../lib/url.js");
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Delete translation group
+ * Delete a translation group
  *
  * @remarks
  * Delete an entire translation group and all its translations

package/funcs/translationsGroupsRetrieve.d.ts CHANGED Viewed

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Get translation group
+ * Retrieve a translation group
  *
  * @remarks
- * Retrieves a single translation group by resourceId and resourceType
+ * Retrieves a single translation group by resource type (workflow) and resource ID (workflowId)
  */
 export declare function translationsGroupsRetrieve(client: NovuCore, resourceType: operations.TranslationControllerGetTranslationGroupEndpointPathParamResourceType, resourceId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<components.TranslationGroupDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsGroupsRetrieve.d.ts.map

package/funcs/translationsGroupsRetrieve.js CHANGED Viewed

@@ -47,10 +47,10 @@ const components = __importStar(require("../models/components/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get translation group
+ * Retrieve a translation group
  *
  * @remarks
- * Retrieves a single translation group by resourceId and resourceType
+ * Retrieves a single translation group by resource type (workflow) and resource ID (workflowId)
  */
 function translationsGroupsRetrieve(client, resourceType, resourceId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, resourceType, resourceId, idempotencyKey, options));

package/funcs/translationsMasterImport.d.ts CHANGED Viewed

@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
  * Import master translations JSON
  *
  * @remarks
- * Import translations from master JSON format for a specific locale
+ * Import translations for multiple workflows from master JSON format for a specific locale
  */
 export declare function translationsMasterImport(client: NovuCore, importMasterJsonRequestDto: components.ImportMasterJsonRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<components.ImportMasterJsonResponseDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsMasterImport.d.ts.map

package/funcs/translationsMasterImport.js CHANGED Viewed

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
  * Import master translations JSON
  *
  * @remarks
- * Import translations from master JSON format for a specific locale
+ * Import translations for multiple workflows from master JSON format for a specific locale
  */
 function translationsMasterImport(client, importMasterJsonRequestDto, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, importMasterJsonRequestDto, idempotencyKey, options));

package/funcs/translationsMasterRetrieve.d.ts CHANGED Viewed

@@ -8,10 +8,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Get master translations JSON
+ * Retrieve master translations JSON
  *
  * @remarks
- * Get all translations for a locale in master JSON format organized by namespace and resource
+ * Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)
  */
 export declare function translationsMasterRetrieve(client: NovuCore, locale?: string | undefined, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<components.GetMasterJsonResponseDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsMasterRetrieve.d.ts.map

package/funcs/translationsMasterRetrieve.js CHANGED Viewed

@@ -47,10 +47,10 @@ const components = __importStar(require("../models/components/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get master translations JSON
+ * Retrieve master translations JSON
  *
  * @remarks
- * Get all translations for a locale in master JSON format organized by namespace and resource
+ * Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)
  */
 function translationsMasterRetrieve(client, locale, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, locale, idempotencyKey, options));

package/funcs/translationsMasterUpload.d.ts CHANGED Viewed

@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
  * Upload master translations JSON file
  *
  * @remarks
- * Upload a master JSON file containing translations. Locale is automatically detected from filename (e.g., en_US.json)
+ * Upload a master JSON file containing translations for multiple workflows. Locale is automatically detected from filename (e.g., en_US.json)
  */
 export declare function translationsMasterUpload(client: NovuCore, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<components.ImportMasterJsonResponseDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsMasterUpload.d.ts.map

package/funcs/translationsMasterUpload.js CHANGED Viewed

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
  * Upload master translations JSON file
  *
  * @remarks
- * Upload a master JSON file containing translations. Locale is automatically detected from filename (e.g., en_US.json)
+ * Upload a master JSON file containing translations for multiple workflows. Locale is automatically detected from filename (e.g., en_US.json)
  */
 function translationsMasterUpload(client, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, idempotencyKey, options));

package/funcs/translationsRetrieve.d.ts CHANGED Viewed

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Get single translation
+ * Retrieve a translation
  *
  * @remarks
- * Get a specific translation by resource type, resource ID and locale
+ * Retrieve a specific translation by resource type, resource ID and locale
  */
 export declare function translationsRetrieve(client: NovuCore, request: operations.TranslationControllerGetSingleTranslationRequest, options?: RequestOptions): APIPromise<Result<components.TranslationResponseDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsRetrieve.d.ts.map

package/funcs/translationsRetrieve.js CHANGED Viewed

@@ -47,10 +47,10 @@ const components = __importStar(require("../models/components/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get single translation
+ * Retrieve a translation
  *
  * @remarks
- * Get a specific translation by resource type, resource ID and locale
+ * Retrieve a specific translation by resource type, resource ID and locale
  */
 function translationsRetrieve(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/translationsUpload.d.ts CHANGED Viewed

@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
  * Upload translation files
  *
  * @remarks
- * Upload one or more JSON translation files for a specific workflow. The file name must be the locale, e.g. en_US.json
+ * Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json
  */
 export declare function translationsUpload(client: NovuCore, uploadTranslationsRequestDto: components.UploadTranslationsRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<components.UploadTranslationsResponseDto, NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=translationsUpload.d.ts.map

package/funcs/translationsUpload.js CHANGED Viewed

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
  * Upload translation files
  *
  * @remarks
- * Upload one or more JSON translation files for a specific workflow. The file name must be the locale, e.g. en_US.json
+ * Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json
  */
 function translationsUpload(client, uploadTranslationsRequestDto, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, uploadTranslationsRequestDto, idempotencyKey, options));