magicbell-js 1.5.0 → 1.6.0

package/src/project-client/services/integrations/models/unseen-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 UnseenState 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 unseenState = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const unseenState = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {UnseenState} unseenState
- * @property {string}
+ * State indicator styling for unseen notifications.
+ * @typedef  {UnseenState} unseenState - State indicator styling for unseen notifications. - State indicator styling for unseen notifications.
+ * @property {string} - Color for the unseen state indicator.
  */
 export type UnseenState = z.infer<typeof unseenState>;
 
 /**
- * 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 UnseenState 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 unseenStateResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const unseenStateResponse = 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 UnseenState 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 unseenStateRequest = z.lazy(() => {
   return z

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

@@ -4,7 +4,9 @@ import { UnseenHover, unseenHover, unseenHoverRequest, unseenHoverResponse } fro
 import { UnseenState, unseenState, unseenStateRequest, unseenStateResponse } from './unseen-state.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Unseen 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 unseen = z.lazy(() => {
   return z.object({
@@ -16,18 +18,19 @@ export const unseen = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Unseen} unseen
- * @property {string}
- * @property {UnseenHover}
- * @property {UnseenState}
- * @property {string}
+ * Overrides for unseen notifications.
+ * @typedef  {Unseen} unseen - Overrides for unseen notifications. - Overrides for unseen notifications.
+ * @property {string} - Background color applied to unseen notifications.
+ * @property {UnseenHover} - Hover styles for unseen notifications.
+ * @property {UnseenState} - State indicator styling for unseen notifications.
+ * @property {string} - Text color used when a notification is unseen.
  */
 export type Unseen = z.infer<typeof unseen>;
 
 /**
- * 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 Unseen 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 unseenResponse = z.lazy(() => {
   return z
@@ -46,8 +49,9 @@ export const unseenResponse = 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 Unseen 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 unseenRequest = z.lazy(() => {
   return z

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

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { WebpushConfig, webpushConfig, webpushConfigRequest, webpushConfigResponse } from './webpush-config.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the WebpushConfigCollection 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 webpushConfigCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const webpushConfigCollection = z.lazy(() => {
 export type WebpushConfigCollection = z.infer<typeof webpushConfigCollection>;
 
 /**
- * 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 WebpushConfigCollection 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 webpushConfigCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const webpushConfigCollectionResponse = 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 WebpushConfigCollection 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 webpushConfigCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/integrations/models/webpush-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 WebpushConfigPayload 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 webpushConfigPayload = z.lazy(() => {
   return z.object({
@@ -13,14 +15,15 @@ export const webpushConfigPayload = z.lazy(() => {
 /**
  *
  * @typedef  {WebpushConfigPayload} webpushConfigPayload
- * @property {string} - VAPID private key - from the pair you generated.
- * @property {string} - VAPID public key - generate one at https://magicbell.com/web-push/vapid-keys.
+ * @property {string} - VAPID private key.
+ * @property {string} - VAPID public key - read more at https://magicbell.com/tools/vapid-keys.
  */
 export type WebpushConfigPayload = z.infer<typeof webpushConfigPayload>;
 
 /**
- * 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 WebpushConfigPayload 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 webpushConfigPayloadResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const webpushConfigPayloadResponse = 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 WebpushConfigPayload 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 webpushConfigPayloadRequest = z.lazy(() => {
   return z

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

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

package/src/project-client/services/users/models/user-collection.ts

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { User, user, userRequest, userResponse } from '../../common/user.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UserCollection 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 userCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const userCollection = z.lazy(() => {
 export type UserCollection = z.infer<typeof userCollection>;
 
 /**
- * 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 UserCollection 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 userCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const userCollectionResponse = 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 UserCollection 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 userCollectionRequest = z.lazy(() => {
   return z

package/src/project-client/services/users/users-service.ts

@@ -10,13 +10,18 @@ import { User, userRequest, userResponse } from '../common/user.js';
 import { UserCollection, userCollectionResponse } from './models/user-collection.js';
 import { ListUsersParams } from './request-params.js';
 
+/**
+ * Service class for UsersService operations.
+ * Provides methods to interact with UsersService-related API endpoints.
+ * All methods return promises and handle request/response serialization automatically.
+ */
 export class UsersService extends BaseService {
   /**
    * Lists all users in the project.
-   * @param {number} [params.limit] -
-   * @param {string} [params.startingAfter] -
-   * @param {string} [params.endingBefore] -
-   * @param {string} [params.query] -
+   * @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 {string} [params.query] - filter users by their email address or external ID
    * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<UserCollection>>} - OK
    */

package/src/project-client/services/workflows/models/create-run-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 CreateRunResponse 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 createRunResponse = z.lazy(() => {
   return z.object({
@@ -12,13 +14,14 @@ export const createRunResponse = z.lazy(() => {
 /**
  *
  * @typedef  {CreateRunResponse} createRunResponse
- * @property {string}
+ * @property {string} - Identifier of the workflow run that was created.
  */
 export type CreateRunResponse = z.infer<typeof createRunResponse>;
 
 /**
- * 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 CreateRunResponse 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 createRunResponseResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const createRunResponseResponse = 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 CreateRunResponse 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 createRunResponseRequest = z.lazy(() => {
   return z

package/src/project-client/services/workflows/models/execute-workflow-request.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 ExecuteWorkflowRequest 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 executeWorkflowRequest = z.lazy(() => {
   return z.object({
@@ -13,14 +15,15 @@ export const executeWorkflowRequest = z.lazy(() => {
 /**
  *
  * @typedef  {ExecuteWorkflowRequest} executeWorkflowRequest
- * @property {any}
- * @property {string}
+ * @property {any} - Optional JSON payload that will be passed as the workflow input context.
+ * @property {string} - The unique workflow key to execute (e.g. integration.stripe.charge.succeeded).
  */
 export type ExecuteWorkflowRequest = z.infer<typeof executeWorkflowRequest>;
 
 /**
- * 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 ExecuteWorkflowRequest 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 executeWorkflowRequestResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const executeWorkflowRequestResponse = 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 ExecuteWorkflowRequest 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 executeWorkflowRequestRequest = z.lazy(() => {
   return z

package/src/project-client/services/workflows/models/get-run-response-status.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 GetRunResponseStatus 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 getRunResponseStatus = z.lazy(() => {
   return z.object({
@@ -25,8 +27,9 @@ export const getRunResponseStatus = z.lazy(() => {
 export type GetRunResponseStatus = z.infer<typeof getRunResponseStatus>;
 
 /**
- * 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 GetRunResponseStatus 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 getRunResponseStatusResponse = z.lazy(() => {
   return z
@@ -47,8 +50,9 @@ export const getRunResponseStatusResponse = 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 GetRunResponseStatus 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 getRunResponseStatusRequest = z.lazy(() => {
   return z

package/src/project-client/services/workflows/models/get-run-response.ts

@@ -8,12 +8,15 @@ import {
 } from './get-run-response-status.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the GetRunResponse 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 getRunResponse = z.lazy(() => {
   return z.object({
     createdAt: z.string().optional(),
     id: z.string().optional(),
+    input: z.any().optional(),
     status: getRunResponseStatus.optional(),
     workflowKey: z.string().optional(),
   });
@@ -24,46 +27,53 @@ export const getRunResponse = z.lazy(() => {
  * @typedef  {GetRunResponse} getRunResponse
  * @property {string}
  * @property {string}
+ * @property {any}
  * @property {GetRunResponseStatus}
  * @property {string}
  */
 export type GetRunResponse = z.infer<typeof getRunResponse>;
 
 /**
- * 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 GetRunResponse 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 getRunResponseResponse = z.lazy(() => {
   return z
     .object({
       created_at: z.string().optional(),
       id: z.string().optional(),
+      input: z.any().optional(),
       status: getRunResponseStatusResponse.optional(),
       workflow_key: z.string().optional(),
     })
     .transform((data) => ({
       createdAt: data['created_at'],
       id: data['id'],
+      input: data['input'],
       status: data['status'],
       workflowKey: data['workflow_key'],
     }));
 });
 
 /**
- * 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 GetRunResponse 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 getRunResponseRequest = z.lazy(() => {
   return z
     .object({
       createdAt: z.string().optional(),
       id: z.string().optional(),
+      input: z.any().optional(),
       status: getRunResponseStatusRequest.optional(),
       workflowKey: z.string().optional(),
     })
     .transform((data) => ({
       created_at: data['createdAt'],
       id: data['id'],
+      input: data['input'],
       status: data['status'],
       workflow_key: data['workflowKey'],
     }));

package/src/project-client/services/workflows/models/index.ts

@@ -2,8 +2,11 @@ export type { CreateRunResponse } from './create-run-response.js';
 export type { ExecuteWorkflowRequest } from './execute-workflow-request.js';
 export type { GetRunResponse } from './get-run-response.js';
 export type { GetRunResponseStatus } from './get-run-response-status.js';
-export type { Steps } from './steps.js';
+export type { Items } from './items.js';
+export type { ItemsSteps } from './items-steps.js';
 export type { WorkflowDefinition } from './workflow-definition.js';
+export type { WorkflowDefinitionSteps } from './workflow-definition-steps.js';
+export type { WorkflowList } from './workflow-list.js';
 export type { WorkflowRun } from './workflow-run.js';
 export type { WorkflowRunCollection } from './workflow-run-collection.js';
 export type { WorkflowRunStatus } from './workflow-run-status.js';

package/src/project-client/services/workflows/models/items-steps.ts

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+
+/**
+ * Zod schema for the ItemsSteps 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 itemsSteps = z.lazy(() => {
+  return z.object({
+    command: z.string().regex(/^[a-z_]+$/),
+    if: z.string().optional().nullable(),
+    input: z.any().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {ItemsSteps} itemsSteps
+ * @property {string} - Command to execute (e.g., broadcast, pause, wait, abort)
+ * @property {string}
+ * @property {any}
+ */
+export type ItemsSteps = z.infer<typeof itemsSteps>;
+
+/**
+ * Zod schema for mapping API responses to the ItemsSteps 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 itemsStepsResponse = z.lazy(() => {
+  return z
+    .object({
+      command: z.string().regex(/^[a-z_]+$/),
+      if: z.string().optional().nullable(),
+      input: z.any().optional().nullable(),
+    })
+    .transform((data) => ({
+      command: data['command'],
+      if: data['if'],
+      input: data['input'],
+    }));
+});
+
+/**
+ * Zod schema for mapping the ItemsSteps 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 itemsStepsRequest = z.lazy(() => {
+  return z
+    .object({
+      command: z.string().regex(/^[a-z_]+$/),
+      if: z.string().optional().nullable(),
+      input: z.any().optional().nullable(),
+    })
+    .transform((data) => ({
+      command: data['command'],
+      if: data['if'],
+      input: data['input'],
+    }));
+});

package/src/project-client/services/workflows/models/items.ts

@@ -0,0 +1,72 @@
+import { z } from 'zod';
+
+import { ItemsSteps, itemsSteps, itemsStepsRequest, itemsStepsResponse } from './items-steps.js';
+
+/**
+ * Zod schema for the Items 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 items = z.lazy(() => {
+  return z.object({
+    disabled: z.boolean().optional(),
+    key: z
+      .string()
+      .min(3)
+      .regex(/^[A-Za-z0-9\_\.\-\:]+$/),
+    steps: z.array(itemsSteps),
+  });
+});
+
+/**
+ *
+ * @typedef  {Items} items
+ * @property {boolean}
+ * @property {string}
+ * @property {ItemsSteps[]}
+ */
+export type Items = z.infer<typeof items>;
+
+/**
+ * Zod schema for mapping API responses to the Items 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 itemsResponse = z.lazy(() => {
+  return z
+    .object({
+      disabled: z.boolean().optional(),
+      key: z
+        .string()
+        .min(3)
+        .regex(/^[A-Za-z0-9\_\.\-\:]+$/),
+      steps: z.array(itemsStepsResponse),
+    })
+    .transform((data) => ({
+      disabled: data['disabled'],
+      key: data['key'],
+      steps: data['steps'],
+    }));
+});
+
+/**
+ * Zod schema for mapping the Items 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 itemsRequest = z.lazy(() => {
+  return z
+    .object({
+      disabled: z.boolean().optional(),
+      key: z
+        .string()
+        .min(3)
+        .regex(/^[A-Za-z0-9\_\.\-\:]+$/),
+      steps: z.array(itemsStepsRequest),
+    })
+    .transform((data) => ({
+      disabled: data['disabled'],
+      key: data['key'],
+      steps: data['steps'],
+    }));
+});