@babelforce/manager-sdk 0.38.0 → 0.39.0

package/dist/index.d.ts

@@ -91,11 +91,26 @@ type ActionProxyResponseResponse = {
      */
     contentType?: string;
 };
+/**
+ * Request body to add a lead to a lead-list.
+ */
 type AddOutboundLeadRequest = {
+    /**
+     * Customer-supplied lead identifier, unique within the lead-list.
+     */
     uid: string;
+    /**
+     * Phone number to dial, in E.164 format.
+     */
     number: string;
+    /**
+     * Dial priority within the list; higher-ranked leads are dialled first.
+     */
     rank?: number;
 };
+/**
+ * An ACD agent — a person or integration seat that handles calls and conversations and can belong to one or more agent groups.
+ */
 type Agent = {
     /**
      * The unique Identifier (UUID) of the object
@@ -128,8 +143,17 @@ type Agent = {
     state?: AgentLineStatus;
     presence?: AgentPresence;
     status?: AgentStatus;
+    /**
+     * The agent's current activity.
+     */
     activity?: string;
+    /**
+     * Human-readable status label for display.
+     */
     display_status?: string;
+    /**
+     * Whether the agent is currently available to take calls.
+     */
     available?: boolean;
     /**
      * A List of Tags describing an Object
@@ -175,11 +199,17 @@ type AgentBulkResponseBulkInner = {
     error?: string;
     item?: Agent;
 };
+/**
+ * A named group of agents, used for queue routing and reporting.
+ */
 type AgentGroup = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The group's name.
+     */
     name: string;
     /**
      * A List of Tags describing an Object
@@ -298,9 +328,21 @@ type AgentOutboundCallRequest = {
 type AgentPasswordUpdateRequest = {
     newPassword: string;
 };
+/**
+ * An agent presence state — `available`, or a custom busy reason.
+ */
 type AgentPresence = {
+    /**
+     * Whether agents in this presence can take calls.
+     */
     available: boolean;
+    /**
+     * Human-readable presence label.
+     */
     label: string;
+    /**
+     * The presence's unique name/key.
+     */
     name: string;
 };
 type AgentPresenceInfo = {
@@ -356,8 +398,17 @@ type AgentShort = {
      */
     number: string;
 };
+/**
+ * An agent's composite status — account, availability, line, and outbound state.
+ */
 type AgentStatus = {
+    /**
+     * Whether the agent's account is enabled.
+     */
     enabled: boolean;
+    /**
+     * Whether the agent is currently available to take calls.
+     */
     available: boolean;
     outbound_status: AgentStatusOutboundStatus;
     line_status: AgentLineStatus;
@@ -493,7 +544,13 @@ type Application = ({
 } & TextToSpeechApplication) | ({
     module?: 'transfer';
 } & TransferApplication);
+/**
+ * Request body to create an IVR voice-application. The chosen `module` fixes the application's type; its module-specific settings are then configured via update.
+ */
 type ApplicationCreateBody = {
+    /**
+     * The application's name.
+     */
     name: string;
     module: IvrModule;
 };
@@ -691,12 +748,18 @@ type AvailableExpression = {
     groupLabel: string;
     formatDescription: string;
 };
+/**
+ * A babeldesk dashboard — a wallboard of widgets shared with a set of users and roles.
+ */
 type Babeldesk = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
     dateCreated?: string;
+    /**
+     * The dashboard's label (unique per customer).
+     */
     label?: string;
     users?: Array<ManagedUserEmail>;
     /**
@@ -715,24 +778,51 @@ type BabeldeskItemResponse = {
      */
     success: boolean;
 };
+/**
+ * A widget that can be placed on a babeldesk dashboard.
+ */
 type BabeldeskWidget = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
     dateCreated?: string;
+    /**
+     * The widget type (e.g. `bar`, `iframe`).
+     */
     type?: string;
+    /**
+     * The widget's label (unique per customer).
+     */
     label?: string;
+    /**
+     * For iframe widgets, the URL embedded in the widget.
+     */
     iframeSource?: string;
     /**
      * A List of babeldesk widget metrics
      */
     metrics?: Array<BabeldeskWidgetMetric>;
 };
+/**
+ * The placement of a widget on a dashboard's grid.
+ */
 type BabeldeskWidgetInstance = {
+    /**
+     * Column position on the dashboard grid.
+     */
     posX?: number;
+    /**
+     * Row position on the dashboard grid.
+     */
     posY?: number;
+    /**
+     * Width in grid columns.
+     */
     width?: number;
+    /**
+     * Height in grid rows.
+     */
     height?: number;
     /**
      * The unique Identifier (UUID) of the object
@@ -746,9 +836,21 @@ type BabeldeskWidgetItemResponse = {
      */
     success: boolean;
 };
+/**
+ * A metric displayed by a babeldesk widget.
+ */
 type BabeldeskWidgetMetric = {
+    /**
+     * The metric name.
+     */
     name?: string;
+    /**
+     * The call direction/type the metric covers.
+     */
     type?: string;
+    /**
+     * The metric fields to display.
+     */
     fields?: Array<string>;
     /**
      * A list of call states
@@ -804,13 +906,25 @@ type BulkUpdateRequest = {
         [key: string]: unknown;
     }>;
 };
+/**
+ * A business-hours profile — a named, time-zoned set of weekly open ranges used by call flows to branch on whether the account is open.
+ */
 type BusinessHour = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The profile's name (unique per customer).
+     */
     name: string;
+    /**
+     * Whether the profile is active and evaluated by call flows.
+     */
     enabled?: boolean;
+    /**
+     * IANA time zone the ranges are evaluated in.
+     */
     timeZone: string;
     /**
      * Whether the profile is currently within an open range
@@ -873,8 +987,17 @@ type BusinessHourRangeBody = {
  * A weekday + time-of-day boundary
  */
 type BusinessHourRangeBound = {
+    /**
+     * Day of the week the boundary falls on.
+     */
     day: 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday';
+    /**
+     * Hour of day, 0–23.
+     */
     hour: number;
+    /**
+     * Minute of the hour, 0–59.
+     */
     minute: number;
 };
 type BusinessHourRangeItemResponse = {
@@ -894,14 +1017,29 @@ type BusinessHourRangeListResponse = {
 type BusinessHourRangesBody = {
     ranges: Array<BusinessHourRangeBody>;
 };
+/**
+ * A customer calendar — a named, time-zoned set of date ranges (typically holidays) used by call flows to branch on whether a date is blocked.
+ */
 type Calendar = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The calendar's name (unique per customer).
+     */
     name: string;
+    /**
+     * IANA time zone the calendar's dates are evaluated in.
+     */
     timeZone: string;
+    /**
+     * Whether the calendar is active and evaluated by call flows.
+     */
     enabled?: boolean;
+    /**
+     * Number of date ranges configured on the calendar.
+     */
     dateCount?: number;
     /**
      * A List of Tags describing an Object
@@ -912,15 +1050,24 @@ type CalendarBulkUpdateRequest = {
     items: Array<BusinessHourBulkUpdateRequestItemsInner>;
 };
 /**
- * A date range within a calendar (e.g. a holiday)
+ * A date range within a calendar (e.g. a holiday).
  */
 type CalendarDate = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * A human-readable name for the date range (unique per calendar).
+     */
     label: string;
+    /**
+     * Inclusive start of the date range.
+     */
     dateStart: string;
+    /**
+     * Exclusive end of the date range (must be after dateStart).
+     */
     dateEnd: string;
     type: CalendarDateType;
     /**
@@ -929,11 +1076,20 @@ type CalendarDate = {
     active?: boolean;
 };
 /**
- * Fields to create or update a calendar date
+ * Fields to create or update a calendar date.
  */
 type CalendarDateBody = {
+    /**
+     * A human-readable name for the date range (unique per calendar).
+     */
     label: string;
+    /**
+     * Inclusive start of the date range.
+     */
     dateStart: string;
+    /**
+     * Exclusive end of the date range (must be after dateStart).
+     */
     dateEnd: string;
     type?: CalendarDateType;
 };
@@ -1115,20 +1271,35 @@ type CallSource = 'queue' | 'webrtc' | 'api' | 'dialer' | 'dial' | 'transfer' |
 type CallState = 'init' | 'scheduled' | 'ringing' | 'in-progress' | 'queued' | 'bridged' | 'canceled' | 'busy' | 'no-answer' | 'purged' | 'completed' | 'failed';
 type CallType = 'inbound' | 'outbound';
 /**
- * An outbound dialer campaign
+ * An outbound dialer campaign — the container for the leads to be dialled.
  */
 type Campaign = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The campaign's name.
+     */
     name: string;
+    /**
+     * Number shown to leads as the caller ID.
+     */
     displayNumber?: string;
+    /**
+     * Whether the campaign is active.
+     */
     active?: boolean;
+    /**
+     * Whether the campaign runs in test mode (no real dials).
+     */
     testMode?: boolean;
-    leadList?: GlobalQueueSelectionTrigger;
+    leadList?: CampaignLeadList;
     listOrder?: CampaignListOrder;
     recording?: CampaignRecording;
+    /**
+     * Ratio of simultaneous dials to available agents.
+     */
     callRatio?: number;
 };
 type CampaignHopperResponse = {
@@ -1175,6 +1346,19 @@ type CampaignStatisticsResponse = {
     items: Array<CampaignStatisticsItem>;
     success: boolean;
 };
+/**
+ * The lead-list the campaign currently works on, if any.
+ */
+type CampaignLeadList = {
+    /**
+     * The unique Identifier (UUID) of the object
+     */
+    id?: string;
+    /**
+     * The lead-list's name.
+     */
+    name?: string;
+} | null;
 type Conference = {
     /**
      * The unique Identifier (UUID) of the object
@@ -1216,6 +1400,9 @@ type ConferenceMember = {
 };
 type ConferenceMemberState = 'pending' | 'added' | 'removed';
 type ConferenceState = 'created' | 'finished';
+/**
+ * A conversation — the container that ties together every interaction (calls, SMS, queue and integration events) with one consumer over time.
+ */
 type Conversation = {
     /**
      * The unique Identifier (UUID) of the object
@@ -1223,8 +1410,14 @@ type Conversation = {
     id: string;
     dateCreated?: string;
     state?: ConversationState;
+    /**
+     * The consumer's phone number, when the conversation is identified by phone.
+     */
     phone?: string;
 };
+/**
+ * A single event within a conversation — something that happened on a call, SMS, queue, integration, or a custom event added by a user.
+ */
 type ConversationEvent = {
     /**
      * The unique Identifier (UUID) of the object
@@ -1235,9 +1428,12 @@ type ConversationEvent = {
      */
     conversationId?: string;
     type: ConversationEventType;
+    /**
+     * The event name — what happened.
+     */
     name: string;
     /**
-     * Level of Detail
+     * Level of detail of the event (higher = more detail).
      */
     lod?: number;
     dateCreated?: string;
@@ -1252,14 +1448,23 @@ type ConversationEventItemResponse = {
     success: boolean;
 };
 /**
- * A user event to add to a conversation
+ * A custom user event to add to a conversation.
  */
 type ConversationEventRequest = {
+    /**
+     * The event name — what happened.
+     */
     name: string;
+    /**
+     * Arbitrary key/value payload stored with the event.
+     */
     data?: {
         [key: string]: unknown;
     };
 };
+/**
+ * The area of concern an event belongs to — which subsystem produced it.
+ */
 type ConversationEventType = 'call' | 'sms' | 'queue' | 'application' | 'integration' | 'agent' | 'external';
 type ConversationItemResponse = {
     item: Conversation;
@@ -1269,14 +1474,14 @@ type ConversationItemResponse = {
     success: boolean;
 };
 /**
- * Key-Values of Variables
+ * A flat key/value map of session variables shared between the conversation and its live call session.
  */
 type ConversationSessionVariables = {
     [key: string]: unknown;
 };
 type ConversationSessionVariablesItemResponse = {
     /**
-     * Key-Values of Variables
+     * A flat key/value map of session variables shared between the conversation and its live call session.
      */
     item: {
         [key: string]: unknown;
@@ -1286,6 +1491,9 @@ type ConversationSessionVariablesItemResponse = {
      */
     success: boolean;
 };
+/**
+ * Whether the conversation is currently open or closed.
+ */
 type ConversationState = 'open' | 'closed';
 type CreateCampaignRequest = {
     name: string;
@@ -1295,19 +1503,43 @@ type CreateCampaignRequest = {
     listOrder: CampaignListOrder;
     callRatio?: number;
 };
+/**
+ * Request body to create or rename a lead-list.
+ */
 type CreateListRequest = {
+    /**
+     * The lead-list's name (unique per customer).
+     */
     name: string;
 };
+/**
+ * Request body to create a user.
+ */
 type CreateManagedUserRequest = {
+    /**
+     * The user's initial password; a random one is generated if omitted.
+     */
     password?: string;
+    /**
+     * The user's login email address (unique per account).
+     */
     email: string;
+    /**
+     * Whether to enable and activate the user immediately.
+     */
     activated?: boolean;
     /**
      * A List of Roles which are associated with the current User
      */
     roles: Array<AccountRole$1>;
 };
+/**
+ * Request body to create a lead-list.
+ */
 type CreateOutboundListRequest = {
+    /**
+     * The lead-list's name (unique per customer).
+     */
     name: string;
 };
 type CreateTestCallRequest = {
@@ -1326,7 +1558,13 @@ type CreateTestCallRequest = {
         [key: string]: unknown;
     };
 };
+/**
+ * Request body to create a custom event.
+ */
 type CustomEventRequest = {
+    /**
+     * The custom event's name (combined with the `custom` type as its code).
+     */
     name: string;
     /**
      * A List of Tags describing an Object
@@ -1395,6 +1633,9 @@ type DashboardUser = {
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The user's login email address.
+     */
     email: string;
 };
 type DashboardUsersResponse = {
@@ -1414,19 +1655,25 @@ type DefaultV2MessageResponse = {
      */
     success: boolean;
 };
+/**
+ * How the dialer places outbound calls — `standard` (automatic dialing), `manual` (agent-initiated), or `safety_first` (conservative pacing).
+ */
 type DialMethod = 'standard' | 'manual' | 'safety_first';
 /**
  * The dial status of an outbound lead or call attempt
  */
 type DialStatus = 'pending' | 'new' | 'callback_hold' | 'answering_machine_auto' | 'busy_auto' | 'no_answer_auto' | 'disconnected_number_auto' | 'dropped' | 'in_call' | 'unknown' | 'picked_up' | 'voicemail' | 'agent_error' | 'not_viable' | 'queued' | 'dispo' | 'no_answer' | 'disconnected_number' | 'busy' | 'callback' | 'answering_machine' | 'not_interested' | 'do_not_call' | 'sale';
 /**
- * A dialer behaviour
+ * A named dialer-behaviour profile controlling how an outbound campaign places calls (its dial method and pacing settings).
  */
 type DialerBehaviour = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The profile's name (unique per customer).
+     */
     name: string;
     dialMethod?: DialMethod;
 };
@@ -1434,7 +1681,13 @@ type DialerBehaviourItemResponse = {
     item: DialerBehaviour;
     success: boolean;
 };
+/**
+ * Request body to create or update a dialer-behaviour profile.
+ */
 type DialerBehaviourWriteBody = {
+    /**
+     * The profile's name (unique per customer).
+     */
     name: string;
     dialMethod?: DialMethod;
 };
@@ -1476,6 +1729,9 @@ type EvaluateExpressionResponse = {
     evaluated?: unknown;
     message: string;
 };
+/**
+ * A system event that automations can subscribe to, identified by its `code` (`<type>.<name>`, e.g. `call.inbound`).
+ */
 type Event = {
     /**
      * The unique Identifier (UUID) of the object
@@ -1490,6 +1746,9 @@ type Event = {
      * Unique identifier of an Event
      */
     code: string;
+    /**
+     * Human-readable label for the event.
+     */
     label: string;
     /**
      * A List of Tags describing an Object
@@ -1507,12 +1766,18 @@ type EventItemResponse = {
  * The Event category
  */
 type EventType = 'AGENT' | 'CALL' | 'CUSTOM' | 'MESSAGE' | 'RECORDING' | 'SMS' | 'TRANSACTION';
+/**
+ * The files to delete.
+ */
 type FileBulkDeleteRequest = {
     /**
      * File IDs to delete
      */
     ids: Array<ObjectUuid>;
 };
+/**
+ * The files to bundle into a ZIP archive.
+ */
 type FileBulkDownloadRequest = {
     /**
      * File IDs to include in the ZIP
@@ -1552,13 +1817,28 @@ type GetIntegrationProviderLogoResponseItem = {
      */
     base64?: string;
 };
+/**
+ * An event trigger — an automation that fires its action when the subscribed event occurs (account-wide, unlike a per-application LocalAutomation).
+ */
 type GlobalAutomation = BaseAutomation & GlobalAutomationEmbeddedEvent;
 type GlobalAutomationEmbeddedEvent = {
     event?: GlobalAutomationEvent;
 };
+/**
+ * The event an event trigger subscribes to.
+ */
 type GlobalAutomationEvent = {
+    /**
+     * The event's name (e.g. `inbound`).
+     */
     name: string;
+    /**
+     * The event's type category (e.g. `call`).
+     */
     type: string;
+    /**
+     * The provider that emits the event, when applicable.
+     */
     provider?: string;
 };
 type GlobalAutomationItemResponse = {
@@ -1977,7 +2257,7 @@ type IntegrationUpdateRequest = {
 };
 type IvrModule = 'agentQueue' | 'agentic' | 'audioPlayer' | 'consumerQueue' | 'inputReader' | 'inputReader.v2' | 'promptPlayer' | 'recording' | 'simpleMenu' | 'speechToText' | 'switchNode' | 'textToSpeech' | 'transfer';
 /**
- * An outbound dialer lead
+ * An outbound dialer lead — one record in a lead-list, holding the number(s) to dial, its dial status, and any custom per-lead data.
  */
 type Lead = {
     /**
@@ -1985,7 +2265,7 @@ type Lead = {
      */
     id: string;
     /**
-     * Customer-supplied lead identifier
+     * Customer-supplied lead identifier, unique within the lead-list.
      */
     uid?: string;
     /**
@@ -1996,14 +2276,38 @@ type Lead = {
      * The unique Identifier (UUID) of the object
      */
     campaignId?: string;
+    /**
+     * Primary phone number to dial, in E.164 format.
+     */
     number: string;
+    /**
+     * First fallback number, tried when the primary is unreachable.
+     */
     number2?: string;
+    /**
+     * Second fallback number.
+     */
     number3?: string;
+    /**
+     * Caller ID presented when dialling this lead, overriding the campaign default.
+     */
     callerId?: string;
     status?: DialStatus;
+    /**
+     * Dial priority within the list; higher-ranked leads are dialled first.
+     */
     rank?: number;
+    /**
+     * Number of dial attempts made on this lead so far.
+     */
     callCount?: number;
+    /**
+     * Total talk time across all attempts, in seconds.
+     */
     duration?: number;
+    /**
+     * Whether the lead has been dialled since the list's call counters were last reset.
+     */
     calledSinceReset?: boolean;
     dateCreated?: string;
     lastUpdated?: string;
@@ -2022,10 +2326,16 @@ type Lead = {
     } | null;
 };
 /**
- * Lead IDs or UIDs to delete (provide one of `ids` or `uids`)
+ * Lead IDs or UIDs to delete (provide one of `ids` or `uids`).
  */
 type LeadBulkDeleteRequest = {
+    /**
+     * Lead uuids to delete.
+     */
     ids?: Array<ObjectUuid>;
+    /**
+     * Customer-supplied lead identifiers (`uid`) to delete.
+     */
     uids?: Array<string>;
 };
 type LeadItemResponse = {
@@ -2033,20 +2343,23 @@ type LeadItemResponse = {
     success: boolean;
 };
 /**
- * An outbound lead-list
+ * A lead-list — a named collection of leads dialled by a campaign.
  */
 type LeadList = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The lead-list's name (unique per customer).
+     */
     name: string;
     /**
      * The unique Identifier (UUID) of the object
      */
     campaignId?: string;
     /**
-     * Number of leads in the list
+     * Number of leads in the list.
      */
     count?: number;
 };
@@ -2075,6 +2388,9 @@ type LeadUploadRequest = {
      */
     clear?: boolean;
 };
+/**
+ * Result of a CSV lead upload — how many leads were imported.
+ */
 type LeadUploadResponse = {
     item: LeadUploadResponseItem;
     success: boolean;
@@ -2084,28 +2400,55 @@ type LeadUploadResponseItem = {
      * The unique Identifier (UUID) of the object
      */
     listId?: string;
+    /**
+     * Number of leads imported from the file.
+     */
     total?: number;
+    /**
+     * Human-readable summary of the import.
+     */
     message?: string;
 };
 type ListModulesResponse = {
     items: Array<IvrModule>;
 };
+/**
+ * A single live-log entry emitted while live logging is enabled.
+ */
 type LiveLog = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * Entry timestamp, as a Unix epoch in milliseconds.
+     */
     time?: number;
     category: LiveLogCategory;
     level: LiveLogLevel;
+    /**
+     * The log message.
+     */
     message: string;
 };
+/**
+ * The subsystem that emitted the log entry.
+ */
 type LiveLogCategory = 'ACTIONS' | 'APPLICATION' | 'VOICE_APPLICATIONS' | 'TRIGGERS' | 'EXPRESSIONS' | 'EVENT_TRIGGERS' | 'DIALER' | 'AGENT' | 'STORAGE' | 'VOICE' | 'TRANSACTION' | 'API';
+/**
+ * The severity level of the log entry.
+ */
 type LiveLogLevel = 'INFO' | 'DEBUG' | 'ERROR' | 'WARN' | 'TRACE';
+/**
+ * An application action — a "local automation" attached to a single IVR application, run in `priority` order when the application is dispatched.
+ */
 type LocalAutomation = BaseAutomation;
+/**
+ * Optional context for dispatching an application's automations.
+ */
 type LocalAutomationDispatch = {
     /**
-     * The ID of a Call to add to context
+     * uuid of a call to add to the dispatch context.
      */
     callId?: string;
 };
@@ -2116,16 +2459,37 @@ type LocalAutomationItemResponse = {
      */
     success: boolean;
 };
+/**
+ * A user account within the customer's account, with its login email, status flags, assigned roles and optionally the agent it is linked to.
+ */
 type ManagedUser = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The user's login email address.
+     */
     email: string;
+    /**
+     * Whether the user is enabled and may sign in.
+     */
     enabled?: boolean;
+    /**
+     * Whether the user has activated their account.
+     */
     activated?: boolean;
+    /**
+     * Whether the user's password has expired and must be reset.
+     */
     passwordExpired?: boolean;
+    /**
+     * Whether the user's account has expired.
+     */
     accountExpired?: boolean;
+    /**
+     * Whether the user's account is locked.
+     */
     accountLocked?: boolean;
     /**
      * A List of Roles which are associated with the current User
@@ -2152,17 +2516,47 @@ type ManagedUserAgent = {
     type?: string;
     sourceId?: string;
 };
+/**
+ * The definition of a metric — its id, a human description, and the filters it accepts when queried.
+ */
 type MetricDefinition = {
     id: MetricId;
+    /**
+     * Human-readable description of what the metric measures.
+     */
     description: string;
+    /**
+     * Tags categorizing the metric.
+     */
     tags?: Array<string>;
+    /**
+     * The filters this metric accepts.
+     */
     filters?: Array<MetricDefinitionFilter>;
 };
+/**
+ * A filter a metric accepts when queried.
+ */
 type MetricDefinitionFilter = {
+    /**
+     * The filter's parameter name.
+     */
     name: string;
+    /**
+     * Human-readable description of the filter.
+     */
     description: string;
+    /**
+     * The filter's value type.
+     */
     type: string;
+    /**
+     * Expected value format, when applicable.
+     */
     format?: string;
+    /**
+     * Allowed values, when the filter is an enumeration.
+     */
     enum?: Array<string>;
     items?: MetricDefinitionFilterItems;
 };
@@ -2189,6 +2583,9 @@ type MetricIdItemsResponse = {
      */
     success: boolean;
 };
+/**
+ * A metric query result — the computed value plus the request it was evaluated for.
+ */
 type MetricResponse = {
     id: MetricId;
     /**
@@ -2239,14 +2636,29 @@ type ObjectListResponse = {
  * The unique Identifier (UUID) of the object
  */
 type ObjectUuid = string;
+/**
+ * An outbound dialer campaign — the container for the leads to be dialled.
+ */
 type OutboundCampaign = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The campaign's name.
+     */
     name: string;
+    /**
+     * Whether the campaign is active.
+     */
     active: boolean;
+    /**
+     * Number shown to leads as the caller ID.
+     */
     displayNumber: string;
+    /**
+     * Whether the campaign runs in test mode (no real dials).
+     */
     testMode: boolean;
     leadList?: OutboundCampaignLeadList;
     listOrder: CampaignListOrder;
@@ -2259,13 +2671,22 @@ type OutboundCampaignItemResponse = {
      */
     success: boolean;
 };
+/**
+ * The lead-list the campaign currently works on.
+ */
 type OutboundCampaignLeadList = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The lead-list's name.
+     */
     name: string;
 };
+/**
+ * An outbound dialer lead as returned when adding or updating a single lead — the number(s) to dial, dial status, attempt counters, and custom data.
+ */
 type OutboundLead = {
     /**
      * The unique Identifier (UUID) of the object
@@ -2275,15 +2696,45 @@ type OutboundLead = {
      * The unique Identifier (UUID) of the object
      */
     listId: string;
+    /**
+     * Customer-supplied lead identifier, unique within the lead-list.
+     */
     uid: string;
+    /**
+     * Primary phone number to dial, in E.164 format.
+     */
     number: string;
+    /**
+     * First fallback number, tried when the primary is unreachable.
+     */
     number2?: string;
+    /**
+     * Second fallback number.
+     */
     number3?: string;
+    /**
+     * Caller ID presented when dialling this lead.
+     */
     callerId: string;
+    /**
+     * Current dial status of the lead.
+     */
     status: string;
+    /**
+     * Number of dial attempts made on this lead so far.
+     */
     callCount: number;
+    /**
+     * Total talk time across all attempts, in seconds.
+     */
     duration: number;
+    /**
+     * Whether the lead has been dialled since the list's call counters were last reset.
+     */
     calledSinceReset: boolean;
+    /**
+     * Dial priority within the list; higher-ranked leads are dialled first.
+     */
     rank: number;
     dateCreated: string;
     lastUpdated: string;
@@ -2298,13 +2749,25 @@ type OutboundLeadItemResponse = {
      */
     success: boolean;
 };
+/**
+ * A lead-list — a named collection of leads dialled by a campaign.
+ */
 type OutboundList = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The lead-list's name (unique per customer).
+     */
     name: string;
+    /**
+     * Number of leads currently in the list.
+     */
     count?: number;
+    /**
+     * uuid of the campaign this list is assigned to, if any.
+     */
     campaignId?: string;
 };
 type OutboundListItemResponse = {
@@ -2334,20 +2797,29 @@ type Pagination = {
     max?: number;
     next?: string;
 };
+/**
+ * A CSV file of phonebook entries to upload.
+ */
 type PhonebookCsvFile = {
+    /**
+     * CSV file with `label` and `number` columns.
+     */
     file: Blob | File;
 };
+/**
+ * A phonebook entry — a labelled phone number that can be referenced by name in call flows.
+ */
 type PhonebookEntry = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
     /**
-     * A Label for the Phonebook-Entry
+     * A label for the phonebook entry (unique per customer).
      */
     label: string;
     /**
-     * The Telephone-Number
+     * The telephone number, in E.164 format.
      */
     number: string;
     /**
@@ -2362,13 +2834,25 @@ type PhonebookEntryItemResponse = {
      */
     success: boolean;
 };
+/**
+ * An audio prompt played in call flows — either an uploaded audio file or text rendered via text-to-speech.
+ */
 type Prompt = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The prompt's label (unique per customer).
+     */
     label: string;
+    /**
+     * For text-to-speech prompts, the text rendered to audio.
+     */
     text?: string;
+    /**
+     * The prompt's language (BCP-47/ISO code).
+     */
     locale?: string;
     dateCreated: string;
     lastUpdated: string;
@@ -2394,9 +2878,21 @@ type Prompt = {
     tags?: Array<Tag>;
     file: FileReference;
 };
+/**
+ * A multipart audio file upload for a prompt.
+ */
 type PromptAudioFile = {
+    /**
+     * The audio file (WAV or MP3).
+     */
     file: Blob | File;
+    /**
+     * The uploaded file's name.
+     */
     filename?: string;
+    /**
+     * The prompt's label (unique per customer).
+     */
     label?: string;
 };
 type PromptItemResponse = {
@@ -2442,15 +2938,33 @@ type PromptPlayerApplicationUpdateBody = {
     settings?: PromptPlayerApplicationSettings;
     module: 'promptPlayer';
 };
+/**
+ * An ACD call queue — groups incoming calls and distributes them to the agents chosen by the queue's selections.
+ */
 type Queue = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The queue's name.
+     */
     name: string;
+    /**
+     * How many agents are dialled simultaneously per call.
+     */
     maxDialCount?: number;
+    /**
+     * Post-call wrap-up time granted to an agent, in seconds.
+     */
     wrapUpTime?: number;
+    /**
+     * How long an agent's device rings before moving on, in seconds.
+     */
     defaultRingTimeout?: number;
+    /**
+     * Maximum number of calls allowed to wait in the queue.
+     */
     maxSize?: number;
     /**
      * A List of Tags describing an Object
@@ -2718,6 +3232,9 @@ type QueuedCallBridgedQueue = {
     id?: string;
     name?: string;
 };
+/**
+ * A voice recording of a call — its state, stored audio file, duration and the call and agent it belongs to.
+ */
 type Recording = {
     /**
      * The unique Identifier (UUID) of the object
@@ -2727,6 +3244,9 @@ type Recording = {
      * Duration in Seconds
      */
     duration: number;
+    /**
+     * Public URL to download the recording's audio file.
+     */
     url: string;
     state?: RecordingState;
     file: FileReference;
@@ -2737,12 +3257,21 @@ type Recording = {
      */
     tags: Array<Tag>;
 };
+/**
+ * The agent who handled the recorded call.
+ */
 type RecordingAgent = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The agent's name.
+     */
     name: string;
+    /**
+     * The agent's telephone number.
+     */
     number: string;
 };
 type RecordingApplication = {
@@ -2786,6 +3315,9 @@ type RecordingApplicationUpdateBody = {
     settings?: RecordingApplicationSettings;
     module: 'recording';
 };
+/**
+ * The call the recording belongs to.
+ */
 type RecordingCall = {
     /**
      * The unique Identifier (UUID) of the object
@@ -2796,7 +3328,13 @@ type RecordingCall = {
      */
     conversationId: string;
     type: CallType;
+    /**
+     * The calling party's number.
+     */
     from: string;
+    /**
+     * The called party's number.
+     */
     to: string;
 };
 type RecordingItemResponse = {
@@ -2819,7 +3357,13 @@ type RecordingStartRequest = {
      */
     tags?: Array<Tag>;
 };
+/**
+ * Lifecycle state of a recording — from `init`/`recording` through `stored`, or `failed`/`deleted`/`missing`.
+ */
 type RecordingState = 'init' | 'recording' | 'failed' | 'stopped' | 'stored' | 'deleted' | 'missing';
+/**
+ * A recording's editable metadata.
+ */
 type RecordingUpdateBody = {
     /**
      * A List of Tags describing an Object
@@ -2934,8 +3478,17 @@ type RestCreateAgent = {
     state?: AgentLineStatus;
     presence?: AgentPresence;
     status?: AgentStatus;
+    /**
+     * The agent's current activity.
+     */
     activity?: string;
+    /**
+     * Human-readable status label for display.
+     */
     display_status?: string;
+    /**
+     * Whether the agent is currently available to take calls.
+     */
     available?: boolean;
     /**
      * A List of Tags describing an Object
@@ -3021,13 +3574,16 @@ type RestCreateGlobalAutomationEmbeddedEvent = {
     event?: GlobalAutomationEvent;
 };
 type RestCreateLocalAutomation = RestCreateBaseAutomation;
+/**
+ * Request body to create a phonebook entry.
+ */
 type RestCreatePhonebookEntry = {
     /**
-     * A Label for the Phonebook-Entry
+     * A label for the phonebook entry (unique per customer).
      */
     label: string;
     /**
-     * The Telephone-Number
+     * The telephone number, in E.164 format.
      */
     number: string;
     /**
@@ -3058,20 +3614,35 @@ type RestCreateQueueSelection = {
     tags?: Array<QueueSelectionTag>;
     agents?: Array<QueueSelectionAgent>;
 };
+/**
+ * Request body to route a number to a voice application.
+ */
 type RestCreateRouting = {
     application: RestCreateRoutingApplication;
-    number: RestCreateRoutingApplication;
+    number: RestCreateRoutingNumber;
     /**
      * A List of Tags describing an Object
      */
     tags?: Array<Tag>;
 };
+/**
+ * The voice application the number routes to (by id).
+ */
 type RestCreateRoutingApplication = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id?: string;
 };
+/**
+ * The phone number being routed (by id).
+ */
+type RestCreateRoutingNumber = {
+    /**
+     * The unique Identifier (UUID) of the object
+     */
+    id?: string;
+};
 type RestCreateTrigger = {
     name: string;
     type: TriggerType;
@@ -3109,8 +3680,17 @@ type RestUpdateAgent = {
     state?: AgentLineStatus;
     presence?: AgentPresence;
     status?: AgentStatus;
+    /**
+     * The agent's current activity.
+     */
     activity?: string;
+    /**
+     * Human-readable status label for display.
+     */
     display_status?: string;
+    /**
+     * Whether the agent is currently available to take calls.
+     */
     available?: boolean;
     /**
      * A List of Tags describing an Object
@@ -3196,13 +3776,16 @@ type RestUpdateGlobalAutomationEmbeddedEvent = {
     event?: GlobalAutomationEvent;
 };
 type RestUpdateLocalAutomation = RestUpdateBaseAutomation;
+/**
+ * Request body to update a phonebook entry.
+ */
 type RestUpdatePhonebookEntry = {
     /**
-     * A Label for the Phonebook-Entry
+     * A label for the phonebook entry (unique per customer).
      */
     label?: string;
     /**
-     * The Telephone-Number
+     * The telephone number, in E.164 format.
      */
     number?: string;
     /**
@@ -3210,9 +3793,21 @@ type RestUpdatePhonebookEntry = {
      */
     tags?: Array<Tag>;
 };
+/**
+ * Request body to update a prompt.
+ */
 type RestUpdatePrompt = {
+    /**
+     * The prompt's label (unique per customer).
+     */
     label?: string;
+    /**
+     * For text-to-speech prompts, the text rendered to audio.
+     */
     text?: string;
+    /**
+     * The prompt's language (BCP-47/ISO code).
+     */
     locale?: string;
     /**
      * Whether this Prompt is a Default-Prompt
@@ -3259,9 +3854,12 @@ type RestUpdateQueueSelection = {
     tags?: Array<QueueSelectionTag>;
     agents?: Array<QueueSelectionAgent>;
 };
+/**
+ * Request body to update a routing.
+ */
 type RestUpdateRouting = {
     application?: RestCreateRoutingApplication;
-    number?: RestCreateRoutingApplication;
+    number?: RestCreateRoutingNumber;
     /**
      * A List of Tags describing an Object
      */
@@ -3276,13 +3874,16 @@ type RestUpdateTrigger = {
      */
     tags?: Array<Tag>;
 };
+/**
+ * A routing — maps an inbound phone number to the voice application that handles its calls.
+ */
 type Routing = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
-    application: RestCreateRoutingApplication;
-    number: RestCreateRoutingApplication;
+    application: RoutingApplication;
+    number: RoutingNumber;
     /**
      * A List of Tags describing an Object
      */
@@ -3295,11 +3896,35 @@ type RoutingItemResponse = {
      */
     success: boolean;
 };
+/**
+ * The voice application the number routes to.
+ */
+type RoutingApplication = {
+    /**
+     * The unique Identifier (UUID) of the object
+     */
+    id?: string;
+};
+/**
+ * The phone number being routed.
+ */
+type RoutingNumber = {
+    /**
+     * The unique Identifier (UUID) of the object
+     */
+    id?: string;
+};
+/**
+ * A phone number provisioned on the account, with its voice/SMS capabilities.
+ */
 type ServiceNumber = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The phone number, in E.164 format.
+     */
     number?: string;
     /**
      * If SMS Capability is enabled
@@ -3321,12 +3946,24 @@ type ServiceNumberItemResponse = {
      */
     success: boolean;
 };
+/**
+ * A call session with its metadata and variables.
+ */
 type SessionResponse = {
     item?: SessionResponseItem;
     success?: boolean;
 };
+/**
+ * The call session.
+ */
 type SessionResponseItem = {
+    /**
+     * The call session's uuid.
+     */
     id?: string;
+    /**
+     * Whether the session is still valid (not expired).
+     */
     valid?: boolean;
     /**
      * When the session was created
@@ -3386,71 +4023,212 @@ type SettingItemResponse = {
     item: Setting;
     success: boolean;
 };
+/**
+ * The app-scope `agent.status` settings.
+ */
 type SettingsAppAgentStatus = {
+    /**
+     * Whether status-based agent selection is enabled.
+     */
     selectionEnabled: boolean;
 };
+/**
+ * The app-scope `conversations` settings.
+ */
 type SettingsAppConversations = {
+    /**
+     * Which conversations an agent may see — their own, their group's, or all.
+     */
     conversationScope: 'OWN' | 'GROUP' | 'ALL';
+    /**
+     * Automatically close a conversation when its call ends.
+     */
     autoClose: boolean;
 };
+/**
+ * The app-scope `customer.logging` settings.
+ */
 type SettingsAppCustomerLogging = {
+    /**
+     * Whether customer-level request logging is enabled.
+     */
     enabled: boolean;
 };
+/**
+ * The app-scope `integrations` settings.
+ */
 type SettingsAppIntegrations = {
+    /**
+     * Integration that backs conversation task creation.
+     */
     taskIntegration: string | null;
+    /**
+     * Action key used to create a task for a conversation.
+     */
     conversationTaskKey: string | null;
+    /**
+     * Integration that backs agent scripting.
+     */
     scriptingIntegration: string | null;
+    /**
+     * Action key used to fetch a conversation script.
+     */
     conversationScriptKey: string | null;
+    /**
+     * Action key used to fetch a campaign script.
+     */
     conversationScriptCampaignKey: string | null;
 };
+/**
+ * The audit-scope `default` settings.
+ */
 type SettingsAuditDefault = {
+    /**
+     * Whether audit logging is enabled.
+     */
     enabled: boolean;
+    /**
+     * Whether audit entries are anonymized.
+     */
     anonymized: boolean;
 };
 type SettingsListResponse = {
     items: Array<Setting>;
     success: boolean;
 };
+/**
+ * The retention-scope `periods` settings.
+ */
 type SettingsRetentionPeriods = {
+    /**
+     * Default data retention period, in days.
+     */
     defaultPeriod: number;
+    /**
+     * Retention period for recording files, in days.
+     */
     recordingFiles: number;
+    /**
+     * Retention period for call records, in days.
+     */
     calls: number;
 };
+/**
+ * The telephony-scope `agent.inbound` settings.
+ */
 type SettingsTelephonyAgentInbound = {
+    /**
+     * Wrap-up time in seconds after an inbound call ends busy.
+     */
     wrapUpBusy: number;
+    /**
+     * Wrap-up time in seconds after an inbound call ends unreachable.
+     */
     wrapUpUnreachable: number;
+    /**
+     * Wrap-up time in seconds after an inbound call is declined.
+     */
     wrapUpDeclined: number;
 };
+/**
+ * The telephony-scope `agent.outbound` settings.
+ */
 type SettingsTelephonyAgentOutbound = {
+    /**
+     * Wrap-up time in seconds after an outbound call ends busy.
+     */
     wrapUpBusy: number;
+    /**
+     * Wrap-up time in seconds after an outbound call ends unreachable.
+     */
     wrapUpUnreachable: number;
+    /**
+     * Wrap-up time in seconds after an outbound call is declined.
+     */
     wrapUpDeclined: number;
 };
+/**
+ * The telephony-scope `agent.recording` settings.
+ */
 type SettingsTelephonyAgentRecording = {
+    /**
+     * Hide the recording controls in the agent UI.
+     */
     hideRecordingUi: boolean;
+    /**
+     * Allow agents to delete recordings.
+     */
     allowDelete: boolean;
+    /**
+     * Default tag applied to new recordings.
+     */
     tag: string;
+    /**
+     * Tags an agent may apply to a recording.
+     */
     availableTags: Array<string>;
+    /**
+     * Always record outbound calls.
+     */
     alwaysRecordOutbound: boolean;
 };
+/**
+ * The telephony-scope `agent.wrapup` settings.
+ */
 type SettingsTelephonyAgentWrapup = {
+    /**
+     * Allow agents to cancel wrap-up on inbound calls.
+     */
     cancelWrapUp: boolean;
+    /**
+     * Allow agents to extend wrap-up on inbound calls.
+     */
     extendWrapUp: boolean;
+    /**
+     * Maximum wrap-up extension for inbound calls, in seconds.
+     */
     maxExtension: number;
+    /**
+     * Enable wrap-up for outbound calls.
+     */
     enabledOutbound: boolean;
+    /**
+     * Allow agents to cancel wrap-up on outbound calls.
+     */
     cancelWrapUpOutbound: boolean;
+    /**
+     * Allow agents to extend wrap-up on outbound calls.
+     */
     extendWrapUpOutbound: boolean;
+    /**
+     * Maximum wrap-up extension for outbound calls, in seconds.
+     */
     maxExtensionOutbound: number;
+    /**
+     * Default wrap-up time for outbound calls, in seconds.
+     */
     wrapupTimeOutbound: number;
 };
+/**
+ * The telephony-scope `post-call` settings.
+ */
 type SettingsTelephonyPostCall = {
     /**
      * The unique Identifier (UUID) of the object
      */
     applicationId: string;
 };
+/**
+ * The ui-scope `i18n` settings.
+ */
 type SettingsUiI18N = {
+    /**
+     * Default UI locale (e.g. `en`, `de`).
+     */
     locale: string;
+    /**
+     * Default UI timezone (IANA name, e.g. `Europe/Berlin`).
+     */
     timezone: string;
 };
 type SimpleMenuApplication = {
@@ -3495,6 +4273,9 @@ type SimpleMenuItem = {
     key: InputReaderTerminationDigit;
     application: ResourceReference;
 };
+/**
+ * A short message (SMS) sent or received on the account.
+ */
 type Sms = {
     /**
      * The unique Identifier (UUID) of the object
@@ -3510,10 +4291,19 @@ type Sms = {
     agentId?: string;
     dateCreated: string;
     type: SmsType;
+    /**
+     * The sender's phone number, in E.164 format.
+     */
     from: string;
+    /**
+     * The recipient's phone number, in E.164 format.
+     */
     to: string;
     state: SmsState;
     source: SmsSource;
+    /**
+     * The message body.
+     */
     text?: string;
 };
 type SmsItemResponse = {
@@ -3527,16 +4317,40 @@ type SmsItemResponse = {
  * An outbound SMS to send
  */
 type SmsSendRequest = {
+    /**
+     * The recipient's phone number, in E.164 format.
+     */
     to: string;
+    /**
+     * The sender's phone number or registered sender ID.
+     */
     from?: string;
+    /**
+     * The message body.
+     */
     text: string;
+    /**
+     * Optional alphanumeric sender name shown to the recipient.
+     */
     displayAs?: string;
+    /**
+     * Optional session variables to seed on the resulting conversation.
+     */
     session?: {
         [key: string]: unknown;
     };
 };
+/**
+ * How the SMS was originated.
+ */
 type SmsSource = 'api' | 'inbound' | 'action' | 'test';
+/**
+ * Delivery state of the SMS.
+ */
 type SmsState = 'unknown' | 'queued' | 'processing' | 'failed' | 'validation_failed' | 'sent' | 'received' | 'received_transaction' | 'merged';
+/**
+ * Direction of the SMS — inbound (received) or outbound (sent).
+ */
 type SmsType = 'inbound' | 'outbound';
 type SpeechToTextApplication = {
     /**
@@ -3605,7 +4419,13 @@ type StoredFile = {
      * Storage path
      */
     path: string;
+    /**
+     * The file's name.
+     */
     filename: string;
+    /**
+     * MIME content type of the file.
+     */
     contentType?: string | null;
     /**
      * File size in bytes
@@ -3801,33 +4621,57 @@ type TransferApplicationUpdateBody = {
     settings?: TransferApplicationSettings;
     module: 'transfer';
 };
+/**
+ * A reusable named set of conditions evaluated against an event or call context; referenced by automations and routings to decide whether to fire.
+ */
 type Trigger = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id: string;
+    /**
+     * The trigger's name (unique per customer).
+     */
     name: string;
     type: TriggerType;
+    /**
+     * The conditions evaluated, combined per the trigger's `type`.
+     */
     conditions: Array<TriggerCondition>;
     /**
      * A List of Tags describing an Object
      */
     tags?: Array<Tag>;
 };
+/**
+ * A single condition — the `operator` compares the value resolved from `expression` against `expectation`.
+ */
 type TriggerCondition = {
     /**
      * The unique Identifier (UUID) of the object
      */
     id?: string;
+    /**
+     * The variable or field whose value is evaluated.
+     */
     expression: string;
     operator: TriggerOperator;
+    /**
+     * The value the resolved expression is compared against.
+     */
     expectation: string;
 };
 type TriggerConditionListResponse = {
     items: Array<TriggerCondition>;
     success?: boolean;
 };
+/**
+ * The full set of conditions to set on a trigger (replaces existing).
+ */
 type TriggerConditionsRequest = {
+    /**
+     * The conditions to set on the trigger.
+     */
     conditions: Array<TriggerCondition>;
 };
 type TriggerItemResponse = {
@@ -3837,7 +4681,13 @@ type TriggerItemResponse = {
      */
     success: boolean;
 };
+/**
+ * The comparison operator applied in a trigger condition.
+ */
 type TriggerOperator = 'EQ' | 'NEQ' | 'GT' | 'GE' | 'LT' | 'LE' | 'REGEXP' | 'LIKE' | 'GIVEN' | 'NOT_GIVEN' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'NOT_CONTAINS' | 'IS_NULL' | 'IS_NOT_NULL' | 'EVALUABLE' | 'NOT_EVALUABLE';
+/**
+ * How the trigger's conditions are combined — `ALL` requires every condition to match, `ANY` requires at least one.
+ */
 type TriggerType = 'ALL' | 'ANY';
 /**
  * A resource that references a trigger
@@ -3877,6 +4727,9 @@ type UpdateCampaignRequest = {
     listOrder?: CampaignListOrder;
     callRatio?: number;
 };
+/**
+ * A key/value map of variables to set on the call session's user scope.
+ */
 type UpdateSessionVariablesRequest = {
     [key: string]: unknown;
 };
@@ -4030,11 +4883,11 @@ type ListBabeldesksData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4045,11 +4898,11 @@ type ListBabeldeskWidgetsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4060,11 +4913,11 @@ type ListBusinessHoursData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4075,11 +4928,11 @@ type ListCalendarsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4418,11 +5271,11 @@ type ListConversationsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
         /**
@@ -4441,11 +5294,11 @@ type ListDashboardsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
         /**
@@ -4472,11 +5325,11 @@ type ListGlobalAutomationsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4487,11 +5340,11 @@ type ListFilesData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
         /**
@@ -4582,11 +5435,11 @@ type ListServiceNumbersData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4628,11 +5481,11 @@ type ListOutboundLeadsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
         /**
@@ -4651,11 +5504,11 @@ type ListPhonebookEntrysData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4666,11 +5519,11 @@ type ListPromptsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4681,11 +5534,11 @@ type ListQueuesData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4708,11 +5561,11 @@ type ListGlobalQueueSelectionsData = {
          */
         includeMembers?: boolean;
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4722,17 +5575,17 @@ type ListQueuedCallsData = {
     body?: never;
     path: {
         /**
-         * Path Parameter queueId
+         * The queue's uuid.
          */
         queueId: string;
     };
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4743,11 +5596,11 @@ type ListRoutingsData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4758,11 +5611,11 @@ type ListSmssData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };
@@ -4773,11 +5626,11 @@ type ListTriggersData = {
     path?: never;
     query?: {
         /**
-         * Parameter [page]
+         * 1-based page number.
          */
         page?: number;
         /**
-         * Parameter [max]
+         * Maximum number of items to return per page.
          */
         max?: number;
     };