@talkif/sdk 0.1.0

package/dist/esm/api/resources/schedules/client/requests/ResumeScheduleRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/schedules/client/requests/UpdateScheduleRequest.d.mts

@@ -0,0 +1,32 @@
+import type * as Talkif from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         scheduleId: "scheduleId"
+ *     }
+ */
+export interface UpdateScheduleRequest {
+    /** Schedule ID */
+    scheduleId: string;
+    /** Custom cron expression, required when frequency is `custom_cron` */
+    cronExpression?: string | null;
+    /** Day of month to run on (1-28) */
+    dayOfMonth?: number | null;
+    /** Days of week to run on (1=Monday through 7=Sunday) */
+    daysOfWeek?: number[] | null;
+    /** Date after which the schedule will not execute */
+    endDate?: string | null;
+    frequency?: Talkif.ScheduleFrequency | null;
+    /** Maximum number of retry attempts per execution (0-10) */
+    maxRetries?: number | null;
+    /** Maximum number of executions before auto-completing */
+    maxRuns?: number | null;
+    /** Human-readable name for the schedule */
+    name?: string | null;
+    /** Minutes to wait before retrying a failed call (1-1440) */
+    retryDelayMinutes?: number | null;
+    /** Whether to retry the call if it fails */
+    retryOnFailure?: boolean | null;
+    /** Time of day to execute in HH:MM or HH:MM:SS format */
+    scheduleTime?: string | null;
+}

package/dist/esm/api/resources/schedules/client/requests/UpdateScheduleRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/schedules/client/requests/index.d.mts

@@ -0,0 +1,7 @@
+export type { CreateScheduleRequest } from "./CreateScheduleRequest.mjs";
+export type { DeleteScheduleRequest } from "./DeleteScheduleRequest.mjs";
+export type { GetScheduleRequest } from "./GetScheduleRequest.mjs";
+export type { ListSchedulesRequest } from "./ListSchedulesRequest.mjs";
+export type { PauseScheduleRequest } from "./PauseScheduleRequest.mjs";
+export type { ResumeScheduleRequest } from "./ResumeScheduleRequest.mjs";
+export type { UpdateScheduleRequest } from "./UpdateScheduleRequest.mjs";

package/dist/esm/api/resources/schedules/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/schedules/exports.d.mts

@@ -0,0 +1,2 @@
+export { SchedulesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/schedules/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { SchedulesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/schedules/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/schedules/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/types/ActionDefinition.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Action definition for pre/post agent actions
+ *
+ * Actions execute before or after an agent speaks. Unlike functions
+ * (which are LLM-invoked tools), actions are deterministic steps
+ * triggered automatically by the flow engine.
+ *
+ * Action types:
+ * - `"tts_say"`: Speak specific text (config: `{ text: "..." }`)
+ * - `"play_audio"`: Play an audio file (config: `{ url: "..." }`)
+ * - `"wait"`: Pause for duration (config: `{ durationMs: 1000 }`)
+ * - `"webhook"`: Fire a webhook (config: `{ url: "...", method: "POST" }`)
+ */
+export interface ActionDefinition {
+    /** Action-specific configuration (shape depends on action type) */
+    config?: (Record<string, unknown> | null) | undefined;
+    /** Action type identifier */
+    type: string;
+}

package/dist/esm/api/types/ActionDefinition.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ActionItem.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Action item extracted from the conversation by AI analysis
+ */
+export interface ActionItem {
+    /** Whether the action was completed during the call */
+    completed: boolean;
+    /** Description of the required action */
+    description: string;
+}

package/dist/esm/api/types/ActionItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AddedResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Response indicating how many contacts were added
+ */
+export interface AddedResponse {
+    /** Number of contacts successfully added to the campaign */
+    added: number;
+}

package/dist/esm/api/types/AddedResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AgentChangeSummary.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Summary counts for agent changes
+ */
+export interface AgentChangeSummary {
+    /** Number of agents added */
+    added: number;
+    /** Number of agents modified */
+    modified: number;
+    /** Number of agents removed */
+    removed: number;
+}

package/dist/esm/api/types/AgentChangeSummary.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AgentDefinition.d.mts

@@ -0,0 +1,47 @@
+import type * as Talkif from "../index.mjs";
+/**
+ * Agent node definition
+ *
+ * Represents a conversational agent in the flow.
+ *
+ * The entry agent (`main_agent`) carries the call's `systemPrompt`; every
+ * agent carries its own `agentPrompt`. The system prompt is global to the
+ * call and persists across transitions, so non-entry agents must not set
+ * one (validation rejects it).
+ */
+export interface AgentDefinition {
+    /**
+     * This agent's own instructions — THE canonical task field.
+     *
+     * In force only while the flow sits on this agent. Static and dynamic
+     * content share this one field: text containing `{{handlebars}}` is
+     * resolved at call time, plain text passes through. There is no prompt
+     * node, no edge, and no template indirection.
+     *
+     * `taskMessage` is accepted as a deprecated alias.
+     */
+    agentPrompt?: (string | null) | undefined;
+    /** Tool functions available to this agent (includes end_call, webhooks, etc.) */
+    functions?: Talkif.FunctionDefinition[] | undefined;
+    /** Display name */
+    name: string;
+    /** Actions executed after agent finishes */
+    postActions?: Talkif.ActionDefinition[] | undefined;
+    /** Actions executed before agent starts speaking */
+    preActions?: Talkif.ActionDefinition[] | undefined;
+    prompt?: (Talkif.PromptReference | null) | undefined;
+    /**
+     * The call's system prompt — set on the entry agent only.
+     *
+     * Global to the call and persistent across agent transitions, so
+     * non-entry agents leave this `None` and inherit it. Validation rejects
+     * a `systemPrompt` on a non-entry agent.
+     *
+     * `roleMessage` is accepted as a deprecated alias.
+     */
+    systemPrompt?: (string | null) | undefined;
+    /** Transitions to other agents (keywords trigger agent handoff) */
+    transitions?: Talkif.TransitionDefinition[] | undefined;
+    /** Agent type: "main_agent" (exactly one, entry point) or "agent" */
+    type: Talkif.AgentType;
+}

package/dist/esm/api/types/AgentDefinition.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AgentStatus.d.mts

@@ -0,0 +1,10 @@
+/** Status of the AI agent handling the call. */
+export declare const AgentStatus: {
+    readonly Pending: "pending";
+    readonly Connecting: "connecting";
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Errored: "errored";
+    readonly Disconnected: "disconnected";
+};
+export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];

package/dist/esm/api/types/AgentStatus.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Status of the AI agent handling the call. */
+export const AgentStatus = {
+    Pending: "pending",
+    Connecting: "connecting",
+    Active: "active",
+    Completed: "completed",
+    Errored: "errored",
+    Disconnected: "disconnected",
+};

package/dist/esm/api/types/AgentType.d.mts

@@ -0,0 +1,6 @@
+/** Agent type discriminator */
+export declare const AgentType: {
+    readonly MainAgent: "main_agent";
+    readonly Agent: "agent";
+};
+export type AgentType = (typeof AgentType)[keyof typeof AgentType];

package/dist/esm/api/types/AgentType.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Agent type discriminator */
+export const AgentType = {
+    MainAgent: "main_agent",
+    Agent: "agent",
+};

package/dist/esm/api/types/AnalyticsCostBreakdownResponse.d.mts

@@ -0,0 +1,27 @@
+import type * as Talkif from "../index.mjs";
+/**
+ * Account-level cost breakdown by category
+ */
+export interface AnalyticsCostBreakdownResponse {
+    /** Account identifier */
+    accountId: string;
+    /** Cost breakdown by service category (LLM, TTS, STT, telephony) */
+    byCategory: Talkif.CategoryBreakdown[];
+    /** Cost breakdown by flow */
+    byFlow: Talkif.FlowCostBreakdown[];
+    /**
+     * Individual calls with per-category breakdown, for drill-down.
+     * Ordered by created_at DESC, limited to the most recent calls in the period.
+     */
+    calls: Talkif.CallCostDetail[];
+    /** End of the reporting period */
+    endDate: string;
+    /** Time period label */
+    period: string;
+    /** Start of the reporting period */
+    startDate: string;
+    /** Total cost in microcents (1 cent = 10,000 microcents) */
+    totalMicrocents: number;
+    /** Total cost in USD */
+    totalUsd: number;
+}

package/dist/esm/api/types/AnalyticsCostBreakdownResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AnalyticsCostLineItemResponse.d.mts

@@ -0,0 +1,27 @@
+/**
+ * Single cost line item for API response
+ */
+export interface AnalyticsCostLineItemResponse {
+    /** Amount in microcents */
+    amountMicrocents: number;
+    /** Amount in USD */
+    amountUsd: number;
+    /** Cost category identifier */
+    category: string;
+    /** Human-readable category name */
+    categoryDisplay: string;
+    /** When this line item was created */
+    createdAt: string;
+    /** Line item identifier */
+    id: string;
+    /** Rate in microcents per unit */
+    rateMicrocents?: (number | null) | undefined;
+    /** Rate unit description */
+    rateUnit?: (string | null) | undefined;
+    /** Additional usage metadata */
+    usageData: Record<string, unknown>;
+    /** Usage quantity (e.g., token count, character count) */
+    usageQuantity?: (number | null) | undefined;
+    /** Unit of usage (e.g., "tokens", "characters", "minutes") */
+    usageUnit?: (string | null) | undefined;
+}

package/dist/esm/api/types/AnalyticsCostLineItemResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AttemptBucket.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Attempt distribution bucket
+ */
+export interface AttemptBucket {
+    /** Number of attempts */
+    attempts: number;
+    /** Number of contacts with this many attempts */
+    contactCount: number;
+    /** Percentage of total contacts (0-100) */
+    percentage: number;
+}

package/dist/esm/api/types/AttemptBucket.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AvailablePhoneNumber.d.mts

@@ -0,0 +1,35 @@
+import type * as Talkif from "../index.mjs";
+/**
+ * Available phone number from Twilio search
+ *
+ * Based on Twilio AvailablePhoneNumberLocal API response
+ * See: https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource
+ */
+export interface AvailablePhoneNumber {
+    /** Type of address required to purchase this number (none, any, local, foreign) */
+    addressRequirements: string;
+    /** Whether the phone number is new to the Twilio platform */
+    beta: boolean;
+    /** Capabilities of this phone number (Voice, SMS, MMS) */
+    capabilities: Talkif.PhoneNumberCapability[];
+    /** Formatted version of the phone number */
+    friendlyName: string;
+    /** ISO country code of this phone number */
+    isoCountry: string;
+    /** LATA of this phone number (US/Canada only) */
+    lata?: (string | null) | undefined;
+    /** Latitude of this phone number's location (US/Canada only) */
+    latitude?: (number | null) | undefined;
+    /** Locality/city of this phone number's location (US/Canada only) */
+    locality?: (string | null) | undefined;
+    /** Longitude of this phone number's location (US/Canada only) */
+    longitude?: (number | null) | undefined;
+    /** Phone number in E.164 format */
+    phoneNumber: string;
+    /** Postal or ZIP code (US/Canada only) */
+    postalCode?: (string | null) | undefined;
+    /** Rate center of this phone number (US/Canada only) */
+    rateCenter?: (string | null) | undefined;
+    /** Two-letter state or province abbreviation (US/Canada only) */
+    region?: (string | null) | undefined;
+}

package/dist/esm/api/types/AvailablePhoneNumber.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BalanceSummaryResponse.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Balance summary for an account
+ */
+export interface BalanceSummaryResponse {
+    /** Total available balance across all non-expired buckets (USD) */
+    available: string;
+    /** Balance from bonuses and promotions */
+    bonusBalance: string;
+    /** Earliest expiration date among all balance buckets, if any */
+    earliestExpiration?: (string | null) | undefined;
+    /** Balance from direct purchases (never expires) */
+    purchasedBalance: string;
+}

package/dist/esm/api/types/BalanceSummaryResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BillableType.d.mts

@@ -0,0 +1,8 @@
+/** Type of billable entity */
+export declare const BillableType: {
+    readonly Call: "call";
+    readonly PhonePurchase: "phone_purchase";
+    readonly PhoneMonthly: "phone_monthly";
+    readonly RecordingStorage: "recording_storage";
+};
+export type BillableType = (typeof BillableType)[keyof typeof BillableType];

package/dist/esm/api/types/BillableType.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Type of billable entity */
+export const BillableType = {
+    Call: "call",
+    PhonePurchase: "phone_purchase",
+    PhoneMonthly: "phone_monthly",
+    RecordingStorage: "recording_storage",
+};

package/dist/esm/api/types/BulkAddContactsResponse.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Response for bulk add operation
+ */
+export interface BulkAddContactsResponse {
+    /** Number of contacts successfully added to the campaign */
+    added: number;
+    /** Total number of contacts that matched the filter criteria */
+    matched: number;
+    /** Number of contacts skipped because they were already in the campaign */
+    skipped: number;
+}

package/dist/esm/api/types/BulkAddContactsResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BulkContactFilter.d.mts

@@ -0,0 +1,18 @@
+import type * as Talkif from "../index.mjs";
+/**
+ * Filter criteria for bulk adding contacts to a campaign
+ *
+ * At least one filter must be provided. Filters are combined with AND logic:
+ * - If both `tags` and `company` are specified, contacts must match BOTH
+ * - Use `tagMode` to control tag matching: "any" (OR) or "all" (AND)
+ */
+export interface BulkContactFilter {
+    /** Filter by company name (exact match, case-sensitive) */
+    company?: (string | null) | undefined;
+    /** Full-text search across name, company, occupation, and email */
+    search?: (string | null) | undefined;
+    /** How to match multiple tags: `any` (OR, default) or `all` (AND) */
+    tagMode?: Talkif.BulkTagFilterMode | undefined;
+    /** Tags to filter by, matching behavior controlled by `tagMode` */
+    tags?: (string[] | null) | undefined;
+}

package/dist/esm/api/types/BulkContactFilter.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BulkDncImportResponse.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Bulk import response
+ */
+export interface BulkDncImportResponse {
+    /** Number of new DNC entries added */
+    added: number;
+    /** Number of entries skipped because they were already on the DNC list */
+    skipped: number;
+}

package/dist/esm/api/types/BulkDncImportResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BulkRemoveContactsResponse.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Result of a bulk remove-by-filter operation
+ */
+export interface BulkRemoveContactsResponse {
+    /** Number of campaign contacts matching the filter */
+    matched: number;
+    /** Number actually removed */
+    removed: number;
+    /** Number left in place because they were already called or in the queue */
+    skipped: number;
+}

package/dist/esm/api/types/BulkRemoveContactsResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BulkTagFilterMode.d.mts

@@ -0,0 +1,6 @@
+/** Tag filter mode for bulk operations */
+export declare const BulkTagFilterMode: {
+    readonly Any: "any";
+    readonly All: "all";
+};
+export type BulkTagFilterMode = (typeof BulkTagFilterMode)[keyof typeof BulkTagFilterMode];

package/dist/esm/api/types/BulkTagFilterMode.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Tag filter mode for bulk operations */
+export const BulkTagFilterMode = {
+    Any: "any",
+    All: "all",
+};

package/dist/esm/api/types/CallCostBreakdownResponse.d.mts

@@ -0,0 +1,14 @@
+import type * as Talkif from "../index.mjs";
+/**
+ * Individual call cost breakdown response
+ */
+export interface CallCostBreakdownResponse {
+    /** Call identifier */
+    callId: string;
+    /** Individual cost line items */
+    lineItems: Talkif.AnalyticsCostLineItemResponse[];
+    /** Total cost in microcents */
+    totalMicrocents: number;
+    /** Total cost in USD */
+    totalUsd: number;
+}

package/dist/esm/api/types/CallCostBreakdownResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CallCostDetail.d.mts

@@ -0,0 +1,26 @@
+import type * as Talkif from "../index.mjs";
+/**
+ * Call cost detail with per-category breakdown for drill-down
+ */
+export interface CallCostDetail {
+    /** Cost breakdown by category for this call */
+    byCategory: Talkif.CategoryBreakdown[];
+    /** Call identifier */
+    callId: string;
+    /** Contact identifier */
+    contactId?: (string | null) | undefined;
+    /** When the call was created */
+    createdAt: string;
+    /** Call direction (inbound or outbound) */
+    direction?: (string | null) | undefined;
+    /** Call duration in seconds */
+    durationSeconds?: (number | null) | undefined;
+    /** Associated flow identifier */
+    flowId?: (string | null) | undefined;
+    /** Flow display name */
+    flowName?: (string | null) | undefined;
+    /** Call cost in microcents */
+    totalMicrocents: number;
+    /** Call cost in USD */
+    totalUsd: number;
+}

package/dist/esm/api/types/CallCostDetail.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CallCounts.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Call count breakdown
+ */
+export interface CallCounts {
+    /** Calls that completed successfully */
+    completed: number;
+    /** Calls that failed due to errors */
+    failed: number;
+    /** Calls currently in progress */
+    inProgress: number;
+    /** Calls where the recipient did not answer */
+    noAnswer: number;
+    /** Total number of calls in the period */
+    total: number;
+}

package/dist/esm/api/types/CallCounts.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CallDirection.d.mts

@@ -0,0 +1,6 @@
+/** Call direction */
+export declare const CallDirection: {
+    readonly Inbound: "inbound";
+    readonly Outbound: "outbound";
+};
+export type CallDirection = (typeof CallDirection)[keyof typeof CallDirection];

package/dist/esm/api/types/CallDirection.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Call direction */
+export const CallDirection = {
+    Inbound: "inbound",
+    Outbound: "outbound",
+};

package/dist/esm/api/types/CallEndReason.d.mts

@@ -0,0 +1,22 @@
+/**
+ * Why a call ended — set once when a call reaches terminal state.
+ *
+ * Unlike `failure_code` which categorizes technical failures, `end_reason`
+ * captures the causal signal that ended the call regardless of success/failure.
+ * First writer wins (COALESCE pattern in SQL).
+ */
+export declare const CallEndReason: {
+    readonly CallerHangup: "caller_hangup";
+    readonly AgentCompleted: "agent_completed";
+    readonly AgentError: "agent_error";
+    readonly AgentUnavailable: "agent_unavailable";
+    readonly AgentTimeout: "agent_timeout";
+    readonly AgentCrashed: "agent_crashed";
+    readonly NoAnswer: "no_answer";
+    readonly Busy: "busy";
+    readonly Canceled: "canceled";
+    readonly TelephonyError: "telephony_error";
+    readonly BalanceDepleted: "balance_depleted";
+    readonly Reconciled: "reconciled";
+};
+export type CallEndReason = (typeof CallEndReason)[keyof typeof CallEndReason];

package/dist/esm/api/types/CallEndReason.mjs

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Why a call ended — set once when a call reaches terminal state.
+ *
+ * Unlike `failure_code` which categorizes technical failures, `end_reason`
+ * captures the causal signal that ended the call regardless of success/failure.
+ * First writer wins (COALESCE pattern in SQL).
+ */
+export const CallEndReason = {
+    CallerHangup: "caller_hangup",
+    AgentCompleted: "agent_completed",
+    AgentError: "agent_error",
+    AgentUnavailable: "agent_unavailable",
+    AgentTimeout: "agent_timeout",
+    AgentCrashed: "agent_crashed",
+    NoAnswer: "no_answer",
+    Busy: "busy",
+    Canceled: "canceled",
+    TelephonyError: "telephony_error",
+    BalanceDepleted: "balance_depleted",
+    Reconciled: "reconciled",
+};