magicbell-js 1.5.0 → 1.7.0

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

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

@@ -3,7 +3,9 @@ import { z } from 'zod';
 import { Categories, categories, categoriesRequest, categoriesResponse } from './categories.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UserPreferences 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 userPreferences = z.lazy(() => {
   return z.object({
@@ -19,8 +21,9 @@ export const userPreferences = z.lazy(() => {
 export type UserPreferences = z.infer<typeof userPreferences>;
 
 /**
- * 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 UserPreferences 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 userPreferencesResponse = z.lazy(() => {
   return z
@@ -33,8 +36,9 @@ export const userPreferencesResponse = 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 UserPreferences 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 userPreferencesRequest = z.lazy(() => {
   return z

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

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the WebPushTokenKeys 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 webPushTokenKeys = z.lazy(() => {
   return z.object({
@@ -19,8 +21,9 @@ export const webPushTokenKeys = z.lazy(() => {
 export type WebPushTokenKeys = z.infer<typeof webPushTokenKeys>;
 
 /**
- * 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 WebPushTokenKeys 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 webPushTokenKeysResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const webPushTokenKeysResponse = 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 WebPushTokenKeys 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 webPushTokenKeysRequest = z.lazy(() => {
   return z

package/src/user-client/services/channels/models/web-push-token-payload-keys.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the WebPushTokenPayloadKeys 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 webPushTokenPayloadKeys = z.lazy(() => {
   return z.object({
@@ -19,8 +21,9 @@ export const webPushTokenPayloadKeys = z.lazy(() => {
 export type WebPushTokenPayloadKeys = z.infer<typeof webPushTokenPayloadKeys>;
 
 /**
- * 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 WebPushTokenPayloadKeys 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 webPushTokenPayloadKeysResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const webPushTokenPayloadKeysResponse = 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 WebPushTokenPayloadKeys 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 webPushTokenPayloadKeysRequest = z.lazy(() => {
   return z

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

@@ -8,7 +8,9 @@ import {
 } from './web-push-token-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({
@@ -24,18 +26,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 {WebPushTokenKeys} - 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
@@ -58,8 +61,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/user-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/user-client/services/common/web-push-token-payload.ts

@@ -8,7 +8,9 @@ import {
 } from '../channels/models/web-push-token-payload-keys.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the WebPushTokenPayload 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 webPushTokenPayload = z.lazy(() => {
   return z.object({
@@ -26,8 +28,9 @@ export const webPushTokenPayload = z.lazy(() => {
 export type WebPushTokenPayload = z.infer<typeof webPushTokenPayload>;
 
 /**
- * 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 WebPushTokenPayload 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 webPushTokenPayloadResponse = z.lazy(() => {
   return z
@@ -42,8 +45,9 @@ export const webPushTokenPayloadResponse = 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 WebPushTokenPayload 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 webPushTokenPayloadRequest = z.lazy(() => {
   return z

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

@@ -31,6 +31,11 @@ import {
   webPushStartInstallationResponseResponse,
 } from './models/web-push-start-installation-response.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 {
   /**
    * Creates a new installation of a Inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.

package/src/user-client/services/integrations/models/authed-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 AuthedUser 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 authedUser = z.lazy(() => {
   return z.object({
@@ -17,18 +19,19 @@ export const authedUser = z.lazy(() => {
 /**
  *
  * @typedef  {AuthedUser} authedUser
- * @property {string}
- * @property {number}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - User token returned from the OAuth exchange.
+ * @property {number} - Seconds until the user token expires.
+ * @property {string} - Slack user ID for the installer.
+ * @property {string} - Refresh token for the authed user.
+ * @property {string} - Space-delimited OAuth scopes granted to the user token.
+ * @property {string} - Token type value provided by Slack.
  */
 export type AuthedUser = z.infer<typeof authedUser>;
 
 /**
- * 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 AuthedUser 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 authedUserResponse = z.lazy(() => {
   return z
@@ -51,8 +54,9 @@ export const authedUserResponse = 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 AuthedUser 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 authedUserRequest = z.lazy(() => {
   return z

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