magicbell-js 0.0.3 → 0.1.0

package/src/project-client/services/broadcasts/models/broadcast.ts

@@ -0,0 +1,143 @@
+import { z } from 'zod';
+
+import {
+  BroadcastStatus,
+  broadcastStatus,
+  broadcastStatusRequest,
+  broadcastStatusResponse,
+} from './broadcast-status.js';
+import { Overrides, overrides, overridesRequest, overridesResponse } from './overrides.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const broadcast = z.lazy(() => {
+  return z.object({
+    actionUrl: z.string().max(2048).optional().nullable(),
+    category: z
+      .string()
+      .max(255)
+      .regex(/^[A-Za-z0-9_\.\-\/:]+$/)
+      .optional()
+      .nullable(),
+    content: z.string().max(10485760).optional().nullable(),
+    createdAt: z.string().optional(),
+    customAttributes: z.any().optional().nullable(),
+    id: z.string().optional(),
+    overrides: overrides.optional().nullable(),
+    recipients: z.array(z.any()).min(1).max(1000).nullable(),
+    status: broadcastStatus.optional().nullable(),
+    title: z.string().min(1).max(255),
+    topic: z
+      .string()
+      .max(255)
+      .regex(/^[A-Za-z0-9_\.\-\/:]+$/)
+      .optional()
+      .nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Broadcast} broadcast
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string} - The timestamp when the broadcast was created.
+ * @property {any}
+ * @property {string} - The unique id for this broadcast.
+ * @property {Overrides}
+ * @property {any[]}
+ * @property {BroadcastStatus}
+ * @property {string}
+ * @property {string}
+ */
+export type Broadcast = z.infer<typeof broadcast>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const broadcastResponse = z.lazy(() => {
+  return z
+    .object({
+      action_url: z.string().max(2048).optional().nullable(),
+      category: z
+        .string()
+        .max(255)
+        .regex(/^[A-Za-z0-9_\.\-\/:]+$/)
+        .optional()
+        .nullable(),
+      content: z.string().max(10485760).optional().nullable(),
+      created_at: z.string().optional(),
+      custom_attributes: z.any().optional().nullable(),
+      id: z.string().optional(),
+      overrides: overridesResponse.optional().nullable(),
+      recipients: z.array(z.any()).min(1).max(1000).nullable(),
+      status: broadcastStatusResponse.optional().nullable(),
+      title: z.string().min(1).max(255),
+      topic: z
+        .string()
+        .max(255)
+        .regex(/^[A-Za-z0-9_\.\-\/:]+$/)
+        .optional()
+        .nullable(),
+    })
+    .transform((data) => ({
+      actionUrl: data['action_url'],
+      category: data['category'],
+      content: data['content'],
+      createdAt: data['created_at'],
+      customAttributes: data['custom_attributes'],
+      id: data['id'],
+      overrides: data['overrides'],
+      recipients: data['recipients'],
+      status: data['status'],
+      title: data['title'],
+      topic: data['topic'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const broadcastRequest = z.lazy(() => {
+  return z
+    .object({
+      actionUrl: z.string().max(2048).optional().nullable(),
+      category: z
+        .string()
+        .max(255)
+        .regex(/^[A-Za-z0-9_\.\-\/:]+$/)
+        .optional()
+        .nullable(),
+      content: z.string().max(10485760).optional().nullable(),
+      createdAt: z.string().optional(),
+      customAttributes: z.any().optional().nullable(),
+      id: z.string().optional(),
+      overrides: overridesRequest.optional().nullable(),
+      recipients: z.array(z.any()).min(1).max(1000).nullable(),
+      status: broadcastStatusRequest.optional().nullable(),
+      title: z.string().min(1).max(255),
+      topic: z
+        .string()
+        .max(255)
+        .regex(/^[A-Za-z0-9_\.\-\/:]+$/)
+        .optional()
+        .nullable(),
+    })
+    .transform((data) => ({
+      action_url: data['actionUrl'],
+      category: data['category'],
+      content: data['content'],
+      created_at: data['createdAt'],
+      custom_attributes: data['customAttributes'],
+      id: data['id'],
+      overrides: data['overrides'],
+      recipients: data['recipients'],
+      status: data['status'],
+      title: data['title'],
+      topic: data['topic'],
+    }));
+});

package/src/project-client/services/broadcasts/models/email.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const email = z.lazy(() => {
+  return z.object({
+    actionUrl: z.string().max(2048).optional().nullable(),
+    content: z.string().max(1048576).optional(),
+    title: z.string().min(1).max(255).optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Email} email
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Email = z.infer<typeof email>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const emailResponse = z.lazy(() => {
+  return z
+    .object({
+      action_url: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      actionUrl: data['action_url'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const emailRequest = z.lazy(() => {
+  return z
+    .object({
+      actionUrl: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      action_url: data['actionUrl'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});

package/src/project-client/services/broadcasts/models/errors.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const errors = z.lazy(() => {
+  return z.object({
+    message: z.string().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Errors} errors
+ * @property {string}
+ */
+export type Errors = z.infer<typeof errors>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const errorsResponse = z.lazy(() => {
+  return z
+    .object({
+      message: z.string().optional(),
+    })
+    .transform((data) => ({
+      message: data['message'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const errorsRequest = z.lazy(() => {
+  return z
+    .object({
+      message: z.string().optional(),
+    })
+    .transform((data) => ({
+      message: data['message'],
+    }));
+});

package/src/project-client/services/broadcasts/models/in-app.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const inApp = z.lazy(() => {
+  return z.object({
+    actionUrl: z.string().max(2048).optional().nullable(),
+    content: z.string().max(1048576).optional(),
+    title: z.string().min(1).max(255).optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {InApp} inApp
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type InApp = z.infer<typeof inApp>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const inAppResponse = z.lazy(() => {
+  return z
+    .object({
+      action_url: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      actionUrl: data['action_url'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const inAppRequest = z.lazy(() => {
+  return z
+    .object({
+      actionUrl: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      action_url: data['actionUrl'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});

package/src/project-client/services/broadcasts/models/index.ts

@@ -0,0 +1,15 @@
+export type { Broadcast } from './broadcast.js';
+export type { BroadcastCollection } from './broadcast-collection.js';
+export type { BroadcastStatus } from './broadcast-status.js';
+export type { Email } from './email.js';
+export type { Errors } from './errors.js';
+export type { InApp } from './in-app.js';
+export type { MobilePush } from './mobile-push.js';
+export type { Overrides } from './overrides.js';
+export type { OverridesChannels } from './overrides-channels.js';
+export type { Providers } from './providers.js';
+export type { Slack } from './slack.js';
+export type { Sms } from './sms.js';
+export { StatusStatus } from './status-status.js';
+export type { Summary } from './summary.js';
+export type { WebPush } from './web-push.js';

package/src/project-client/services/broadcasts/models/mobile-push.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const mobilePush = z.lazy(() => {
+  return z.object({
+    actionUrl: z.string().max(2048).optional().nullable(),
+    content: z.string().max(1048576).optional(),
+    title: z.string().min(1).max(255).optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {MobilePush} mobilePush
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type MobilePush = z.infer<typeof mobilePush>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const mobilePushResponse = z.lazy(() => {
+  return z
+    .object({
+      action_url: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      actionUrl: data['action_url'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const mobilePushRequest = z.lazy(() => {
+  return z
+    .object({
+      actionUrl: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      action_url: data['actionUrl'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});

package/src/project-client/services/broadcasts/models/overrides-channels.ts

@@ -0,0 +1,82 @@
+import { z } from 'zod';
+
+import { Email, email, emailRequest, emailResponse } from './email.js';
+import { InApp, inApp, inAppRequest, inAppResponse } from './in-app.js';
+import { MobilePush, mobilePush, mobilePushRequest, mobilePushResponse } from './mobile-push.js';
+import { Slack, slack, slackRequest, slackResponse } from './slack.js';
+import { Sms, sms, smsRequest, smsResponse } from './sms.js';
+import { WebPush, webPush, webPushRequest, webPushResponse } from './web-push.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const overridesChannels = z.lazy(() => {
+  return z.object({
+    email: email.optional(),
+    inApp: inApp.optional(),
+    mobilePush: mobilePush.optional(),
+    slack: slack.optional(),
+    sms: sms.optional(),
+    webPush: webPush.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {OverridesChannels} overridesChannels
+ * @property {Email}
+ * @property {InApp}
+ * @property {MobilePush}
+ * @property {Slack}
+ * @property {Sms}
+ * @property {WebPush}
+ */
+export type OverridesChannels = z.infer<typeof overridesChannels>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const overridesChannelsResponse = z.lazy(() => {
+  return z
+    .object({
+      email: emailResponse.optional(),
+      in_app: inAppResponse.optional(),
+      mobile_push: mobilePushResponse.optional(),
+      slack: slackResponse.optional(),
+      sms: smsResponse.optional(),
+      web_push: webPushResponse.optional(),
+    })
+    .transform((data) => ({
+      email: data['email'],
+      inApp: data['in_app'],
+      mobilePush: data['mobile_push'],
+      slack: data['slack'],
+      sms: data['sms'],
+      webPush: data['web_push'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const overridesChannelsRequest = z.lazy(() => {
+  return z
+    .object({
+      email: emailRequest.optional(),
+      inApp: inAppRequest.optional(),
+      mobilePush: mobilePushRequest.optional(),
+      slack: slackRequest.optional(),
+      sms: smsRequest.optional(),
+      webPush: webPushRequest.optional(),
+    })
+    .transform((data) => ({
+      email: data['email'],
+      in_app: data['inApp'],
+      mobile_push: data['mobilePush'],
+      slack: data['slack'],
+      sms: data['sms'],
+      web_push: data['webPush'],
+    }));
+});

package/src/project-client/services/broadcasts/models/overrides.ts

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+
+import {
+  OverridesChannels,
+  overridesChannels,
+  overridesChannelsRequest,
+  overridesChannelsResponse,
+} from './overrides-channels.js';
+import { Providers, providers, providersRequest, providersResponse } from './providers.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const overrides = z.lazy(() => {
+  return z.object({
+    channels: overridesChannels.optional(),
+    providers: providers.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Overrides} overrides
+ * @property {OverridesChannels}
+ * @property {Providers}
+ */
+export type Overrides = z.infer<typeof overrides>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const overridesResponse = z.lazy(() => {
+  return z
+    .object({
+      channels: overridesChannelsResponse.optional(),
+      providers: providersResponse.optional(),
+    })
+    .transform((data) => ({
+      channels: data['channels'],
+      providers: data['providers'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const overridesRequest = z.lazy(() => {
+  return z
+    .object({
+      channels: overridesChannelsRequest.optional(),
+      providers: providersRequest.optional(),
+    })
+    .transform((data) => ({
+      channels: data['channels'],
+      providers: data['providers'],
+    }));
+});

package/src/project-client/services/broadcasts/models/providers.ts

@@ -0,0 +1,81 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const providers = z.lazy(() => {
+  return z.object({
+    amazonSes: z.any().optional(),
+    android: z.any().optional(),
+    ios: z.any().optional(),
+    mailgun: z.any().optional(),
+    postmark: z.any().optional(),
+    sendgrid: z.any().optional(),
+    slack: z.any().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Providers} providers
+ * @property {any}
+ * @property {any}
+ * @property {any}
+ * @property {any}
+ * @property {any}
+ * @property {any}
+ * @property {any}
+ */
+export type Providers = z.infer<typeof providers>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const providersResponse = z.lazy(() => {
+  return z
+    .object({
+      amazon_ses: z.any().optional(),
+      android: z.any().optional(),
+      ios: z.any().optional(),
+      mailgun: z.any().optional(),
+      postmark: z.any().optional(),
+      sendgrid: z.any().optional(),
+      slack: z.any().optional(),
+    })
+    .transform((data) => ({
+      amazonSes: data['amazon_ses'],
+      android: data['android'],
+      ios: data['ios'],
+      mailgun: data['mailgun'],
+      postmark: data['postmark'],
+      sendgrid: data['sendgrid'],
+      slack: data['slack'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const providersRequest = z.lazy(() => {
+  return z
+    .object({
+      amazonSes: z.any().optional(),
+      android: z.any().optional(),
+      ios: z.any().optional(),
+      mailgun: z.any().optional(),
+      postmark: z.any().optional(),
+      sendgrid: z.any().optional(),
+      slack: z.any().optional(),
+    })
+    .transform((data) => ({
+      amazon_ses: data['amazonSes'],
+      android: data['android'],
+      ios: data['ios'],
+      mailgun: data['mailgun'],
+      postmark: data['postmark'],
+      sendgrid: data['sendgrid'],
+      slack: data['slack'],
+    }));
+});

package/src/project-client/services/broadcasts/models/slack.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const slack = z.lazy(() => {
+  return z.object({
+    actionUrl: z.string().max(2048).optional().nullable(),
+    content: z.string().max(1048576).optional(),
+    title: z.string().min(1).max(255).optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Slack} slack
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Slack = z.infer<typeof slack>;
+
+/**
+ * The shape of the model mapping from the api schema into the application shape.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const slackResponse = z.lazy(() => {
+  return z
+    .object({
+      action_url: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      actionUrl: data['action_url'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});
+
+/**
+ * The shape of the model mapping from the application shape into the api schema.
+ * Is equal to application shape if all property names match the api schema
+ */
+export const slackRequest = z.lazy(() => {
+  return z
+    .object({
+      actionUrl: z.string().max(2048).optional().nullable(),
+      content: z.string().max(1048576).optional(),
+      title: z.string().min(1).max(255).optional(),
+    })
+    .transform((data) => ({
+      action_url: data['actionUrl'],
+      content: data['content'],
+      title: data['title'],
+    }));
+});