magicbell-js 0.0.3 → 0.1.0

package/src/user-client/services/channels/models/teams-token-payload-webhook.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const teamsTokenPayloadWebhook = z.lazy(() => {
+  return z.object({
+    url: z.string().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {TeamsTokenPayloadWebhook} teamsTokenPayloadWebhook
+ * @property {string}
+ */
+export type TeamsTokenPayloadWebhook = z.infer<typeof teamsTokenPayloadWebhook>;
+
+/**
+ * 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 teamsTokenPayloadWebhookResponse = z.lazy(() => {
+  return z
+    .object({
+      url: z.string().optional(),
+    })
+    .transform((data) => ({
+      url: data['url'],
+    }));
+});
+
+/**
+ * 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 teamsTokenPayloadWebhookRequest = z.lazy(() => {
+  return z
+    .object({
+      url: z.string().optional(),
+    })
+    .transform((data) => ({
+      url: data['url'],
+    }));
+});

package/src/user-client/services/channels/models/teams-token-payload.ts

@@ -0,0 +1,52 @@
+import { z } from 'zod';
+
+import {
+  TeamsTokenPayloadWebhook,
+  teamsTokenPayloadWebhook,
+  teamsTokenPayloadWebhookRequest,
+  teamsTokenPayloadWebhookResponse,
+} from './teams-token-payload-webhook.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const teamsTokenPayload = z.lazy(() => {
+  return z.object({
+    webhook: teamsTokenPayloadWebhook.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {TeamsTokenPayload} teamsTokenPayload
+ * @property {TeamsTokenPayloadWebhook}
+ */
+export type TeamsTokenPayload = z.infer<typeof teamsTokenPayload>;
+
+/**
+ * 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 teamsTokenPayloadResponse = z.lazy(() => {
+  return z
+    .object({
+      webhook: teamsTokenPayloadWebhookResponse.optional(),
+    })
+    .transform((data) => ({
+      webhook: data['webhook'],
+    }));
+});
+
+/**
+ * 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 teamsTokenPayloadRequest = z.lazy(() => {
+  return z
+    .object({
+      webhook: teamsTokenPayloadWebhookRequest.optional(),
+    })
+    .transform((data) => ({
+      webhook: data['webhook'],
+    }));
+});

package/src/user-client/services/channels/models/teams-token-webhook.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const teamsTokenWebhook = z.lazy(() => {
+  return z.object({
+    url: z.string().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {TeamsTokenWebhook} teamsTokenWebhook
+ * @property {string}
+ */
+export type TeamsTokenWebhook = z.infer<typeof teamsTokenWebhook>;
+
+/**
+ * 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 teamsTokenWebhookResponse = z.lazy(() => {
+  return z
+    .object({
+      url: z.string().optional(),
+    })
+    .transform((data) => ({
+      url: data['url'],
+    }));
+});
+
+/**
+ * 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 teamsTokenWebhookRequest = z.lazy(() => {
+  return z
+    .object({
+      url: z.string().optional(),
+    })
+    .transform((data) => ({
+      url: data['url'],
+    }));
+});

package/src/user-client/services/channels/models/teams-token.ts

@@ -0,0 +1,76 @@
+import { z } from 'zod';
+
+import {
+  TeamsTokenWebhook,
+  teamsTokenWebhook,
+  teamsTokenWebhookRequest,
+  teamsTokenWebhookResponse,
+} from './teams-token-webhook.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const teamsToken = z.lazy(() => {
+  return z.object({
+    createdAt: z.string(),
+    discardedAt: z.string().optional().nullable(),
+    id: z.string(),
+    updatedAt: z.string().optional().nullable(),
+    webhook: teamsTokenWebhook.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {TeamsToken} teamsToken
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {TeamsTokenWebhook}
+ */
+export type TeamsToken = z.infer<typeof teamsToken>;
+
+/**
+ * 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 teamsTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      created_at: z.string(),
+      discarded_at: z.string().optional().nullable(),
+      id: z.string(),
+      updated_at: z.string().optional().nullable(),
+      webhook: teamsTokenWebhookResponse.optional(),
+    })
+    .transform((data) => ({
+      createdAt: data['created_at'],
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+      updatedAt: data['updated_at'],
+      webhook: data['webhook'],
+    }));
+});
+
+/**
+ * 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 teamsTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      createdAt: z.string(),
+      discardedAt: z.string().optional().nullable(),
+      id: z.string(),
+      updatedAt: z.string().optional().nullable(),
+      webhook: teamsTokenWebhookRequest.optional(),
+    })
+    .transform((data) => ({
+      created_at: data['createdAt'],
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+      updated_at: data['updatedAt'],
+      webhook: data['webhook'],
+    }));
+});

package/src/user-client/services/channels/models/web-push-token-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { WebPushToken, webPushToken, webPushTokenRequest, webPushTokenResponse } from './web-push-token.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushTokenCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(webPushToken).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {WebPushTokenCollection} webPushTokenCollection
+ * @property {WebPushToken[]}
+ * @property {Links}
+ */
+export type WebPushTokenCollection = z.infer<typeof webPushTokenCollection>;
+
+/**
+ * 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 webPushTokenCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(webPushTokenResponse).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 webPushTokenCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(webPushTokenRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/user-client/services/channels/models/web-push-token-keys.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushTokenKeys = z.lazy(() => {
+  return z.object({
+    auth: z.string(),
+    p256dh: z.string(),
+  });
+});
+
+/**
+ * The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ * @typedef  {WebPushTokenKeys} webPushTokenKeys - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription. - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ * @property {string} - The authentication secret obtained from PushSubscription.getKey('auth'). Used to encrypt push messages for this subscription.
+ * @property {string} - The P-256 ECDH public key obtained from PushSubscription.getKey('p256dh'). Used to encrypt push messages for this subscription.
+ */
+export type WebPushTokenKeys = z.infer<typeof webPushTokenKeys>;
+
+/**
+ * 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 webPushTokenKeysResponse = z.lazy(() => {
+  return z
+    .object({
+      auth: z.string(),
+      p256dh: z.string(),
+    })
+    .transform((data) => ({
+      auth: data['auth'],
+      p256dh: data['p256dh'],
+    }));
+});
+
+/**
+ * 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 webPushTokenKeysRequest = z.lazy(() => {
+  return z
+    .object({
+      auth: z.string(),
+      p256dh: z.string(),
+    })
+    .transform((data) => ({
+      auth: data['auth'],
+      p256dh: data['p256dh'],
+    }));
+});

package/src/user-client/services/channels/models/web-push-token-payload-keys.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushTokenPayloadKeys = z.lazy(() => {
+  return z.object({
+    auth: z.string(),
+    p256dh: z.string(),
+  });
+});
+
+/**
+ * The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ * @typedef  {WebPushTokenPayloadKeys} webPushTokenPayloadKeys - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription. - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ * @property {string} - The authentication secret obtained from PushSubscription.getKey('auth'). Used to encrypt push messages for this subscription.
+ * @property {string} - The P-256 ECDH public key obtained from PushSubscription.getKey('p256dh'). Used to encrypt push messages for this subscription.
+ */
+export type WebPushTokenPayloadKeys = z.infer<typeof webPushTokenPayloadKeys>;
+
+/**
+ * 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 webPushTokenPayloadKeysResponse = z.lazy(() => {
+  return z
+    .object({
+      auth: z.string(),
+      p256dh: z.string(),
+    })
+    .transform((data) => ({
+      auth: data['auth'],
+      p256dh: data['p256dh'],
+    }));
+});
+
+/**
+ * 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 webPushTokenPayloadKeysRequest = z.lazy(() => {
+  return z
+    .object({
+      auth: z.string(),
+      p256dh: z.string(),
+    })
+    .transform((data) => ({
+      auth: data['auth'],
+      p256dh: data['p256dh'],
+    }));
+});

package/src/user-client/services/channels/models/web-push-token.ts

@@ -0,0 +1,82 @@
+import { z } from 'zod';
+
+import {
+  WebPushTokenKeys,
+  webPushTokenKeys,
+  webPushTokenKeysRequest,
+  webPushTokenKeysResponse,
+} from './web-push-token-keys.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushToken = z.lazy(() => {
+  return z.object({
+    createdAt: z.string(),
+    discardedAt: z.string().optional().nullable(),
+    endpoint: z.string(),
+    id: z.string(),
+    keys: webPushTokenKeys,
+    updatedAt: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {WebPushToken} webPushToken
+ * @property {string}
+ * @property {string}
+ * @property {string} - The push subscription URL obtained from PushSubscription.endpoint after calling registration.pushManager.subscribe(). This is the unique URL for this device that push messages will be sent to.
+ * @property {string}
+ * @property {WebPushTokenKeys} - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ * @property {string}
+ */
+export type WebPushToken = z.infer<typeof webPushToken>;
+
+/**
+ * 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 webPushTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      created_at: z.string(),
+      discarded_at: z.string().optional().nullable(),
+      endpoint: z.string(),
+      id: z.string(),
+      keys: webPushTokenKeysResponse,
+      updated_at: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      createdAt: data['created_at'],
+      discardedAt: data['discarded_at'],
+      endpoint: data['endpoint'],
+      id: data['id'],
+      keys: data['keys'],
+      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 webPushTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      createdAt: z.string(),
+      discardedAt: z.string().optional().nullable(),
+      endpoint: z.string(),
+      id: z.string(),
+      keys: webPushTokenKeysRequest,
+      updatedAt: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      created_at: data['createdAt'],
+      discarded_at: data['discardedAt'],
+      endpoint: data['endpoint'],
+      id: data['id'],
+      keys: data['keys'],
+      updated_at: data['updatedAt'],
+    }));
+});

package/src/user-client/services/channels/request-params.ts

@@ -0,0 +1,41 @@
+export interface GetInAppInboxTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetMobilePushApnsTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetMobilePushExpoTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetMobilePushFcmTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetSlackTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetTeamsTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetWebPushTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}

package/src/user-client/services/common/index.ts

@@ -0,0 +1,2 @@
+export type { Links } from './links.js';
+export type { WebPushTokenPayload } from './web-push-token-payload.js';

package/src/user-client/services/common/links.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const links = z.lazy(() => {
+  return z.object({
+    first: z.string().optional(),
+    next: z.string().optional().nullable(),
+    prev: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Links} links
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Links = z.infer<typeof links>;
+
+/**
+ * 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 linksResponse = z.lazy(() => {
+  return z
+    .object({
+      first: z.string().optional(),
+      next: z.string().optional().nullable(),
+      prev: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      first: data['first'],
+      next: data['next'],
+      prev: data['prev'],
+    }));
+});
+
+/**
+ * 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 linksRequest = z.lazy(() => {
+  return z
+    .object({
+      first: z.string().optional(),
+      next: z.string().optional().nullable(),
+      prev: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      first: data['first'],
+      next: data['next'],
+      prev: data['prev'],
+    }));
+});

package/src/user-client/services/common/web-push-token-payload.ts

@@ -0,0 +1,58 @@
+import { z } from 'zod';
+
+import {
+  WebPushTokenPayloadKeys,
+  webPushTokenPayloadKeys,
+  webPushTokenPayloadKeysRequest,
+  webPushTokenPayloadKeysResponse,
+} from '../channels/models/web-push-token-payload-keys.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushTokenPayload = z.lazy(() => {
+  return z.object({
+    endpoint: z.string(),
+    keys: webPushTokenPayloadKeys,
+  });
+});
+
+/**
+ *
+ * @typedef  {WebPushTokenPayload} webPushTokenPayload
+ * @property {string} - The push subscription URL obtained from PushSubscription.endpoint after calling registration.pushManager.subscribe(). This is the unique URL for this device that push messages will be sent to.
+ * @property {WebPushTokenPayloadKeys} - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ */
+export type WebPushTokenPayload = z.infer<typeof webPushTokenPayload>;
+
+/**
+ * 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 webPushTokenPayloadResponse = z.lazy(() => {
+  return z
+    .object({
+      endpoint: z.string(),
+      keys: webPushTokenPayloadKeysResponse,
+    })
+    .transform((data) => ({
+      endpoint: data['endpoint'],
+      keys: data['keys'],
+    }));
+});
+
+/**
+ * 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 webPushTokenPayloadRequest = z.lazy(() => {
+  return z
+    .object({
+      endpoint: z.string(),
+      keys: webPushTokenPayloadKeysRequest,
+    })
+    .transform((data) => ({
+      endpoint: data['endpoint'],
+      keys: data['keys'],
+    }));
+});

package/src/user-client/services/integrations/index.ts

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