magicbell-js 0.0.3 → 0.1.0

package/src/project-client/services/channels/index.ts

@@ -0,0 +1,2 @@
+export { ChannelsService } from './channels-service.js';
+export * from './models/index.js';

package/src/project-client/services/channels/models/apns-token-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { ApnsToken, apnsToken, apnsTokenRequest, apnsTokenResponse } from './apns-token.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const apnsTokenCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(apnsToken).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {ApnsTokenCollection} apnsTokenCollection
+ * @property {ApnsToken[]}
+ * @property {Links}
+ */
+export type ApnsTokenCollection = z.infer<typeof apnsTokenCollection>;
+
+/**
+ * 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 apnsTokenCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(apnsTokenResponse).optional(),
+      links: linksResponse.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});
+
+/**
+ * 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 apnsTokenCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(apnsTokenRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/channels/models/apns-token-installation-id.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+
+export enum ApnsTokenInstallationId {
+  DEVELOPMENT = 'development',
+  PRODUCTION = 'production',
+}

package/src/project-client/services/channels/models/apns-token.ts

@@ -0,0 +1,90 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const apnsToken = z.lazy(() => {
+  return z.object({
+    appId: z
+      .string()
+      .regex(/^[a-zA-Z0-9]+(.[a-zA-Z0-9]+)*$/)
+      .optional(),
+    createdAt: z.string(),
+    deviceToken: z.string().min(64),
+    discardedAt: z.string().optional().nullable(),
+    id: z.string(),
+    installationId: z.string().optional(),
+    updatedAt: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {ApnsToken} apnsToken
+ * @property {string} - (Optional) The bundle identifier of the application that is registering this token. Use this field to override the default identifier specified in the projects APNs integration.
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {ApnsTokenInstallationId} - (Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`.
+ * @property {string}
+ */
+export type ApnsToken = z.infer<typeof apnsToken>;
+
+/**
+ * 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 apnsTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      app_id: z
+        .string()
+        .regex(/^[a-zA-Z0-9]+(.[a-zA-Z0-9]+)*$/)
+        .optional(),
+      created_at: z.string(),
+      device_token: z.string().min(64),
+      discarded_at: z.string().optional().nullable(),
+      id: z.string(),
+      installation_id: z.string().optional(),
+      updated_at: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      appId: data['app_id'],
+      createdAt: data['created_at'],
+      deviceToken: data['device_token'],
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+      installationId: data['installation_id'],
+      updatedAt: data['updated_at'],
+    }));
+});
+
+/**
+ * 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 apnsTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      appId: z
+        .string()
+        .regex(/^[a-zA-Z0-9]+(.[a-zA-Z0-9]+)*$/)
+        .optional(),
+      createdAt: z.string(),
+      deviceToken: z.string().min(64),
+      discardedAt: z.string().optional().nullable(),
+      id: z.string(),
+      installationId: z.string().optional(),
+      updatedAt: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      app_id: data['appId'],
+      created_at: data['createdAt'],
+      device_token: data['deviceToken'],
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+      installation_id: data['installationId'],
+      updated_at: data['updatedAt'],
+    }));
+});

package/src/project-client/services/channels/models/category-delivery-config-channels.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const categoryDeliveryConfigChannels = z.lazy(() => {
+  return z.object({
+    channel: z.string(),
+    delay: z.number().gte(0).optional(),
+    if: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {CategoryDeliveryConfigChannels} categoryDeliveryConfigChannels
+ * @property {Channel}
+ * @property {number}
+ * @property {string}
+ */
+export type CategoryDeliveryConfigChannels = z.infer<typeof categoryDeliveryConfigChannels>;
+
+/**
+ * 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 categoryDeliveryConfigChannelsResponse = z.lazy(() => {
+  return z
+    .object({
+      channel: z.string(),
+      delay: z.number().gte(0).optional(),
+      if: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      channel: data['channel'],
+      delay: data['delay'],
+      if: data['if'],
+    }));
+});
+
+/**
+ * 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 categoryDeliveryConfigChannelsRequest = z.lazy(() => {
+  return z
+    .object({
+      channel: z.string(),
+      delay: z.number().gte(0).optional(),
+      if: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      channel: data['channel'],
+      delay: data['delay'],
+      if: data['if'],
+    }));
+});

package/src/project-client/services/channels/models/category-delivery-config.ts

@@ -0,0 +1,73 @@
+import { z } from 'zod';
+
+import {
+  CategoryDeliveryConfigChannels,
+  categoryDeliveryConfigChannels,
+  categoryDeliveryConfigChannelsRequest,
+  categoryDeliveryConfigChannelsResponse,
+} from './category-delivery-config-channels.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const categoryDeliveryConfig = z.lazy(() => {
+  return z.object({
+    channels: z.array(categoryDeliveryConfigChannels),
+    disabled: z.boolean().optional(),
+    key: z
+      .string()
+      .min(3)
+      .regex(/^[A-Za-z0-9_.\-:\/]+$/),
+  });
+});
+
+/**
+ *
+ * @typedef  {CategoryDeliveryConfig} categoryDeliveryConfig
+ * @property {CategoryDeliveryConfigChannels[]}
+ * @property {boolean}
+ * @property {string}
+ */
+export type CategoryDeliveryConfig = z.infer<typeof categoryDeliveryConfig>;
+
+/**
+ * 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 categoryDeliveryConfigResponse = z.lazy(() => {
+  return z
+    .object({
+      channels: z.array(categoryDeliveryConfigChannelsResponse),
+      disabled: z.boolean().optional(),
+      key: z
+        .string()
+        .min(3)
+        .regex(/^[A-Za-z0-9_.\-:\/]+$/),
+    })
+    .transform((data) => ({
+      channels: data['channels'],
+      disabled: data['disabled'],
+      key: data['key'],
+    }));
+});
+
+/**
+ * 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 categoryDeliveryConfigRequest = z.lazy(() => {
+  return z
+    .object({
+      channels: z.array(categoryDeliveryConfigChannelsRequest),
+      disabled: z.boolean().optional(),
+      key: z
+        .string()
+        .min(3)
+        .regex(/^[A-Za-z0-9_.\-:\/]+$/),
+    })
+    .transform((data) => ({
+      channels: data['channels'],
+      disabled: data['disabled'],
+      key: data['key'],
+    }));
+});

package/src/project-client/services/channels/models/channel.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+export enum Channel {
+  IN_APP = 'in_app',
+  SLACK = 'slack',
+  WEB_PUSH = 'web_push',
+  MOBILE_PUSH = 'mobile_push',
+  TEAMS = 'teams',
+  EMAIL = 'email',
+  SMS = 'sms',
+}

package/src/project-client/services/channels/models/discard-result.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const discardResult = z.lazy(() => {
+  return z.object({
+    discardedAt: z.string().optional(),
+    id: z.string().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {DiscardResult} discardResult
+ * @property {string}
+ * @property {string}
+ */
+export type DiscardResult = z.infer<typeof discardResult>;
+
+/**
+ * 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 discardResultResponse = z.lazy(() => {
+  return z
+    .object({
+      discarded_at: z.string().optional(),
+      id: z.string().optional(),
+    })
+    .transform((data) => ({
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+    }));
+});
+
+/**
+ * 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 discardResultRequest = z.lazy(() => {
+  return z
+    .object({
+      discardedAt: z.string().optional(),
+      id: z.string().optional(),
+    })
+    .transform((data) => ({
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+    }));
+});

package/src/project-client/services/channels/models/expo-token-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { ExpoToken, expoToken, expoTokenRequest, expoTokenResponse } from './expo-token.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const expoTokenCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(expoToken).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {ExpoTokenCollection} expoTokenCollection
+ * @property {ExpoToken[]}
+ * @property {Links}
+ */
+export type ExpoTokenCollection = z.infer<typeof expoTokenCollection>;
+
+/**
+ * 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 expoTokenCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(expoTokenResponse).optional(),
+      links: linksResponse.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});
+
+/**
+ * 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 expoTokenCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(expoTokenRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/channels/models/expo-token.ts

@@ -0,0 +1,69 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const expoToken = z.lazy(() => {
+  return z.object({
+    createdAt: z.string(),
+    deviceToken: z.string().min(1),
+    discardedAt: z.string().optional().nullable(),
+    id: z.string(),
+    updatedAt: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {ExpoToken} expoToken
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type ExpoToken = z.infer<typeof expoToken>;
+
+/**
+ * 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 expoTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      created_at: z.string(),
+      device_token: z.string().min(1),
+      discarded_at: z.string().optional().nullable(),
+      id: z.string(),
+      updated_at: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      createdAt: data['created_at'],
+      deviceToken: data['device_token'],
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+      updatedAt: data['updated_at'],
+    }));
+});
+
+/**
+ * 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 expoTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      createdAt: z.string(),
+      deviceToken: z.string().min(1),
+      discardedAt: z.string().optional().nullable(),
+      id: z.string(),
+      updatedAt: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      created_at: data['createdAt'],
+      device_token: data['deviceToken'],
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+      updated_at: data['updatedAt'],
+    }));
+});

package/src/project-client/services/channels/models/fcm-token-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { FcmToken, fcmToken, fcmTokenRequest, fcmTokenResponse } from './fcm-token.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const fcmTokenCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(fcmToken).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {FcmTokenCollection} fcmTokenCollection
+ * @property {FcmToken[]}
+ * @property {Links}
+ */
+export type FcmTokenCollection = z.infer<typeof fcmTokenCollection>;
+
+/**
+ * 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 fcmTokenCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(fcmTokenResponse).optional(),
+      links: linksResponse.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});
+
+/**
+ * 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 fcmTokenCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(fcmTokenRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/channels/models/fcm-token-installation-id.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+
+export enum FcmTokenInstallationId {
+  DEVELOPMENT = 'development',
+  PRODUCTION = 'production',
+}

package/src/project-client/services/channels/models/fcm-token.ts

@@ -0,0 +1,75 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const fcmToken = z.lazy(() => {
+  return z.object({
+    createdAt: z.string(),
+    deviceToken: z.string().min(64),
+    discardedAt: z.string().optional().nullable(),
+    id: z.string(),
+    installationId: z.string().optional(),
+    updatedAt: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {FcmToken} fcmToken
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {FcmTokenInstallationId}
+ * @property {string}
+ */
+export type FcmToken = z.infer<typeof fcmToken>;
+
+/**
+ * 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 fcmTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      created_at: z.string(),
+      device_token: z.string().min(64),
+      discarded_at: z.string().optional().nullable(),
+      id: z.string(),
+      installation_id: z.string().optional(),
+      updated_at: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      createdAt: data['created_at'],
+      deviceToken: data['device_token'],
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+      installationId: data['installation_id'],
+      updatedAt: data['updated_at'],
+    }));
+});
+
+/**
+ * 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 fcmTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      createdAt: z.string(),
+      deviceToken: z.string().min(64),
+      discardedAt: z.string().optional().nullable(),
+      id: z.string(),
+      installationId: z.string().optional(),
+      updatedAt: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      created_at: data['createdAt'],
+      device_token: data['deviceToken'],
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+      installation_id: data['installationId'],
+      updated_at: data['updatedAt'],
+    }));
+});

package/src/project-client/services/channels/models/inbox-token-response-collection.ts

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import {
+  InboxTokenResponse,
+  inboxTokenResponse,
+  inboxTokenResponseRequest,
+  inboxTokenResponseResponse,
+} from './inbox-token-response.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const inboxTokenResponseCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(inboxTokenResponse).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {InboxTokenResponseCollection} inboxTokenResponseCollection
+ * @property {InboxTokenResponse[]}
+ * @property {Links}
+ */
+export type InboxTokenResponseCollection = z.infer<typeof inboxTokenResponseCollection>;
+
+/**
+ * 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 inboxTokenResponseCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(inboxTokenResponseResponse).optional(),
+      links: linksResponse.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});
+
+/**
+ * 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 inboxTokenResponseCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(inboxTokenResponseRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});