import {z} from 'zod' export type MessageMarkAsRequestDto = {messageId: string | Array, markAs: 'read' | 'seen' | 'unread' | 'unseen'}; export type CreateApiV1SubscribersSubscriberIdMessagesMarkAsArgs = {subscriberId: string, 'idempotency-key'?: string | undefined, body: MessageMarkAsRequestDto}; export type CreateApiV1SubscribersSubscriberIdMessagesMarkAsOptions = {baseUrl?: string | undefined, secretKey?: string | undefined, fetch?: typeof fetch | undefined}; export const chatOrPushProviderEnum = z.enum(["slack", "discord", "google-chat", "msteams", "webex-messaging", "mattermost", "ryver", "zulip", "grafana-on-call", "getstream", "rocket-chat", "whatsapp-business", "line", "chat-webhook", "novu-slack", "telegram", "sendblue", "photon-imessage", "novu-web-chat", "fcm", "apns", "expo", "one-signal", "pushpad", "push-webhook", "pusher-beams", "appio"]); export const channelCredentials = z.object({webhookUrl: z.string().optional(), channel: z.string().optional(), deviceTokens: z.array(z.string()).optional(), alertUid: z.string().optional(), title: z.string().optional(), imageUrl: z.string().optional(), state: z.string().optional(), externalUrl: z.string().optional()}); export const channelSettingsDto = z.object({providerId: chatOrPushProviderEnum, integrationIdentifier: z.string().optional(), credentials: channelCredentials, _integrationId: z.string()}); export const subscriberResponseDto = z.object({_id: z.string().optional(), firstName: z.string().nullable().optional(), lastName: z.string().nullable().optional(), email: z.string().nullable().optional(), phone: z.string().nullable().optional(), avatar: z.string().nullable().optional(), locale: z.string().nullable().optional(), channels: z.array(channelSettingsDto).optional(), topics: z.array(z.string()).optional(), isOnline: z.boolean().nullable().optional(), lastOnlineAt: z.string().nullable().optional(), __v: z.number().optional(), data: z.record(z.string(), z.unknown()).nullable().optional(), timezone: z.string().nullable().optional(), subscriberId: z.string(), _organizationId: z.string(), _environmentId: z.string(), deleted: z.boolean(), createdAt: z.string(), updatedAt: z.string()}); export const subscriberPreferenceChannels = z.object({email: z.boolean().optional(), sms: z.boolean().optional(), in_app: z.boolean().optional(), chat: z.boolean().optional(), push: z.boolean().optional(), tool: z.boolean().optional()}); export const messageTemplate = z.object({}); export const builderFieldTypeEnum = z.enum(["BOOLEAN", "TEXT", "DATE", "NUMBER", "STATEMENT", "LIST", "MULTI_LIST", "GROUP"]); export const fieldFilterPartDto = z.object({field: z.string(), value: z.string(), operator: z.enum(["LARGER", "SMALLER", "LARGER_EQUAL", "SMALLER_EQUAL", "EQUAL", "NOT_EQUAL", "ALL_IN", "ANY_IN", "NOT_IN", "BETWEEN", "NOT_BETWEEN", "LIKE", "NOT_LIKE", "IN"]), on: z.enum(["subscriber", "payload"])}); export const stepFilterDto = z.object({isNegated: z.boolean(), type: builderFieldTypeEnum, value: z.enum(["AND", "OR"]), children: z.array(fieldFilterPartDto)}); export const digestRegularMetadata = z.object({amount: z.number().optional(), unit: z.enum(["seconds", "minutes", "hours", "days", "weeks", "months"]).optional(), digestKey: z.string().optional(), type: z.enum(["regular", "backoff"]), backoff: z.boolean().optional(), backoffAmount: z.number().optional(), backoffUnit: z.enum(["seconds", "minutes", "hours", "days", "weeks", "months"]).optional(), updateMode: z.boolean().optional()}); export const timedConfig = z.object({atTime: z.string().optional(), weekDays: z.array(z.enum(["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"])).optional(), monthDays: z.array(z.string()).optional(), ordinal: z.enum(["1", "2", "3", "4", "5", "last"]).optional(), ordinalValue: z.enum(["day", "weekday", "weekend", "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"]).optional(), monthlyType: z.enum(["each", "on"]).optional()}); export const digestTimedMetadata = z.object({amount: z.number().optional(), unit: z.enum(["seconds", "minutes", "hours", "days", "weeks", "months"]).optional(), digestKey: z.string().optional(), type: z.literal("timed"), timed: timedConfig.optional()}); export const delayRegularMetadata = z.object({amount: z.number().optional(), unit: z.enum(["seconds", "minutes", "hours", "days", "weeks", "months"]).optional(), type: z.literal("regular")}); export const delayScheduledMetadata = z.object({type: z.literal("scheduled"), delayPath: z.string()}); export const replyCallback = z.object({active: z.boolean().optional(), url: z.string().optional()}); export const notificationStepData = z.object({_id: z.string().optional(), uuid: z.string().optional(), name: z.string().optional(), _templateId: z.string().optional(), active: z.boolean().optional(), shouldStopOnFail: z.boolean().optional(), template: messageTemplate.optional(), filters: z.array(stepFilterDto).optional(), _parentId: z.string().optional(), metadata: z.union([digestRegularMetadata, digestTimedMetadata, delayRegularMetadata, delayScheduledMetadata]).optional(), replyCallback: replyCallback.optional()}); export const notificationStepDto = z.object({_id: z.string().optional(), uuid: z.string().optional(), name: z.string().optional(), _templateId: z.string().optional(), active: z.boolean().optional(), shouldStopOnFail: z.boolean().optional(), template: messageTemplate.optional(), filters: z.array(stepFilterDto).optional(), _parentId: z.string().optional(), metadata: z.union([digestRegularMetadata, digestTimedMetadata, delayRegularMetadata, delayScheduledMetadata]).optional(), replyCallback: replyCallback.optional(), variants: z.array(notificationStepData).optional()}); export const notificationTriggerVariable = z.object({name: z.string()}); export const notificationTrigger = z.object({type: z.literal("event"), identifier: z.string(), variables: z.array(notificationTriggerVariable), subscriberVariables: z.array(notificationTriggerVariable).optional()}); export const notificationGroup = z.object({_id: z.string().optional(), name: z.string(), _environmentId: z.string(), _organizationId: z.string(), _parentId: z.string().optional()}); export const workflowResponse = z.object({_id: z.string().optional(), name: z.string(), description: z.string(), active: z.boolean(), draft: z.boolean(), preferenceSettings: subscriberPreferenceChannels, critical: z.boolean(), tags: z.array(z.string()), steps: z.array(notificationStepDto), _organizationId: z.string(), _creatorId: z.string(), _environmentId: z.string(), triggers: z.array(notificationTrigger), _notificationGroupId: z.string(), _parentId: z.string().optional(), deleted: z.boolean(), deletedAt: z.string(), deletedBy: z.string(), notificationGroup: notificationGroup.optional(), data: z.record(z.string(), z.unknown()).optional(), workflowIntegrationStatus: z.object({}).optional()}); export const emailBlockTypeEnum = z.enum(["button", "text"]); export const textAlignEnum = z.enum(["center", "left", "right"]); export const emailBlockStyles = z.object({textAlign: textAlignEnum}); export const emailBlock = z.object({type: emailBlockTypeEnum, content: z.string(), url: z.string().optional(), styles: emailBlockStyles.optional()}); export const channelTypeEnum = z.enum(["in_app", "email", "sms", "chat", "push", "tool"]); export const channelCTATypeEnum = z.literal("redirect"); export const messageCTAData = z.object({url: z.string().optional()}); export const messageActionStatusEnum = z.enum(["pending", "done"]); export const buttonTypeEnum = z.enum(["primary", "secondary"]); export const messageButton = z.object({type: buttonTypeEnum, content: z.string(), resultContent: z.string().optional()}); export const messageActionResult = z.object({payload: z.record(z.string(), z.unknown()).optional(), type: buttonTypeEnum.optional()}); export const messageAction = z.object({status: messageActionStatusEnum.optional(), buttons: z.array(messageButton).optional(), result: messageActionResult.optional()}); export const messageCTA = z.object({type: channelCTATypeEnum.optional(), data: messageCTAData.optional(), action: messageAction.optional()}); export const messageStatusEnum = z.enum(["sent", "error", "warning"]); export const messageResponseDto = z.object({_id: z.string().optional(), _templateId: z.string().nullable().optional(), _environmentId: z.string(), _messageTemplateId: z.string().nullable().optional(), _organizationId: z.string(), _notificationId: z.string(), _subscriberId: z.string(), subscriber: subscriberResponseDto.optional(), template: workflowResponse.optional(), templateIdentifier: z.string().optional(), createdAt: z.string(), deliveredAt: z.array(z.string()).optional(), lastSeenDate: z.string().optional(), lastReadDate: z.string().optional(), content: z.union([z.array(emailBlock), z.string()]).nullable().optional(), transactionId: z.string(), subject: z.string().optional(), channel: channelTypeEnum, read: z.boolean(), seen: z.boolean(), snoozedUntil: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), directWebhookUrl: z.string().optional(), providerId: z.string().optional(), deviceTokens: z.array(z.string()).optional(), title: z.string().optional(), cta: messageCTA, _feedId: z.string().nullable().optional(), status: messageStatusEnum, errorId: z.string().optional(), errorText: z.string().optional(), payload: z.record(z.string(), z.unknown()).optional(), overrides: z.record(z.string(), z.unknown()).optional(), contextKeys: z.array(z.string()).optional()}); export const createApiV1SubscribersSubscriberIdMessagesMarkAsResponse = z.array(messageResponseDto); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Update notifications state * * POST /v1/subscribers/{subscriberId}/messages/mark-as */ export const createApiV1SubscribersSubscriberIdMessagesMarkAs = async (args: CreateApiV1SubscribersSubscriberIdMessagesMarkAsArgs, options?: CreateApiV1SubscribersSubscriberIdMessagesMarkAsOptions) => { const {baseUrl = "https://api.novu.co", fetch: fetchFn = fetch, secretKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args['idempotency-key'] != null) headers.set("idempotency-key", String(args['idempotency-key'])) if (secretKey !== undefined) headers.set("Authorization", secretKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/subscribers/${encodeURIComponent(String(args.subscriberId))}/messages/mark-as${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiV1SubscribersSubscriberIdMessagesMarkAsResponse, await res.json()) };