magicbell-js 0.0.2 → 0.0.4

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'],
+    }));
+});

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

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const sms = 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  {Sms} sms
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Sms = z.infer<typeof sms>;
+
+/**
+ * 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 smsResponse = 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 smsRequest = 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/status-status.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+export enum StatusStatus {
+  ENQUEUED = 'enqueued',
+  PROCESSING = 'processing',
+  PROCESSED = 'processed',
+}

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

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const summary = z.lazy(() => {
+  return z.object({
+    failures: z.number(),
+    total: z.number(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Summary} summary
+ * @property {number} - The number of failures while processing the broadcast.
+ * @property {number} - The number of recipients that the broadcast was sent to.
+ */
+export type Summary = z.infer<typeof summary>;
+
+/**
+ * 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 summaryResponse = z.lazy(() => {
+  return z
+    .object({
+      failures: z.number(),
+      total: z.number(),
+    })
+    .transform((data) => ({
+      failures: data['failures'],
+      total: data['total'],
+    }));
+});
+
+/**
+ * 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 summaryRequest = z.lazy(() => {
+  return z
+    .object({
+      failures: z.number(),
+      total: z.number(),
+    })
+    .transform((data) => ({
+      failures: data['failures'],
+      total: data['total'],
+    }));
+});

package/src/project-client/services/broadcasts/models/web-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 webPush = 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  {WebPush} webPush
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type WebPush = z.infer<typeof webPush>;
+
+/**
+ * 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 webPushResponse = 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 webPushRequest = 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/request-params.ts

@@ -0,0 +1,5 @@
+export interface ListBroadcastsParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}