@novu/api 1.6.0 → 1.7.0

package/src/sdk/layouts.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { layoutsCreate } from "../funcs/layoutsCreate.js";
+import { layoutsDelete } from "../funcs/layoutsDelete.js";
+import { layoutsDuplicate } from "../funcs/layoutsDuplicate.js";
+import { layoutsGeneratePreview } from "../funcs/layoutsGeneratePreview.js";
+import { layoutsList } from "../funcs/layoutsList.js";
+import { layoutsRetrieve } from "../funcs/layoutsRetrieve.js";
+import { layoutsUpdate } from "../funcs/layoutsUpdate.js";
+import { layoutsUsage } from "../funcs/layoutsUsage.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Layouts extends ClientSDK {
+  /**
+   * Create a layout
+   *
+   * @remarks
+   * Creates a new layout in the Novu Cloud environment
+   */
+  async create(
+    createLayoutDto: components.CreateLayoutDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerCreateResponse> {
+    return unwrapAsync(layoutsCreate(
+      this,
+      createLayoutDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * List all layouts
+   *
+   * @remarks
+   * Retrieves a list of layouts with optional filtering and pagination
+   */
+  async list(
+    request: operations.LayoutsControllerListRequest,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerListResponse> {
+    return unwrapAsync(layoutsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a layout
+   *
+   * @remarks
+   * Updates the details of an existing layout, here **layoutId** is the identifier of the layout
+   */
+  async update(
+    updateLayoutDto: components.UpdateLayoutDto,
+    layoutId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerUpdateResponse> {
+    return unwrapAsync(layoutsUpdate(
+      this,
+      updateLayoutDto,
+      layoutId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a layout
+   *
+   * @remarks
+   * Fetches details of a specific layout by its unique identifier **layoutId**
+   */
+  async retrieve(
+    layoutId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerGetResponse> {
+    return unwrapAsync(layoutsRetrieve(
+      this,
+      layoutId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a layout
+   *
+   * @remarks
+   * Removes a specific layout by its unique identifier **layoutId**
+   */
+  async delete(
+    layoutId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerDeleteResponse | undefined> {
+    return unwrapAsync(layoutsDelete(
+      this,
+      layoutId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Duplicate a layout
+   *
+   * @remarks
+   * Duplicates a layout by its unique identifier **layoutId**. This will create a new layout with the content of the original layout.
+   */
+  async duplicate(
+    duplicateLayoutDto: components.DuplicateLayoutDto,
+    layoutId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerDuplicateResponse> {
+    return unwrapAsync(layoutsDuplicate(
+      this,
+      duplicateLayoutDto,
+      layoutId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Generate layout preview
+   *
+   * @remarks
+   * Generates a preview for a layout by its unique identifier **layoutId**
+   */
+  async generatePreview(
+    layoutPreviewRequestDto: components.LayoutPreviewRequestDto,
+    layoutId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerGeneratePreviewResponse> {
+    return unwrapAsync(layoutsGeneratePreview(
+      this,
+      layoutPreviewRequestDto,
+      layoutId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Get layout usage
+   *
+   * @remarks
+   * Retrieves information about workflows that use the specified layout by its unique identifier **layoutId**
+   */
+  async usage(
+    layoutId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.LayoutsControllerGetUsageResponse> {
+    return unwrapAsync(layoutsUsage(
+      this,
+      layoutId,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/master.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { translationsMasterImport } from "../funcs/translationsMasterImport.js";
+import { translationsMasterRetrieve } from "../funcs/translationsMasterRetrieve.js";
+import { translationsMasterUpload } from "../funcs/translationsMasterUpload.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Master extends ClientSDK {
+  /**
+   * Retrieve master translations JSON
+   *
+   * @remarks
+   * Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)
+   */
+  async retrieve(
+    locale?: string | undefined,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.GetMasterJsonResponseDto> {
+    return unwrapAsync(translationsMasterRetrieve(
+      this,
+      locale,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Import master translations JSON
+   *
+   * @remarks
+   * Import translations for multiple workflows from master JSON format for a specific locale
+   */
+  async import(
+    importMasterJsonRequestDto: components.ImportMasterJsonRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ImportMasterJsonResponseDto> {
+    return unwrapAsync(translationsMasterImport(
+      this,
+      importMasterJsonRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Upload master translations JSON file
+   *
+   * @remarks
+   * Upload a master JSON file containing translations for multiple workflows. Locale is automatically detected from filename (e.g., en_US.json)
+   */
+  async upload(
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ImportMasterJsonResponseDto> {
+    return unwrapAsync(translationsMasterUpload(
+      this,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/preferences.ts

@@ -20,12 +20,14 @@ export class Preferences extends ClientSDK {
    */
   async list(
     subscriberId: string,
+    criticality?: operations.Criticality | undefined,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse> {
     return unwrapAsync(subscribersPreferencesList(
       this,
       subscriberId,
+      criticality,
       idempotencyKey,
       options,
     ));

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { cancel } from "../funcs/cancel.js";
+import { inboundWebhooksControllerHandleWebhook } from "../funcs/inboundWebhooksControllerHandleWebhook.js";
 import { trigger } from "../funcs/trigger.js";
 import { triggerBroadcast } from "../funcs/triggerBroadcast.js";
 import { triggerBulk } from "../funcs/triggerBulk.js";
@@ -12,10 +13,12 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { Environments } from "./environments.js";
 import { Integrations } from "./integrations.js";
+import { Layouts } from "./layouts.js";
 import { Messages } from "./messages.js";
 import { Notifications } from "./notifications.js";
 import { Subscribers } from "./subscribers.js";
 import { Topics } from "./topics.js";
+import { Translations } from "./translations.js";
 import { Workflows } from "./workflows.js";
 
 export class Novu extends ClientSDK {
@@ -24,6 +27,11 @@ export class Novu extends ClientSDK {
     return (this._environments ??= new Environments(this._options));
   }
 
+  private _layouts?: Layouts;
+  get layouts(): Layouts {
+    return (this._layouts ??= new Layouts(this._options));
+  }
+
   private _subscribers?: Subscribers;
   get subscribers(): Subscribers {
     return (this._subscribers ??= new Subscribers(this._options));
@@ -34,6 +42,11 @@ export class Novu extends ClientSDK {
     return (this._topics ??= new Topics(this._options));
   }
 
+  private _translations?: Translations;
+  get translations(): Translations {
+    return (this._translations ??= new Translations(this._options));
+  }
+
   private _workflows?: Workflows;
   get workflows(): Workflows {
     return (this._workflows ??= new Workflows(this._options));
@@ -54,6 +67,21 @@ export class Novu extends ClientSDK {
     return (this._notifications ??= new Notifications(this._options));
   }
 
+  async inboundWebhooksControllerHandleWebhook(
+    environmentId: string,
+    integrationId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(inboundWebhooksControllerHandleWebhook(
+      this,
+      environmentId,
+      integrationId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Trigger event
    *

package/src/sdk/translations.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { translationsCreate } from "../funcs/translationsCreate.js";
+import { translationsDelete } from "../funcs/translationsDelete.js";
+import { translationsRetrieve } from "../funcs/translationsRetrieve.js";
+import { translationsUpload } from "../funcs/translationsUpload.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Groups } from "./groups.js";
+import { Master } from "./master.js";
+
+export class Translations extends ClientSDK {
+  private _groups?: Groups;
+  get groups(): Groups {
+    return (this._groups ??= new Groups(this._options));
+  }
+
+  private _master?: Master;
+  get master(): Master {
+    return (this._master ??= new Master(this._options));
+  }
+
+  /**
+   * Create a translation
+   *
+   * @remarks
+   * Create a translation for a specific workflow and locale, if the translation already exists, it will be updated
+   */
+  async create(
+    createTranslationRequestDto: components.CreateTranslationRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.TranslationResponseDto> {
+    return unwrapAsync(translationsCreate(
+      this,
+      createTranslationRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a translation
+   *
+   * @remarks
+   * Retrieve a specific translation by resource type, resource ID and locale
+   */
+  async retrieve(
+    request: operations.TranslationControllerGetSingleTranslationRequest,
+    options?: RequestOptions,
+  ): Promise<components.TranslationResponseDto> {
+    return unwrapAsync(translationsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a translation
+   *
+   * @remarks
+   * Delete a specific translation by resource type, resource ID and locale
+   */
+  async delete(
+    request: operations.TranslationControllerDeleteTranslationEndpointRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(translationsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Upload translation files
+   *
+   * @remarks
+   * Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json
+   */
+  async upload(
+    uploadTranslationsRequestDto: components.UploadTranslationsRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.UploadTranslationsResponseDto> {
+    return unwrapAsync(translationsUpload(
+      this,
+      uploadTranslationsRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+}