magicbell-js 1.5.0 → 1.7.0

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

package/src/project-client/services/events/models/event.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 Event 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 event = z.lazy(() => {
   return z.object({
@@ -10,6 +12,7 @@ export const event = z.lazy(() => {
     id: z.string(),
     level: z.string().optional(),
     log: z.string().optional().nullable(),
+    payload: z.any().optional().nullable(),
     timestamp: z.string(),
     type: z.string(),
   });
@@ -18,19 +21,21 @@ export const event = z.lazy(() => {
 /**
  *
  * @typedef  {Event} event
- * @property {number}
- * @property {any}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {number} - The numeric code that categorizes the event.
+ * @property {any} - Additional contextual attributes for the event.
+ * @property {string} - The unique identifier for the event.
+ * @property {string} - The severity level assigned to the event.
+ * @property {string} - A human-readable log message.
+ * @property {any} - The raw payload delivered by the event source.
+ * @property {string} - The time at which the event was recorded.
+ * @property {string} - The type of event that occurred.
  */
 export type Event = z.infer<typeof event>;
 
 /**
- * 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 Event 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 eventResponse = z.lazy(() => {
   return z
@@ -40,6 +45,7 @@ export const eventResponse = z.lazy(() => {
       id: z.string(),
       level: z.string().optional(),
       log: z.string().optional().nullable(),
+      payload: z.any().optional().nullable(),
       timestamp: z.string(),
       type: z.string(),
     })
@@ -49,14 +55,16 @@ export const eventResponse = z.lazy(() => {
       id: data['id'],
       level: data['level'],
       log: data['log'],
+      payload: data['payload'],
       timestamp: data['timestamp'],
       type: data['type'],
     }));
 });
 
 /**
- * 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 Event 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 eventRequest = z.lazy(() => {
   return z
@@ -66,6 +74,7 @@ export const eventRequest = z.lazy(() => {
       id: z.string(),
       level: z.string().optional(),
       log: z.string().optional().nullable(),
+      payload: z.any().optional().nullable(),
       timestamp: z.string(),
       type: z.string(),
     })
@@ -75,6 +84,7 @@ export const eventRequest = z.lazy(() => {
       id: data['id'],
       level: data['level'],
       log: data['log'],
+      payload: data['payload'],
       timestamp: data['timestamp'],
       type: data['type'],
     }));

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

@@ -120,12 +120,17 @@ import {
   ListIntegrationsParams,
 } from './request-params.js';
 
+/**
+ * Service class for IntegrationsService operations.
+ * Provides methods to interact with IntegrationsService-related API endpoints.
+ * All methods return promises and handle request/response serialization automatically.
+ */
 export class IntegrationsService extends BaseService {
   /**
    * Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information.
-   * @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<IntegrationConfigCollection>>} - OK
    */
@@ -224,7 +229,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the APNs integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -315,7 +320,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the EventSource integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -406,7 +411,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Expo integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -497,7 +502,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the FCM integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -588,7 +593,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the GitHub integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -679,7 +684,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Inbox integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -772,7 +777,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the MagicBell SlackBot integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -863,7 +868,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Mailgun integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -954,7 +959,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Ping Email integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1045,7 +1050,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the SendGrid integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1136,7 +1141,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Amazon SES integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1227,7 +1232,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Slack integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1315,7 +1320,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the SMTP integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1406,7 +1411,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Stripe integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1497,7 +1502,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Twilio integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */
@@ -1588,7 +1593,7 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Deletes the Web Push integration configuration from the project. This will disable the integration's functionality within the project.
-   * @param {string} [params.id] -
+   * @param {string} [params.id] - the unique identifier of the integration to be deleted
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<any>>} - No Content
    */

package/src/project-client/services/integrations/models/apns-config-collection.ts

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { ApnsConfig, apnsConfig, apnsConfigRequest, apnsConfigResponse } from './apns-config.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the ApnsConfigCollection 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 apnsConfigCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const apnsConfigCollection = z.lazy(() => {
 export type ApnsConfigCollection = z.infer<typeof apnsConfigCollection>;
 
 /**
- * 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 ApnsConfigCollection 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 apnsConfigCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const apnsConfigCollectionResponse = 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 ApnsConfigCollection 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 apnsConfigCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/apns-config-payload.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 ApnsConfigPayload 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 apnsConfigPayload = z.lazy(() => {
   return z.object({
@@ -20,17 +22,18 @@ export const apnsConfigPayload = z.lazy(() => {
  *
  * @typedef  {ApnsConfigPayload} apnsConfigPayload
  * @property {string} - The default bundle identifier of the application that is configured with this project. It can be overriden on a per token basis, when registering device tokens.
- * @property {Badge}
+ * @property {Badge} - Controls whether the app icon badge counts unread or unseen notifications.
  * @property {string} - The APNs certificate in P8 format. Generate it at [developer.apple.com](https://developer.apple.com/account/resources/authkeys/add) with the 'Apple Push Notification service (APNs)' option selected.
- * @property {string}
- * @property {PayloadVersion}
- * @property {string}
+ * @property {string} - The 10-character Key ID from your Apple Developer account used with the P8 certificate.
+ * @property {PayloadVersion} - Internal payload format version used by MagicBell.
+ * @property {string} - The Apple Developer Team ID that owns the configured key.
  */
 export type ApnsConfigPayload = z.infer<typeof apnsConfigPayload>;
 
 /**
- * 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 ApnsConfigPayload 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 apnsConfigPayloadResponse = z.lazy(() => {
   return z
@@ -55,8 +58,9 @@ export const apnsConfigPayloadResponse = 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 ApnsConfigPayload 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 apnsConfigPayloadRequest = z.lazy(() => {
   return z