magicbell-js 1.5.0 → 1.6.0

package/src/user-client/services/integrations/models/enterprise.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 Enterprise 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 enterprise = z.lazy(() => {
   return z.object({
@@ -13,14 +15,15 @@ export const enterprise = z.lazy(() => {
 /**
  *
  * @typedef  {Enterprise} enterprise
- * @property {string}
- * @property {string}
+ * @property {string} - Enterprise grid identifier.
+ * @property {string} - Enterprise grid name.
  */
 export type Enterprise = z.infer<typeof enterprise>;
 
 /**
- * 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 Enterprise 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 enterpriseResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const enterpriseResponse = 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 Enterprise 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 enterpriseRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/footer.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 Footer 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 footer = z.lazy(() => {
   return z.object({
@@ -13,18 +15,19 @@ export const footer = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Footer} footer
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * Footer styling for the inbox modal.
+ * @typedef  {Footer} footer - Footer styling for the inbox modal. - Footer styling for the inbox modal.
+ * @property {string} - Footer background color.
+ * @property {string} - Border radius applied to the footer container.
+ * @property {string} - Font size used in the footer.
+ * @property {string} - Footer text color.
  */
 export type Footer = z.infer<typeof footer>;
 
 /**
- * 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 Footer 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 footerResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const footerResponse = 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 Footer 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 footerRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/header.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 Header 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 header = z.lazy(() => {
   return z.object({
@@ -14,19 +16,20 @@ export const header = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Header} header
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * Header styling for the inbox modal.
+ * @typedef  {Header} header - Header styling for the inbox modal. - Header styling for the inbox modal.
+ * @property {string} - Header background color.
+ * @property {string} - Border radius applied to the header container.
+ * @property {string} - CSS font family for the header title.
+ * @property {string} - Font size used in the header.
+ * @property {string} - Header text color.
  */
 export type Header = z.infer<typeof header>;
 
 /**
- * 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 Header 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 headerResponse = z.lazy(() => {
   return z
@@ -47,8 +50,9 @@ export const headerResponse = 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 Header 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 headerRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/icon.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 Icon 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 icon = z.lazy(() => {
   return z.object({
@@ -11,16 +13,17 @@ export const icon = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Icon} icon
- * @property {string}
- * @property {string}
+ * Launcher icon styling overrides.
+ * @typedef  {Icon} icon - Launcher icon styling overrides. - Launcher icon styling overrides.
+ * @property {string} - CSS color used for the icon border.
+ * @property {string} - Width of the launcher icon (any CSS length).
  */
 export type Icon = z.infer<typeof icon>;
 
 /**
- * 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 Icon 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 iconResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const iconResponse = 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 Icon 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 iconRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/images.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 Images 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 images = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const images = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Images} images
- * @property {string}
+ * Image overrides for assets used in the inbox UI.
+ * @typedef  {Images} images - Image overrides for assets used in the inbox UI. - Image overrides for assets used in the inbox UI.
+ * @property {string} - URL for the illustration shown when the inbox is empty.
  */
 export type Images = z.infer<typeof images>;
 
 /**
- * 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 Images 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 imagesResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const imagesResponse = 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 Images 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 imagesRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/inbox-config-payload.ts

@@ -4,7 +4,9 @@ import { Images, images, imagesRequest, imagesResponse } from './images.js';
 import { Theme, theme, themeRequest, themeResponse } from './theme.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the InboxConfigPayload 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 inboxConfigPayload = z.lazy(() => {
   return z.object({
@@ -17,15 +19,16 @@ export const inboxConfigPayload = z.lazy(() => {
 /**
  *
  * @typedef  {InboxConfigPayload} inboxConfigPayload
- * @property {Images}
- * @property {string}
- * @property {Theme}
+ * @property {Images} - Image overrides for assets used in the inbox UI.
+ * @property {string} - Locale code (ISO language tag) used to localize built-in strings.
+ * @property {Theme} - Visual customization options for the hosted inbox widget.
  */
 export type InboxConfigPayload = z.infer<typeof inboxConfigPayload>;
 
 /**
- * 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 InboxConfigPayload 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 inboxConfigPayloadResponse = z.lazy(() => {
   return z
@@ -42,8 +45,9 @@ export const inboxConfigPayloadResponse = 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 InboxConfigPayload 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 inboxConfigPayloadRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/incoming-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 IncomingWebhook 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 incomingWebhook = z.lazy(() => {
   return z.object({
@@ -14,15 +16,16 @@ export const incomingWebhook = z.lazy(() => {
 /**
  *
  * @typedef  {IncomingWebhook} incomingWebhook
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - Human readable name for the webhook channel.
+ * @property {string} - URL users can visit to manage the webhook.
+ * @property {string} - Webhook URL that Slack posts events to.
  */
 export type IncomingWebhook = z.infer<typeof incomingWebhook>;
 
 /**
- * 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 IncomingWebhook 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 incomingWebhookResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const incomingWebhookResponse = 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 IncomingWebhook 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 incomingWebhookRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/slack-finish-install-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 SlackFinishInstallResponse 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 slackFinishInstallResponse = z.lazy(() => {
   return z.object({
@@ -21,8 +23,9 @@ export const slackFinishInstallResponse = z.lazy(() => {
 export type SlackFinishInstallResponse = z.infer<typeof slackFinishInstallResponse>;
 
 /**
- * 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 SlackFinishInstallResponse 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 slackFinishInstallResponseResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const slackFinishInstallResponseResponse = 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 SlackFinishInstallResponse 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 slackFinishInstallResponseRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/slack-installation.ts

@@ -11,7 +11,9 @@ import {
 import { Team, team, teamRequest, teamResponse } from './team.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the SlackInstallation 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 slackInstallation = z.lazy(() => {
   return z.object({
@@ -37,25 +39,26 @@ export const slackInstallation = z.lazy(() => {
 /**
  *
  * @typedef  {SlackInstallation} slackInstallation
- * @property {string}
- * @property {string}
+ * @property {string} - Bot token returned from the Slack OAuth exchange.
+ * @property {string} - Slack app identifier for the installed app.
  * @property {AuthedUser}
- * @property {string}
+ * @property {string} - Slack user ID of the installed bot.
  * @property {Enterprise}
- * @property {number}
- * @property {string}
+ * @property {number} - Seconds until the bot access token expires.
+ * @property {string} - Unique identifier MagicBell assigns to the Slack installation.
  * @property {IncomingWebhook}
- * @property {boolean}
- * @property {string}
- * @property {string}
+ * @property {boolean} - Indicates whether the installation occurred on an enterprise grid.
+ * @property {string} - Refresh token for regenerating the bot access token.
+ * @property {string} - Space-delimited OAuth scopes granted to the bot token.
  * @property {Team}
- * @property {string}
+ * @property {string} - Type of bot token returned by Slack.
  */
 export type SlackInstallation = z.infer<typeof slackInstallation>;
 
 /**
- * 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 SlackInstallation 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 slackInstallationResponse = z.lazy(() => {
   return z
@@ -95,8 +98,9 @@ export const slackInstallationResponse = 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 SlackInstallation 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 slackInstallationRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/slack-start-install-response-content.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 SlackStartInstallResponseContent 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 slackStartInstallResponseContent = z.lazy(() => {
   return z.object({
@@ -21,8 +23,9 @@ export const slackStartInstallResponseContent = z.lazy(() => {
 export type SlackStartInstallResponseContent = z.infer<typeof slackStartInstallResponseContent>;
 
 /**
- * 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 SlackStartInstallResponseContent 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 slackStartInstallResponseContentResponse = z.lazy(() => {
   return z
@@ -39,8 +42,9 @@ export const slackStartInstallResponseContentResponse = 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 SlackStartInstallResponseContent 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 slackStartInstallResponseContentRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/slack-start-install.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 SlackStartInstall 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 slackStartInstall = z.lazy(() => {
   return z.object({
@@ -15,16 +17,17 @@ export const slackStartInstall = z.lazy(() => {
 /**
  *
  * @typedef  {SlackStartInstall} slackStartInstall
- * @property {string}
- * @property {string}
- * @property {string[]}
- * @property {string}
+ * @property {string} - Slack app ID that the installation flow should use.
+ * @property {string} - Optional override for the authorization URL returned to the client.
+ * @property {string[]} - Additional OAuth scopes to request during installation.
+ * @property {string} - Custom redirect URL to use after OAuth completes.
  */
 export type SlackStartInstall = z.infer<typeof slackStartInstall>;
 
 /**
- * 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 SlackStartInstall 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 slackStartInstallResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const slackStartInstallResponse = 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 SlackStartInstall 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 slackStartInstallRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/team.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 Team 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 team = z.lazy(() => {
   return z.object({
@@ -13,14 +15,15 @@ export const team = z.lazy(() => {
 /**
  *
  * @typedef  {Team} team
- * @property {string}
- * @property {string}
+ * @property {string} - Workspace ID where the app was installed.
+ * @property {string} - Workspace name where the app was installed.
  */
 export type Team = z.infer<typeof team>;
 
 /**
- * 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 Team 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 teamResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const teamResponse = 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 Team 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 teamRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/theme-notification.ts

@@ -5,7 +5,9 @@ import { Unread, unread, unreadRequest, unreadResponse } from './unread.js';
 import { Unseen, unseen, unseenRequest, unseenResponse } from './unseen.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the ThemeNotification 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 themeNotification = z.lazy(() => {
   return z.object({
@@ -16,17 +18,18 @@ export const themeNotification = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {ThemeNotification} themeNotification
- * @property {Default_}
- * @property {Unread}
- * @property {Unseen}
+ * Styling overrides for notification list items.
+ * @typedef  {ThemeNotification} themeNotification - Styling overrides for notification list items. - Styling overrides for notification list items.
+ * @property {Default_} - Base styles applied to every notification item.
+ * @property {Unread} - Overrides for unread notifications.
+ * @property {Unseen} - Overrides for unseen notifications.
  */
 export type ThemeNotification = z.infer<typeof themeNotification>;
 
 /**
- * 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 ThemeNotification 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 themeNotificationResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const themeNotificationResponse = 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 ThemeNotification 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 themeNotificationRequest = z.lazy(() => {
   return z