magicbell-js 1.4.0 → 1.6.0

package/src/project-client/services/integrations/models/event-source-config-collection.ts

@@ -9,7 +9,9 @@ import {
 } from './event-source-config.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the EventSourceConfigCollection 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 eventSourceConfigCollection = z.lazy(() => {
   return z.object({
@@ -27,8 +29,9 @@ export const eventSourceConfigCollection = z.lazy(() => {
 export type EventSourceConfigCollection = z.infer<typeof eventSourceConfigCollection>;
 
 /**
- * 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 EventSourceConfigCollection 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 eventSourceConfigCollectionResponse = z.lazy(() => {
   return z
@@ -43,8 +46,9 @@ export const eventSourceConfigCollectionResponse = 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 EventSourceConfigCollection 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 eventSourceConfigCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/event-source-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 EventSourceConfigPayload 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 eventSourceConfigPayload = z.lazy(() => {
   return z.object({
@@ -17,8 +19,9 @@ export const eventSourceConfigPayload = z.lazy(() => {
 export type EventSourceConfigPayload = z.infer<typeof eventSourceConfigPayload>;
 
 /**
- * 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 EventSourceConfigPayload 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 eventSourceConfigPayloadResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const eventSourceConfigPayloadResponse = 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 EventSourceConfigPayload 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 eventSourceConfigPayloadRequest = z.lazy(() => {
   return z

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

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

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

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { ExpoConfig, expoConfig, expoConfigRequest, expoConfigResponse } from './expo-config.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the ExpoConfigCollection 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 expoConfigCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const expoConfigCollection = z.lazy(() => {
 export type ExpoConfigCollection = z.infer<typeof expoConfigCollection>;
 
 /**
- * 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 ExpoConfigCollection 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 expoConfigCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const expoConfigCollectionResponse = 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 ExpoConfigCollection 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 expoConfigCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/expo-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 ExpoConfigPayload 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 expoConfigPayload = z.lazy(() => {
   return z.object({
@@ -12,13 +14,14 @@ export const expoConfigPayload = z.lazy(() => {
 /**
  *
  * @typedef  {ExpoConfigPayload} expoConfigPayload
- * @property {string}
+ * @property {string} - The Expo access token used to authenticate push notifications.
  */
 export type ExpoConfigPayload = z.infer<typeof expoConfigPayload>;
 
 /**
- * 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 ExpoConfigPayload 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 expoConfigPayloadResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const expoConfigPayloadResponse = 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 ExpoConfigPayload 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 expoConfigPayloadRequest = z.lazy(() => {
   return z

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

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

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

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { FcmConfig, fcmConfig, fcmConfigRequest, fcmConfigResponse } from './fcm-config.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the FcmConfigCollection 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 fcmConfigCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const fcmConfigCollection = z.lazy(() => {
 export type FcmConfigCollection = z.infer<typeof fcmConfigCollection>;
 
 /**
- * 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 FcmConfigCollection 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 fcmConfigCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const fcmConfigCollectionResponse = 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 FcmConfigCollection 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 fcmConfigCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/fcm-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 FcmConfigPayload 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 fcmConfigPayload = z.lazy(() => {
   return z.object({
@@ -22,23 +24,24 @@ export const fcmConfigPayload = z.lazy(() => {
 /**
  *
  * @typedef  {FcmConfigPayload} fcmConfigPayload
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {Type_}
- * @property {string}
+ * @property {string} - URL for Google's OAuth provider x509 certificates used to validate tokens.
+ * @property {string} - OAuth authorization endpoint used when exchanging Firebase credentials.
+ * @property {string} - The client email address from the Firebase service account.
+ * @property {string} - The numeric client identifier for the Firebase service account.
+ * @property {string} - URL to the public x509 certificate for this service account.
+ * @property {string} - The PEM encoded service account private key used to sign Firebase credentials.
+ * @property {string} - Identifier of the private key inside the downloaded service account JSON.
+ * @property {string} - The Firebase project ID associated with this service account.
+ * @property {string} - OAuth token endpoint used to mint access tokens for FCM.
+ * @property {Type_} - Indicates the kind of Google credential. Service accounts always use the `service_account` type.
+ * @property {string} - The Google Cloud universe domain hosting the Firebase APIs.
  */
 export type FcmConfigPayload = z.infer<typeof fcmConfigPayload>;
 
 /**
- * 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 FcmConfigPayload 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 fcmConfigPayloadResponse = z.lazy(() => {
   return z
@@ -71,8 +74,9 @@ export const fcmConfigPayloadResponse = 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 FcmConfigPayload 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 fcmConfigPayloadRequest = z.lazy(() => {
   return z

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

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

package/src/project-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/project-client/services/integrations/models/github-config-collection.ts

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { GithubConfig, githubConfig, githubConfigRequest, githubConfigResponse } from './github-config.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the GithubConfigCollection 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 githubConfigCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const githubConfigCollection = z.lazy(() => {
 export type GithubConfigCollection = z.infer<typeof githubConfigCollection>;
 
 /**
- * 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 GithubConfigCollection 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 githubConfigCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const githubConfigCollectionResponse = 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 GithubConfigCollection 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 githubConfigCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/github-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 GithubConfigPayload 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 githubConfigPayload = z.lazy(() => {
   return z.object({
@@ -17,8 +19,9 @@ export const githubConfigPayload = z.lazy(() => {
 export type GithubConfigPayload = z.infer<typeof githubConfigPayload>;
 
 /**
- * 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 GithubConfigPayload 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 githubConfigPayloadResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const githubConfigPayloadResponse = 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 GithubConfigPayload 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 githubConfigPayloadRequest = z.lazy(() => {
   return z

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

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

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