magicbell-js 1.4.0 → 1.6.0

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

@@ -1,6 +1,5 @@
 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';
@@ -9,9 +8,9 @@ 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 { InstallationId } from './installation-id.js';
 export type { Keys } from './keys.js';
 export type { Oauth } from './oauth.js';
 export type { SlackToken } from './slack-token.js';

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

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

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Keys model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const keys = z.lazy(() => {
   return z.object({
@@ -19,8 +21,9 @@ export const keys = z.lazy(() => {
 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
+ * Zod schema for mapping API responses to the Keys application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const keysResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const keysResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the Keys application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const keysRequest = z.lazy(() => {
   return z

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Oauth model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const oauth = z.lazy(() => {
   return z.object({
@@ -14,15 +16,16 @@ export const oauth = z.lazy(() => {
 /**
  *
  * @typedef  {Oauth} oauth
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - The ID of the Slack channel this installation is associated with
+ * @property {string} - A unique identifier for this Slack workspace installation
+ * @property {string} - The OAuth scope granted during installation
  */
 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
+ * Zod schema for mapping API responses to the Oauth application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const oauthResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const oauthResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the Oauth application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const oauthRequest = z.lazy(() => {
   return z

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

@@ -4,7 +4,9 @@ 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
+ * Zod schema for the SlackTokenCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const slackTokenCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const slackTokenCollection = z.lazy(() => {
 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
+ * Zod schema for mapping API responses to the SlackTokenCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const slackTokenCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const slackTokenCollectionResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the SlackTokenCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const slackTokenCollectionRequest = z.lazy(() => {
   return z

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the SlackTokenWebhook model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const slackTokenWebhook = z.lazy(() => {
   return z.object({
@@ -12,13 +14,14 @@ export const slackTokenWebhook = z.lazy(() => {
 /**
  * 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}
+ * @property {string} - The URL for the incoming webhook from Slack
  */
 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
+ * Zod schema for mapping API responses to the SlackTokenWebhook application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const slackTokenWebhookResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const slackTokenWebhookResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the SlackTokenWebhook application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const slackTokenWebhookRequest = z.lazy(() => {
   return z

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

@@ -9,7 +9,9 @@ import {
 } from './slack-token-webhook.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the SlackToken model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const slackToken = z.lazy(() => {
   return z.object({
@@ -25,18 +27,19 @@ export const slackToken = z.lazy(() => {
 /**
  *
  * @typedef  {SlackToken} slackToken
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - The timestamp when the token was created.
+ * @property {string} - The timestamp when the token was discarded, if applicable.
+ * @property {string} - The unique identifier for the token.
  * @property {Oauth}
- * @property {string}
+ * @property {string} - The timestamp when the token metadata last changed.
  * @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
+ * Zod schema for mapping API responses to the SlackToken application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const slackTokenResponse = z.lazy(() => {
   return z
@@ -59,8 +62,9 @@ export const slackTokenResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the SlackToken application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const slackTokenRequest = z.lazy(() => {
   return z

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

@@ -4,7 +4,9 @@ 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
+ * Zod schema for the TeamsTokenCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const teamsTokenCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const teamsTokenCollection = z.lazy(() => {
 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
+ * Zod schema for mapping API responses to the TeamsTokenCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const teamsTokenCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const teamsTokenCollectionResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the TeamsTokenCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const teamsTokenCollectionRequest = z.lazy(() => {
   return z

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the TeamsTokenWebhook model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const teamsTokenWebhook = z.lazy(() => {
   return z.object({
@@ -17,8 +19,9 @@ export const teamsTokenWebhook = z.lazy(() => {
 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
+ * Zod schema for mapping API responses to the TeamsTokenWebhook application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const teamsTokenWebhookResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const teamsTokenWebhookResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the TeamsTokenWebhook application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const teamsTokenWebhookRequest = z.lazy(() => {
   return z

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

@@ -8,7 +8,9 @@ import {
 } from './teams-token-webhook.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the TeamsToken model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const teamsToken = z.lazy(() => {
   return z.object({
@@ -23,17 +25,18 @@ export const teamsToken = z.lazy(() => {
 /**
  *
  * @typedef  {TeamsToken} teamsToken
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - The timestamp when the token was created.
+ * @property {string} - The timestamp when the token was discarded, if applicable.
+ * @property {string} - The unique identifier for the token.
+ * @property {string} - The timestamp when the token metadata last changed.
  * @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
+ * Zod schema for mapping API responses to the TeamsToken application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const teamsTokenResponse = z.lazy(() => {
   return z
@@ -54,8 +57,9 @@ export const teamsTokenResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the TeamsToken application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const teamsTokenRequest = z.lazy(() => {
   return z

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

@@ -4,7 +4,9 @@ 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
+ * Zod schema for the WebPushTokenCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const webPushTokenCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const webPushTokenCollection = z.lazy(() => {
 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
+ * Zod schema for mapping API responses to the WebPushTokenCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const webPushTokenCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const webPushTokenCollectionResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the WebPushTokenCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const webPushTokenCollectionRequest = z.lazy(() => {
   return z

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

@@ -3,7 +3,9 @@ import { z } from 'zod';
 import { Keys, keys, keysRequest, keysResponse } from './keys.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the WebPushToken model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const webPushToken = z.lazy(() => {
   return z.object({
@@ -19,18 +21,19 @@ export const webPushToken = z.lazy(() => {
 /**
  *
  * @typedef  {WebPushToken} webPushToken
- * @property {string}
- * @property {string}
+ * @property {string} - The timestamp when the token was created.
+ * @property {string} - The timestamp when the token was discarded, if applicable.
  * @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 {string} - The unique identifier for the token.
  * @property {Keys} - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
- * @property {string}
+ * @property {string} - The timestamp when the token metadata last changed.
  */
 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
+ * Zod schema for mapping API responses to the WebPushToken application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const webPushTokenResponse = z.lazy(() => {
   return z
@@ -53,8 +56,9 @@ export const webPushTokenResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the WebPushToken application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const webPushTokenRequest = z.lazy(() => {
   return z

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Links model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const links = z.lazy(() => {
   return z.object({
@@ -21,8 +23,9 @@ export const links = z.lazy(() => {
 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
+ * Zod schema for mapping API responses to the Links application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const linksResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const linksResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the Links application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const linksRequest = z.lazy(() => {
   return z

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the User model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const user = z.lazy(() => {
   return z.object({
@@ -21,22 +23,23 @@ export const user = z.lazy(() => {
 /**
  *
  * @typedef  {User} user
- * @property {string}
- * @property {any}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - The timestamp when the user was created.
+ * @property {any} - Arbitrary custom values stored on the user.
+ * @property {string} - The primary email address of the user.
+ * @property {string} - The user identifier from an external system.
+ * @property {string} - The first name of the user.
+ * @property {string} - The unique identifier for the user.
+ * @property {string} - The last name of the user.
+ * @property {string} - The timestamp when the user last received a notification.
+ * @property {string} - The timestamp when the user last opened the inbox.
+ * @property {string} - The timestamp when the user was last updated.
  */
 export type User = z.infer<typeof user>;
 
 /**
- * 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
+ * Zod schema for mapping API responses to the User application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const userResponse = z.lazy(() => {
   return z
@@ -67,8 +70,9 @@ export const userResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the User application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const userRequest = z.lazy(() => {
   return z

package/src/project-client/services/events/events-service.ts

@@ -10,12 +10,17 @@ import { Event, eventResponse } from './models/event.js';
 import { EventCollection, eventCollectionResponse } from './models/event-collection.js';
 import { ListEventsParams } from './request-params.js';
 
+/**
+ * Service class for EventsService operations.
+ * Provides methods to interact with EventsService-related API endpoints.
+ * All methods return promises and handle request/response serialization automatically.
+ */
 export class EventsService extends BaseService {
   /**
    * Retrieves a paginated list of events for the project.
-   * @param {number} [params.limit] -
-   * @param {string} [params.startingAfter] -
-   * @param {string} [params.endingBefore] -
+   * @param {number} [params.limit] - defines the maximum number of items to return per page (default: 50)
+   * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page
+   * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<EventCollection>>} - OK
    */

package/src/project-client/services/events/models/event-collection.ts

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { Event, event, eventRequest, eventResponse } from './event.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the EventCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const eventCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const eventCollection = z.lazy(() => {
 export type EventCollection = z.infer<typeof eventCollection>;
 
 /**
- * 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
+ * Zod schema for mapping API responses to the EventCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const eventCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const eventCollectionResponse = z.lazy(() => {
 });
 
 /**
- * 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
+ * Zod schema for mapping the EventCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const eventCollectionRequest = z.lazy(() => {
   return z