magicbell-js 1.5.0 → 1.7.0

package/src/project-client/services/broadcasts/models/in-app.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 InApp 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 inApp = z.lazy(() => {
   return z.object({
@@ -12,17 +14,18 @@ export const inApp = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {InApp} inApp
- * @property {string}
- * @property {string}
- * @property {string}
+ * Overrides for in-app notifications.
+ * @typedef  {InApp} inApp - Overrides for in-app notifications. - Overrides for in-app notifications.
+ * @property {string} - The link associated with the channel-specific notification.
+ * @property {string} - The channel-specific content.
+ * @property {string} - The channel-specific title.
  */
 export type InApp = z.infer<typeof inApp>;
 
 /**
- * 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 InApp 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 inAppResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const inAppResponse = 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 InApp 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 inAppRequest = z.lazy(() => {
   return z

package/src/project-client/services/broadcasts/models/mobile-push.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 MobilePush 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 mobilePush = z.lazy(() => {
   return z.object({
@@ -12,17 +14,18 @@ export const mobilePush = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {MobilePush} mobilePush
- * @property {string}
- * @property {string}
- * @property {string}
+ * Overrides for mobile push notifications.
+ * @typedef  {MobilePush} mobilePush - Overrides for mobile push notifications. - Overrides for mobile push notifications.
+ * @property {string} - The link associated with the channel-specific notification.
+ * @property {string} - The channel-specific content.
+ * @property {string} - The channel-specific title.
  */
 export type MobilePush = z.infer<typeof mobilePush>;
 
 /**
- * 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 MobilePush 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 mobilePushResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const mobilePushResponse = 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 MobilePush 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 mobilePushRequest = z.lazy(() => {
   return z

package/src/project-client/services/broadcasts/models/overrides-channels.ts

@@ -6,7 +6,9 @@ import { MobilePush, mobilePush, mobilePushRequest, mobilePushResponse } from '.
 import { Sms, sms, smsRequest, smsResponse } from './sms.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the OverridesChannels 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 overridesChannels = z.lazy(() => {
   return z.object({
@@ -18,18 +20,19 @@ export const overridesChannels = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {OverridesChannels} overridesChannels
- * @property {Email}
- * @property {InApp}
- * @property {MobilePush}
- * @property {Sms}
+ * Overrides that are scoped to individual delivery channels.
+ * @typedef  {OverridesChannels} overridesChannels - Overrides that are scoped to individual delivery channels. - Overrides that are scoped to individual delivery channels.
+ * @property {Email} - Overrides for email notifications.
+ * @property {InApp} - Overrides for in-app notifications.
+ * @property {MobilePush} - Overrides for mobile push notifications.
+ * @property {Sms} - Overrides for SMS notifications.
  */
 export type OverridesChannels = z.infer<typeof overridesChannels>;
 
 /**
- * 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 OverridesChannels 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 overridesChannelsResponse = z.lazy(() => {
   return z
@@ -48,8 +51,9 @@ export const overridesChannelsResponse = 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 OverridesChannels 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 overridesChannelsRequest = z.lazy(() => {
   return z

package/src/project-client/services/broadcasts/models/overrides.ts

@@ -9,7 +9,9 @@ import {
 import { Providers, providers, providersRequest, providersResponse } from './providers.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Overrides 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 overrides = z.lazy(() => {
   return z.object({
@@ -19,16 +21,17 @@ export const overrides = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Overrides} overrides
- * @property {OverridesChannels}
- * @property {Providers}
+ * Channel- or provider-specific values that override the defaults.
+ * @typedef  {Overrides} overrides - Channel- or provider-specific values that override the defaults. - Channel- or provider-specific values that override the defaults.
+ * @property {OverridesChannels} - Overrides that are scoped to individual delivery channels.
+ * @property {Providers} - Overrides that are scoped to specific providers for a channel.
  */
 export type Overrides = z.infer<typeof overrides>;
 
 /**
- * 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 Overrides 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 overridesResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const overridesResponse = 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 Overrides 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 overridesRequest = z.lazy(() => {
   return z

package/src/project-client/services/broadcasts/models/providers.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 Providers 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 providers = z.lazy(() => {
   return z.object({
@@ -19,24 +21,25 @@ export const providers = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Providers} providers
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
- * @property {any}
+ * Overrides that are scoped to specific providers for a channel.
+ * @typedef  {Providers} providers - Overrides that are scoped to specific providers for a channel. - Overrides that are scoped to specific providers for a channel.
+ * @property {any} - Provider-specific overrides for Apple Push Notification service.
+ * @property {any} - Provider-specific overrides for Expo push notifications.
+ * @property {any} - Provider-specific overrides for Firebase Cloud Messaging.
+ * @property {any} - Provider-specific overrides for Mailgun.
+ * @property {any} - Provider-specific overrides for Sendgrid.
+ * @property {any} - Provider-specific overrides for AWS SES.
+ * @property {any} - Provider-specific overrides for Slack.
+ * @property {any} - Provider-specific overrides for Microsoft Teams.
+ * @property {any} - Provider-specific overrides for Twilio.
+ * @property {any} - Provider-specific overrides for the web push provider.
  */
 export type Providers = z.infer<typeof providers>;
 
 /**
- * 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 Providers 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 providersResponse = z.lazy(() => {
   return z
@@ -67,8 +70,9 @@ export const providersResponse = 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 Providers 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 providersRequest = z.lazy(() => {
   return z

package/src/project-client/services/broadcasts/models/sms.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 Sms 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 sms = z.lazy(() => {
   return z.object({
@@ -12,17 +14,18 @@ export const sms = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Sms} sms
- * @property {string}
- * @property {string}
- * @property {string}
+ * Overrides for SMS notifications.
+ * @typedef  {Sms} sms - Overrides for SMS notifications. - Overrides for SMS notifications.
+ * @property {string} - The link associated with the channel-specific notification.
+ * @property {string} - The channel-specific content.
+ * @property {string} - The channel-specific title.
  */
 export type Sms = z.infer<typeof sms>;
 
 /**
- * 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 Sms 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 smsResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const smsResponse = 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 Sms 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 smsRequest = z.lazy(() => {
   return z

package/src/project-client/services/broadcasts/models/summary.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 Summary 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 summary = z.lazy(() => {
   return z.object({
@@ -11,16 +13,17 @@ export const summary = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Summary} summary
+ * The summary counts for total recipients and failures.
+ * @typedef  {Summary} summary - The summary counts for total recipients and failures. - The summary counts for total recipients and failures.
  * @property {number} - The number of failures while processing the broadcast.
  * @property {number} - The number of recipients that the broadcast was sent to.
  */
 export type Summary = z.infer<typeof summary>;
 
 /**
- * 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 Summary 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 summaryResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const summaryResponse = 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 Summary 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 summaryRequest = z.lazy(() => {
   return z

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

@@ -40,6 +40,11 @@ import {
   ListUserWebPushTokensParams,
 } from './request-params.js';
 
+/**
+ * Service class for ChannelsService operations.
+ * Provides methods to interact with ChannelsService-related API endpoints.
+ * All methods return promises and handle request/response serialization automatically.
+ */
 export class ChannelsService extends BaseService {
   /**
    * Save the channels configuration for a given key.
@@ -106,9 +111,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all Inbox tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<InboxTokenResponseCollection>>} - OK
    */
@@ -236,9 +241,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all APNs tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<ApnsTokenCollection>>} - OK
    */
@@ -366,9 +371,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all Expo tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<ExpoTokenCollection>>} - OK
    */
@@ -496,9 +501,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all FCM tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<FcmTokenCollection>>} - OK
    */
@@ -626,9 +631,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all MagicBell SlackBot tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<SlackTokenCollection>>} - OK
    */
@@ -756,9 +761,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all Slack tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<SlackTokenCollection>>} - OK
    */
@@ -886,9 +891,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all Teams tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<TeamsTokenCollection>>} - OK
    */
@@ -1016,9 +1021,9 @@ export class ChannelsService extends BaseService {
   /**
    * Lists all Web Push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
    * @param {string} userId -
-   * @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<WebPushTokenCollection>>} - OK
    */

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

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { ApnsToken, apnsToken, apnsTokenRequest, apnsTokenResponse } from './apns-token.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the ApnsTokenCollection 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 apnsTokenCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const apnsTokenCollection = z.lazy(() => {
 export type ApnsTokenCollection = z.infer<typeof apnsTokenCollection>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the ApnsTokenCollection 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 apnsTokenCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const apnsTokenCollectionResponse = 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 ApnsTokenCollection 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 apnsTokenCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/channels/models/apns-token.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 ApnsToken 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 apnsToken = z.lazy(() => {
   return z.object({
@@ -21,19 +23,20 @@ export const apnsToken = z.lazy(() => {
 /**
  *
  * @typedef  {ApnsToken} apnsToken
- * @property {string} - (Optional) The bundle identifier of the application that is registering this token. Use this field to override the default identifier specified in the projects APNs integration.
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {InstallationId} - (Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`.
- * @property {string}
+ * @property {string} - The bundle identifier of the application registering this token. Use this to override the default identifier configured on the APNs integration.
+ * @property {string} - The timestamp when the token was created.
+ * @property {string} - The APNs device token to register with MagicBell.
+ * @property {string} - The timestamp when the token was discarded, if applicable.
+ * @property {string} - The unique identifier for the token.
+ * @property {InstallationId} - The APNs environment this token belongs to. If omitted we assume it targets `production`.
+ * @property {string} - The timestamp when the token metadata last changed.
  */
 export type ApnsToken = z.infer<typeof apnsToken>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the ApnsToken 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 apnsTokenResponse = z.lazy(() => {
   return z
@@ -61,8 +64,9 @@ export const apnsTokenResponse = 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 ApnsToken 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 apnsTokenRequest = z.lazy(() => {
   return z

package/src/project-client/services/channels/models/category-delivery-config-channels.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 CategoryDeliveryConfigChannels 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 categoryDeliveryConfigChannels = z.lazy(() => {
   return z.object({
@@ -14,15 +16,16 @@ export const categoryDeliveryConfigChannels = z.lazy(() => {
 /**
  *
  * @typedef  {CategoryDeliveryConfigChannels} categoryDeliveryConfigChannels
- * @property {Channel}
- * @property {number}
- * @property {string}
+ * @property {Channel} - Name of the channel used for this step.
+ * @property {number} - Delay in seconds to wait after the previous step.
+ * @property {string} - Conditional expression evaluated before running the step.
  */
 export type CategoryDeliveryConfigChannels = z.infer<typeof categoryDeliveryConfigChannels>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the CategoryDeliveryConfigChannels 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 categoryDeliveryConfigChannelsResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const categoryDeliveryConfigChannelsResponse = 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 CategoryDeliveryConfigChannels 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 categoryDeliveryConfigChannelsRequest = z.lazy(() => {
   return z