magicbell-js 1.4.0 → 1.6.0

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

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

@@ -8,7 +8,9 @@ import {
 } from './apns-config-payload.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the ApnsConfig 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 apnsConfig = z.lazy(() => {
   return z.object({
@@ -28,8 +30,9 @@ export const apnsConfig = z.lazy(() => {
 export type ApnsConfig = z.infer<typeof apnsConfig>;
 
 /**
- * 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 ApnsConfig 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 apnsConfigResponse = z.lazy(() => {
   return z
@@ -46,8 +49,9 @@ export const apnsConfigResponse = 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 ApnsConfig 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 apnsConfigRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/banner.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 Banner 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 banner = z.lazy(() => {
   return z.object({
@@ -13,18 +15,19 @@ export const banner = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Banner} banner
- * @property {string}
- * @property {number}
- * @property {string}
- * @property {string}
+ * Top banner styling options.
+ * @typedef  {Banner} banner - Top banner styling options. - Top banner styling options.
+ * @property {string} - Banner background color.
+ * @property {number} - Opacity applied to the banner background.
+ * @property {string} - Font size for banner text.
+ * @property {string} - Banner text color.
  */
 export type Banner = z.infer<typeof banner>;
 
 /**
- * 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 Banner 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 bannerResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const bannerResponse = 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 Banner 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 bannerRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/default-hover.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 DefaultHover 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 defaultHover = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const defaultHover = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {DefaultHover} defaultHover
- * @property {string}
+ * Styles applied when a notification is hovered.
+ * @typedef  {DefaultHover} defaultHover - Styles applied when a notification is hovered. - Styles applied when a notification is hovered.
+ * @property {string} - Background color on hover.
  */
 export type DefaultHover = z.infer<typeof defaultHover>;
 
 /**
- * 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 DefaultHover 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 defaultHoverResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const defaultHoverResponse = 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 DefaultHover 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 defaultHoverRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/default-state.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 DefaultState 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 defaultState = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const defaultState = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {DefaultState} defaultState
- * @property {string}
+ * Accent colors for notification state indicators.
+ * @typedef  {DefaultState} defaultState - Accent colors for notification state indicators. - Accent colors for notification state indicators.
+ * @property {string} - Color used for the state indicator.
  */
 export type DefaultState = z.infer<typeof defaultState>;
 
 /**
- * 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 DefaultState 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 defaultStateResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const defaultStateResponse = 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 DefaultState 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 defaultStateRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/default_.ts

@@ -4,7 +4,9 @@ import { DefaultHover, defaultHover, defaultHoverRequest, defaultHoverResponse }
 import { DefaultState, defaultState, defaultStateRequest, defaultStateResponse } from './default-state.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Default_ 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 default_ = z.lazy(() => {
   return z.object({
@@ -20,22 +22,23 @@ export const default_ = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Default_} default_
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {DefaultHover}
- * @property {string}
- * @property {DefaultState}
- * @property {string}
+ * Base styles applied to every notification item.
+ * @typedef  {Default_} default_ - Base styles applied to every notification item. - Base styles applied to every notification item.
+ * @property {string} - Background color for notifications in their default state.
+ * @property {string} - Border radius applied to each notification card.
+ * @property {string} - Font family for notification text.
+ * @property {string} - Font size for notification text.
+ * @property {DefaultHover} - Styles applied when a notification is hovered.
+ * @property {string} - CSS margin applied around each notification card.
+ * @property {DefaultState} - Accent colors for notification state indicators.
+ * @property {string} - Default text color for notifications.
  */
 export type Default_ = z.infer<typeof default_>;
 
 /**
- * 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 Default_ 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 defaultResponse = z.lazy(() => {
   return z
@@ -62,8 +65,9 @@ export const defaultResponse = 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 Default_ 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 defaultRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/dialog.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 Dialog 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 dialog = z.lazy(() => {
   return z.object({
@@ -12,17 +14,18 @@ export const dialog = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Dialog} dialog
- * @property {string}
- * @property {string}
- * @property {string}
+ * Styling for confirmation and action dialogs.
+ * @typedef  {Dialog} dialog - Styling for confirmation and action dialogs. - Styling for confirmation and action dialogs.
+ * @property {string} - Accent color for dialog buttons and highlights.
+ * @property {string} - Dialog background color.
+ * @property {string} - Dialog text color.
  */
 export type Dialog = z.infer<typeof dialog>;
 
 /**
- * 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 Dialog 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 dialogResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const dialogResponse = 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 Dialog 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 dialogRequest = z.lazy(() => {
   return z