magicbell-js 0.0.3 → 0.0.4

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

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

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

@@ -0,0 +1,24 @@
+export type { ApnsToken } from './apns-token.js';
+export type { ApnsTokenCollection } from './apns-token-collection.js';
+export { ApnsTokenInstallationId } from './apns-token-installation-id.js';
+export type { CategoryDeliveryConfig } from './category-delivery-config.js';
+export type { CategoryDeliveryConfigChannels } from './category-delivery-config-channels.js';
+export { Channel } from './channel.js';
+export type { DiscardResult } from './discard-result.js';
+export type { ExpoToken } from './expo-token.js';
+export type { ExpoTokenCollection } from './expo-token-collection.js';
+export type { FcmToken } from './fcm-token.js';
+export type { FcmTokenCollection } from './fcm-token-collection.js';
+export { FcmTokenInstallationId } from './fcm-token-installation-id.js';
+export type { InboxTokenResponse } from './inbox-token-response.js';
+export type { InboxTokenResponseCollection } from './inbox-token-response-collection.js';
+export type { Keys } from './keys.js';
+export type { Oauth } from './oauth.js';
+export type { SlackToken } from './slack-token.js';
+export type { SlackTokenCollection } from './slack-token-collection.js';
+export type { SlackTokenWebhook } from './slack-token-webhook.js';
+export type { TeamsToken } from './teams-token.js';
+export type { TeamsTokenCollection } from './teams-token-collection.js';
+export type { TeamsTokenWebhook } from './teams-token-webhook.js';
+export type { WebPushToken } from './web-push-token.js';
+export type { WebPushTokenCollection } from './web-push-token-collection.js';

package/src/project-client/services/channels/models/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 keys = 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  {Keys} keys - 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 Keys = z.infer<typeof keys>;
+
+/**
+ * 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 keysResponse = 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 keysRequest = z.lazy(() => {
+  return z
+    .object({
+      auth: z.string(),
+      p256dh: z.string(),
+    })
+    .transform((data) => ({
+      auth: data['auth'],
+      p256dh: data['p256dh'],
+    }));
+});

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

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const oauth = z.lazy(() => {
+  return z.object({
+    channelId: z.string(),
+    installationId: z.string(),
+    scope: z.string().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Oauth} oauth
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Oauth = z.infer<typeof oauth>;
+
+/**
+ * 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 oauthResponse = z.lazy(() => {
+  return z
+    .object({
+      channel_id: z.string(),
+      installation_id: z.string(),
+      scope: z.string().optional(),
+    })
+    .transform((data) => ({
+      channelId: data['channel_id'],
+      installationId: data['installation_id'],
+      scope: data['scope'],
+    }));
+});
+
+/**
+ * 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 oauthRequest = z.lazy(() => {
+  return z
+    .object({
+      channelId: z.string(),
+      installationId: z.string(),
+      scope: z.string().optional(),
+    })
+    .transform((data) => ({
+      channel_id: data['channelId'],
+      installation_id: data['installationId'],
+      scope: data['scope'],
+    }));
+});

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

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { SlackToken, slackToken, slackTokenRequest, slackTokenResponse } from './slack-token.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const slackTokenCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(slackToken).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {SlackTokenCollection} slackTokenCollection
+ * @property {SlackToken[]}
+ * @property {Links}
+ */
+export type SlackTokenCollection = z.infer<typeof slackTokenCollection>;
+
+/**
+ * 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 slackTokenCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(slackTokenResponse).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 slackTokenCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(slackTokenRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/channels/models/slack-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 slackTokenWebhook = z.lazy(() => {
+  return z.object({
+    url: z.string().min(1),
+  });
+});
+
+/**
+ * Obtained directly from the incoming_webhook object in the installation response from the Slack API.
+ * @typedef  {SlackTokenWebhook} slackTokenWebhook - Obtained directly from the incoming_webhook object in the installation response from the Slack API. - Obtained directly from the incoming_webhook object in the installation response from the Slack API.
+ * @property {string}
+ */
+export type SlackTokenWebhook = z.infer<typeof slackTokenWebhook>;
+
+/**
+ * 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 slackTokenWebhookResponse = z.lazy(() => {
+  return z
+    .object({
+      url: z.string().min(1),
+    })
+    .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 slackTokenWebhookRequest = z.lazy(() => {
+  return z
+    .object({
+      url: z.string().min(1),
+    })
+    .transform((data) => ({
+      url: data['url'],
+    }));
+});

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

@@ -0,0 +1,83 @@
+import { z } from 'zod';
+
+import { Oauth, oauth, oauthRequest, oauthResponse } from './oauth.js';
+import {
+  SlackTokenWebhook,
+  slackTokenWebhook,
+  slackTokenWebhookRequest,
+  slackTokenWebhookResponse,
+} from './slack-token-webhook.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const slackToken = z.lazy(() => {
+  return z.object({
+    createdAt: z.string(),
+    discardedAt: z.string().optional().nullable(),
+    id: z.string(),
+    oauth: oauth.optional(),
+    updatedAt: z.string().optional().nullable(),
+    webhook: slackTokenWebhook.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {SlackToken} slackToken
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {Oauth}
+ * @property {string}
+ * @property {SlackTokenWebhook} - Obtained directly from the incoming_webhook object in the installation response from the Slack API.
+ */
+export type SlackToken = z.infer<typeof slackToken>;
+
+/**
+ * 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 slackTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      created_at: z.string(),
+      discarded_at: z.string().optional().nullable(),
+      id: z.string(),
+      oauth: oauthResponse.optional(),
+      updated_at: z.string().optional().nullable(),
+      webhook: slackTokenWebhookResponse.optional(),
+    })
+    .transform((data) => ({
+      createdAt: data['created_at'],
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+      oauth: data['oauth'],
+      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 slackTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      createdAt: z.string(),
+      discardedAt: z.string().optional().nullable(),
+      id: z.string(),
+      oauth: oauthRequest.optional(),
+      updatedAt: z.string().optional().nullable(),
+      webhook: slackTokenWebhookRequest.optional(),
+    })
+    .transform((data) => ({
+      created_at: data['createdAt'],
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+      oauth: data['oauth'],
+      updated_at: data['updatedAt'],
+      webhook: data['webhook'],
+    }));
+});

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

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { TeamsToken, teamsToken, teamsTokenRequest, teamsTokenResponse } from './teams-token.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const teamsTokenCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(teamsToken).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {TeamsTokenCollection} teamsTokenCollection
+ * @property {TeamsToken[]}
+ * @property {Links}
+ */
+export type TeamsTokenCollection = z.infer<typeof teamsTokenCollection>;
+
+/**
+ * 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 teamsTokenCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(teamsTokenResponse).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 teamsTokenCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(teamsTokenRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-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/project-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/project-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'],
+    }));
+});