@novu/api 1.4.0 → 1.6.0

package/src/models/errors/subscriberresponsedto.ts

@@ -0,0 +1,336 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+import { NovuError } from "./novuerror.js";
+
+export type SubscriberResponseDtoData = {
+  /**
+   * The internal ID generated by Novu for your subscriber. This ID does not match the `subscriberId` used in your queries. Refer to `subscriberId` for that identifier.
+   */
+  id?: string | undefined;
+  /**
+   * The first name of the subscriber.
+   */
+  firstName?: string | null | undefined;
+  /**
+   * The last name of the subscriber.
+   */
+  lastName?: string | null | undefined;
+  /**
+   * The email address of the subscriber.
+   */
+  email?: string | null | undefined;
+  /**
+   * The phone number of the subscriber.
+   */
+  phone?: string | null | undefined;
+  /**
+   * The URL of the subscriber's avatar image.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The locale setting of the subscriber, indicating their preferred language or region.
+   */
+  locale?: string | null | undefined;
+  /**
+   * An array of channel settings associated with the subscriber.
+   */
+  channels?: Array<components.ChannelSettingsDto> | undefined;
+  /**
+   * An array of topics that the subscriber is subscribed to.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  topics?: Array<string> | undefined;
+  /**
+   * Indicates whether the subscriber is currently online.
+   */
+  isOnline?: boolean | null | undefined;
+  /**
+   * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
+   */
+  lastOnlineAt?: string | null | undefined;
+  /**
+   * The version of the subscriber document.
+   */
+  v?: number | undefined;
+  /**
+   * Additional custom data for the subscriber
+   */
+  data?: { [k: string]: any } | null | undefined;
+  /**
+   * Timezone of the subscriber
+   */
+  timezone?: string | null | undefined;
+  /**
+   * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
+   */
+  subscriberId: string;
+  /**
+   * The unique identifier of the organization to which the subscriber belongs.
+   */
+  organizationId: string;
+  /**
+   * The unique identifier of the environment associated with this subscriber.
+   */
+  environmentId: string;
+  /**
+   * Indicates whether the subscriber has been deleted.
+   */
+  deleted: boolean;
+  /**
+   * The timestamp indicating when the subscriber was created, in ISO 8601 format.
+   */
+  createdAt: string;
+  /**
+   * The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
+   */
+  updatedAt: string;
+};
+
+export class SubscriberResponseDto extends NovuError {
+  /**
+   * The internal ID generated by Novu for your subscriber. This ID does not match the `subscriberId` used in your queries. Refer to `subscriberId` for that identifier.
+   */
+  id?: string | undefined;
+  /**
+   * The first name of the subscriber.
+   */
+  firstName?: string | null | undefined;
+  /**
+   * The last name of the subscriber.
+   */
+  lastName?: string | null | undefined;
+  /**
+   * The email address of the subscriber.
+   */
+  email?: string | null | undefined;
+  /**
+   * The phone number of the subscriber.
+   */
+  phone?: string | null | undefined;
+  /**
+   * The URL of the subscriber's avatar image.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The locale setting of the subscriber, indicating their preferred language or region.
+   */
+  locale?: string | null | undefined;
+  /**
+   * An array of channel settings associated with the subscriber.
+   */
+  channels?: Array<components.ChannelSettingsDto> | undefined;
+  /**
+   * An array of topics that the subscriber is subscribed to.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  topics?: Array<string> | undefined;
+  /**
+   * Indicates whether the subscriber is currently online.
+   */
+  isOnline?: boolean | null | undefined;
+  /**
+   * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
+   */
+  lastOnlineAt?: string | null | undefined;
+  /**
+   * The version of the subscriber document.
+   */
+  v?: number | undefined;
+  /**
+   * Additional custom data for the subscriber
+   */
+  data?: { [k: string]: any } | null | undefined;
+  /**
+   * Timezone of the subscriber
+   */
+  timezone?: string | null | undefined;
+  /**
+   * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
+   */
+  subscriberId: string;
+  /**
+   * The unique identifier of the organization to which the subscriber belongs.
+   */
+  organizationId: string;
+  /**
+   * The unique identifier of the environment associated with this subscriber.
+   */
+  environmentId: string;
+  /**
+   * Indicates whether the subscriber has been deleted.
+   */
+  deleted: boolean;
+  /**
+   * The timestamp indicating when the subscriber was created, in ISO 8601 format.
+   */
+  createdAt: string;
+  /**
+   * The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
+   */
+  updatedAt: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: SubscriberResponseDtoData;
+
+  constructor(
+    err: SubscriberResponseDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.id != null) this.id = err.id;
+    if (err.firstName != null) this.firstName = err.firstName;
+    if (err.lastName != null) this.lastName = err.lastName;
+    if (err.email != null) this.email = err.email;
+    if (err.phone != null) this.phone = err.phone;
+    if (err.avatar != null) this.avatar = err.avatar;
+    if (err.locale != null) this.locale = err.locale;
+    if (err.channels != null) this.channels = err.channels;
+    if (err.topics != null) this.topics = err.topics;
+    if (err.isOnline != null) this.isOnline = err.isOnline;
+    if (err.lastOnlineAt != null) this.lastOnlineAt = err.lastOnlineAt;
+    if (err.v != null) this.v = err.v;
+    if (err.data != null) this.data = err.data;
+    if (err.timezone != null) this.timezone = err.timezone;
+    this.subscriberId = err.subscriberId;
+    this.organizationId = err.organizationId;
+    this.environmentId = err.environmentId;
+    this.deleted = err.deleted;
+    this.createdAt = err.createdAt;
+    this.updatedAt = err.updatedAt;
+
+    this.name = "SubscriberResponseDto";
+  }
+}
+
+/** @internal */
+export const SubscriberResponseDto$inboundSchema: z.ZodType<
+  SubscriberResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  channels: z.array(components.ChannelSettingsDto$inboundSchema).optional(),
+  topics: z.array(z.string()).optional(),
+  isOnline: z.nullable(z.boolean()).optional(),
+  lastOnlineAt: z.nullable(z.string()).optional(),
+  __v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
+  timezone: z.nullable(z.string()).optional(),
+  subscriberId: z.string(),
+  _organizationId: z.string(),
+  _environmentId: z.string(),
+  deleted: z.boolean(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    const remapped = remap$(v, {
+      "_id": "id",
+      "__v": "v",
+      "_organizationId": "organizationId",
+      "_environmentId": "environmentId",
+    });
+
+    return new SubscriberResponseDto(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type SubscriberResponseDto$Outbound = {
+  _id?: string | undefined;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email?: string | null | undefined;
+  phone?: string | null | undefined;
+  avatar?: string | null | undefined;
+  locale?: string | null | undefined;
+  channels?: Array<components.ChannelSettingsDto$Outbound> | undefined;
+  topics?: Array<string> | undefined;
+  isOnline?: boolean | null | undefined;
+  lastOnlineAt?: string | null | undefined;
+  __v?: number | undefined;
+  data?: { [k: string]: any } | null | undefined;
+  timezone?: string | null | undefined;
+  subscriberId: string;
+  _organizationId: string;
+  _environmentId: string;
+  deleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** @internal */
+export const SubscriberResponseDto$outboundSchema: z.ZodType<
+  SubscriberResponseDto$Outbound,
+  z.ZodTypeDef,
+  SubscriberResponseDto
+> = z.instanceof(SubscriberResponseDto)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      id: z.string().optional(),
+      firstName: z.nullable(z.string()).optional(),
+      lastName: z.nullable(z.string()).optional(),
+      email: z.nullable(z.string()).optional(),
+      phone: z.nullable(z.string()).optional(),
+      avatar: z.nullable(z.string()).optional(),
+      locale: z.nullable(z.string()).optional(),
+      channels: z.array(components.ChannelSettingsDto$outboundSchema)
+        .optional(),
+      topics: z.array(z.string()).optional(),
+      isOnline: z.nullable(z.boolean()).optional(),
+      lastOnlineAt: z.nullable(z.string()).optional(),
+      v: z.number().optional(),
+      data: z.nullable(z.record(z.any())).optional(),
+      timezone: z.nullable(z.string()).optional(),
+      subscriberId: z.string(),
+      organizationId: z.string(),
+      environmentId: z.string(),
+      deleted: z.boolean(),
+      createdAt: z.string(),
+      updatedAt: z.string(),
+    }).transform((v) => {
+      return remap$(v, {
+        id: "_id",
+        v: "__v",
+        organizationId: "_organizationId",
+        environmentId: "_environmentId",
+      });
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberResponseDto$ {
+  /** @deprecated use `SubscriberResponseDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriberResponseDto$inboundSchema;
+  /** @deprecated use `SubscriberResponseDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriberResponseDto$outboundSchema;
+  /** @deprecated use `SubscriberResponseDto$Outbound` instead. */
+  export type Outbound = SubscriberResponseDto$Outbound;
+}

package/src/models/errors/topicresponsedto.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { NovuError } from "./novuerror.js";
+
+export type TopicResponseDtoData = {
+  /**
+   * The identifier of the topic
+   */
+  id: string;
+  /**
+   * The unique key of the topic
+   */
+  key: string;
+  /**
+   * The name of the topic
+   */
+  name?: string | undefined;
+  /**
+   * The date the topic was created
+   */
+  createdAt?: string | undefined;
+  /**
+   * The date the topic was last updated
+   */
+  updatedAt?: string | undefined;
+};
+
+export class TopicResponseDto extends NovuError {
+  /**
+   * The identifier of the topic
+   */
+  id: string;
+  /**
+   * The unique key of the topic
+   */
+  key: string;
+  /**
+   * The date the topic was created
+   */
+  createdAt?: string | undefined;
+  /**
+   * The date the topic was last updated
+   */
+  updatedAt?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: TopicResponseDtoData;
+
+  constructor(
+    err: TopicResponseDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.id = err.id;
+    this.key = err.key;
+    if (err.createdAt != null) this.createdAt = err.createdAt;
+    if (err.updatedAt != null) this.updatedAt = err.updatedAt;
+
+    this.name = "TopicResponseDto";
+  }
+}
+
+/** @internal */
+export const TopicResponseDto$inboundSchema: z.ZodType<
+  TopicResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  key: z.string(),
+  name: z.string().optional(),
+  createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    const remapped = remap$(v, {
+      "_id": "id",
+    });
+
+    return new TopicResponseDto(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type TopicResponseDto$Outbound = {
+  _id: string;
+  key: string;
+  name?: string | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const TopicResponseDto$outboundSchema: z.ZodType<
+  TopicResponseDto$Outbound,
+  z.ZodTypeDef,
+  TopicResponseDto
+> = z.instanceof(TopicResponseDto)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      id: z.string(),
+      key: z.string(),
+      name: z.string().optional(),
+      createdAt: z.string().optional(),
+      updatedAt: z.string().optional(),
+    }).transform((v) => {
+      return remap$(v, {
+        id: "_id",
+      });
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicResponseDto$ {
+  /** @deprecated use `TopicResponseDto$inboundSchema` instead. */
+  export const inboundSchema = TopicResponseDto$inboundSchema;
+  /** @deprecated use `TopicResponseDto$outboundSchema` instead. */
+  export const outboundSchema = TopicResponseDto$outboundSchema;
+  /** @deprecated use `TopicResponseDto$Outbound` instead. */
+  export type Outbound = TopicResponseDto$Outbound;
+}

package/src/models/operations/environmentscontrollergetenvironmenttags.ts

@@ -0,0 +1,186 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EnvironmentsControllerGetEnvironmentTagsRequest = {
+  /**
+   * Environment internal ID (MongoDB ObjectId) or identifier
+   */
+  environmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type EnvironmentsControllerGetEnvironmentTagsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.GetEnvironmentTagsDto>;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    environmentId: z.string(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
+  });
+
+/** @internal */
+export type EnvironmentsControllerGetEnvironmentTagsRequest$Outbound = {
+  environmentId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerGetEnvironmentTagsRequest
+  > = z.object({
+    environmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EnvironmentsControllerGetEnvironmentTagsRequest$ {
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsRequest$Outbound` instead. */
+  export type Outbound =
+    EnvironmentsControllerGetEnvironmentTagsRequest$Outbound;
+}
+
+export function environmentsControllerGetEnvironmentTagsRequestToJSON(
+  environmentsControllerGetEnvironmentTagsRequest:
+    EnvironmentsControllerGetEnvironmentTagsRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema.parse(
+      environmentsControllerGetEnvironmentTagsRequest,
+    ),
+  );
+}
+
+export function environmentsControllerGetEnvironmentTagsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerGetEnvironmentTagsRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerGetEnvironmentTagsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: z.array(components.GetEnvironmentTagsDto$inboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type EnvironmentsControllerGetEnvironmentTagsResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.GetEnvironmentTagsDto$Outbound>;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsResponse$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerGetEnvironmentTagsResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: z.array(components.GetEnvironmentTagsDto$outboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      headers: "Headers",
+      result: "Result",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EnvironmentsControllerGetEnvironmentTagsResponse$ {
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsResponse$Outbound` instead. */
+  export type Outbound =
+    EnvironmentsControllerGetEnvironmentTagsResponse$Outbound;
+}
+
+export function environmentsControllerGetEnvironmentTagsResponseToJSON(
+  environmentsControllerGetEnvironmentTagsResponse:
+    EnvironmentsControllerGetEnvironmentTagsResponse,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema.parse(
+      environmentsControllerGetEnvironmentTagsResponse,
+    ),
+  );
+}
+
+export function environmentsControllerGetEnvironmentTagsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerGetEnvironmentTagsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerGetEnvironmentTagsResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./environmentscontrollergetenvironmenttags.js";
 export * from "./environmentscontrollerv1createenvironment.js";
 export * from "./environmentscontrollerv1deleteenvironment.js";
 export * from "./environmentscontrollerv1listmyenvironments.js";
@@ -21,6 +22,7 @@ export * from "./messagescontrollerdeletemessagesbytransactionid.js";
 export * from "./messagescontrollergetmessages.js";
 export * from "./notificationscontrollergetnotification.js";
 export * from "./notificationscontrollerlistnotifications.js";
+export * from "./subscriberscontrollerbulkupdatesubscriberpreferences.js";
 export * from "./subscriberscontrollercreatesubscriber.js";
 export * from "./subscriberscontrollergetsubscriber.js";
 export * from "./subscriberscontrollergetsubscriberpreferences.js";

package/src/models/operations/notificationscontrollerlistnotifications.ts

@@ -41,7 +41,7 @@ export type NotificationsControllerListNotificationsRequest = {
    */
   limit?: number | undefined;
   /**
-   * Transaction ID for filtering
+   * The transaction ID to filter by
    */
   transactionId?: string | undefined;
   /**