magicbell-js 1.5.0 → 1.6.0

package/src/user-client/services/channels/models/fcm-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 FcmToken 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 fcmToken = z.lazy(() => {
   return z.object({
@@ -16,17 +18,18 @@ export const fcmToken = z.lazy(() => {
 /**
  *
  * @typedef  {FcmToken} fcmToken
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - The timestamp when the token was created.
+ * @property {string} - The Firebase Cloud Messaging device registration token to associate with the user.
+ * @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.
  */
 export type FcmToken = z.infer<typeof fcmToken>;
 
 /**
- * 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 FcmToken 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 fcmTokenResponse = z.lazy(() => {
   return z
@@ -47,8 +50,9 @@ export const fcmTokenResponse = 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 FcmToken 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 fcmTokenRequest = z.lazy(() => {
   return z

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

@@ -9,7 +9,9 @@ import {
 } from './inbox-token-response.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the InboxTokenResponseCollection 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 inboxTokenResponseCollection = z.lazy(() => {
   return z.object({
@@ -27,8 +29,9 @@ export const inboxTokenResponseCollection = z.lazy(() => {
 export type InboxTokenResponseCollection = z.infer<typeof inboxTokenResponseCollection>;
 
 /**
- * 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 InboxTokenResponseCollection 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 inboxTokenResponseCollectionResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const inboxTokenResponseCollectionResponse = 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 InboxTokenResponseCollection 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 inboxTokenResponseCollectionRequest = z.lazy(() => {
   return z

package/src/user-client/services/channels/models/inbox-token-response.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 InboxTokenResponse 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 inboxTokenResponse = z.lazy(() => {
   return z.object({
@@ -17,18 +19,19 @@ export const inboxTokenResponse = z.lazy(() => {
 /**
  *
  * @typedef  {InboxTokenResponse} inboxTokenResponse
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - Realtime connection ID to restrict delivery to a specific Ably connection.
+ * @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 in-app inbox token generated for this user.
+ * @property {string} - The timestamp when the token metadata last changed.
  */
 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
+ * Zod schema for mapping API responses to the InboxTokenResponse 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 inboxTokenResponseResponse = z.lazy(() => {
   return z
@@ -51,8 +54,9 @@ export const inboxTokenResponseResponse = 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 InboxTokenResponse 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 inboxTokenResponseRequest = z.lazy(() => {
   return z

package/src/user-client/services/channels/models/inbox-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 InboxToken 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 inboxToken = z.lazy(() => {
   return z.object({
@@ -13,14 +15,15 @@ export const inboxToken = z.lazy(() => {
 /**
  *
  * @typedef  {InboxToken} inboxToken
- * @property {string}
- * @property {string}
+ * @property {string} - Realtime connection ID to restrict delivery to a specific Ably connection.
+ * @property {string} - The in-app inbox token generated for this user.
  */
 export type InboxToken = z.infer<typeof inboxToken>;
 
 /**
- * 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 InboxToken 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 inboxTokenResponse1 = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const inboxTokenResponse1 = 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 InboxToken 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 inboxTokenRequest = z.lazy(() => {
   return z

package/src/user-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/user-client/services/channels/models/slack-token-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 SlackTokenOauth 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 slackTokenOauth = z.lazy(() => {
   return z.object({
@@ -14,15 +16,16 @@ export const slackTokenOauth = z.lazy(() => {
 /**
  *
  * @typedef  {SlackTokenOauth} slackTokenOauth
- * @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 SlackTokenOauth = z.infer<typeof slackTokenOauth>;
 
 /**
- * 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 SlackTokenOauth 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 slackTokenOauthResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const slackTokenOauthResponse = 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 SlackTokenOauth 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 slackTokenOauthRequest = z.lazy(() => {
   return z

package/src/user-client/services/channels/models/slack-token-payload-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 SlackTokenPayloadOauth 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 slackTokenPayloadOauth = z.lazy(() => {
   return z.object({
@@ -14,15 +16,16 @@ export const slackTokenPayloadOauth = z.lazy(() => {
 /**
  *
  * @typedef  {SlackTokenPayloadOauth} slackTokenPayloadOauth
- * @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 SlackTokenPayloadOauth = z.infer<typeof slackTokenPayloadOauth>;
 
 /**
- * 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 SlackTokenPayloadOauth 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 slackTokenPayloadOauthResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const slackTokenPayloadOauthResponse = 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 SlackTokenPayloadOauth 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 slackTokenPayloadOauthRequest = z.lazy(() => {
   return z

package/src/user-client/services/channels/models/slack-token-payload-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 SlackTokenPayloadWebhook 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 slackTokenPayloadWebhook = z.lazy(() => {
   return z.object({
@@ -12,13 +14,14 @@ export const slackTokenPayloadWebhook = z.lazy(() => {
 /**
  * Obtained directly from the incoming_webhook object in the installation response from the Slack API.
  * @typedef  {SlackTokenPayloadWebhook} slackTokenPayloadWebhook - 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 SlackTokenPayloadWebhook = z.infer<typeof slackTokenPayloadWebhook>;
 
 /**
- * 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 SlackTokenPayloadWebhook 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 slackTokenPayloadWebhookResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const slackTokenPayloadWebhookResponse = 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 SlackTokenPayloadWebhook 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 slackTokenPayloadWebhookRequest = z.lazy(() => {
   return z

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

@@ -14,7 +14,9 @@ import {
 } from './slack-token-payload-webhook.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the SlackTokenPayload 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 slackTokenPayload = z.lazy(() => {
   return z.object({
@@ -32,8 +34,9 @@ export const slackTokenPayload = z.lazy(() => {
 export type SlackTokenPayload = z.infer<typeof slackTokenPayload>;
 
 /**
- * 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 SlackTokenPayload 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 slackTokenPayloadResponse = z.lazy(() => {
   return z
@@ -48,8 +51,9 @@ export const slackTokenPayloadResponse = 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 SlackTokenPayload 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 slackTokenPayloadRequest = z.lazy(() => {
   return z

package/src/user-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/user-client/services/channels/models/slack-token.ts

@@ -14,7 +14,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({
@@ -30,18 +32,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 {SlackTokenOauth}
- * @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
@@ -64,8 +67,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/user-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/user-client/services/channels/models/teams-token-payload-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 TeamsTokenPayloadWebhook 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 teamsTokenPayloadWebhook = z.lazy(() => {
   return z.object({
@@ -17,8 +19,9 @@ export const teamsTokenPayloadWebhook = z.lazy(() => {
 export type TeamsTokenPayloadWebhook = z.infer<typeof teamsTokenPayloadWebhook>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the TeamsTokenPayloadWebhook 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 teamsTokenPayloadWebhookResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const teamsTokenPayloadWebhookResponse = 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 TeamsTokenPayloadWebhook 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 teamsTokenPayloadWebhookRequest = z.lazy(() => {
   return z

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

@@ -8,7 +8,9 @@ import {
 } from './teams-token-payload-webhook.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the TeamsTokenPayload 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 teamsTokenPayload = z.lazy(() => {
   return z.object({
@@ -24,8 +26,9 @@ export const teamsTokenPayload = z.lazy(() => {
 export type TeamsTokenPayload = z.infer<typeof teamsTokenPayload>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the TeamsTokenPayload 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 teamsTokenPayloadResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const teamsTokenPayloadResponse = 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 TeamsTokenPayload 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 teamsTokenPayloadRequest = z.lazy(() => {
   return z

package/src/user-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