@rymi/node 1.0.1 → 2.1.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Agent } from '@rymi/sdk-types';
+import { Agent, AgentToolBinding, CampaignAttempt, Campaign, CampaignMember, CampaignReport, CampaignStatus, CampaignType, CampaignGoal, CampaignCompliancePolicy, Contact } from '@rymi/sdk-types';
 export * from '@rymi/sdk-types';
 
 interface ClientOptions {
@@ -10,6 +10,11 @@ interface ClientOptions {
      * The base URL for the API. Defaults to `https://api.rymi.live/v1`
      */
     baseURL?: string;
+    /**
+     * Custom fetch implementation. Lets embedders route requests without a
+     * network socket (e.g. Fastify app.inject). Defaults to global fetch.
+     */
+    fetch?: typeof globalThis.fetch;
 }
 declare class RymiError extends Error {
     status?: number;
@@ -19,6 +24,7 @@ declare class RymiError extends Error {
 declare class RymiClient {
     private apiKey;
     private baseURL;
+    private fetchImpl;
     constructor(options?: ClientOptions);
     private request;
     get<T>(path: string): Promise<T>;
@@ -56,11 +62,11 @@ interface CreateAgentParams {
     custom_voice_url?: string | null;
     custom_voice_mode?: 'rymi' | 'openai-compat';
     custom_transcriber_url?: string | null;
-    agent_role?: 'operator' | 'specialist' | 'executive' | 'concierge';
     language?: string | null;
     /** All BCP-47 languages the agent should handle, e.g. ["hi-IN","en-US"] for a bilingual agent. */
     supported_languages?: string[];
     provider_config?: any;
+    tools?: AgentToolBinding[];
 }
 interface UpdateAgentParams {
     name?: string;
@@ -90,12 +96,13 @@ interface UpdateAgentParams {
     custom_voice_url?: string | null;
     custom_voice_mode?: 'rymi' | 'openai-compat';
     custom_transcriber_url?: string | null;
-    agent_role?: 'operator' | 'specialist' | 'executive' | 'concierge';
     language?: string | null;
     /** All BCP-47 languages the agent should handle, e.g. ["hi-IN","en-US"] for a bilingual agent. */
     supported_languages?: string[];
     chat_summary?: string | null;
     provider_config?: any;
+    /** Replaces the whole bindings array — build it from a fresh retrieve(). */
+    tools?: AgentToolBinding[];
 }
 interface AgentListResponse {
     agents: Agent[];
@@ -121,6 +128,26 @@ interface ValidatePublishParams {
     post_call?: any;
     [key: string]: any;
 }
+interface PublishValidationIssue {
+    severity?: string;
+    section?: string;
+    title?: string;
+    detail?: string;
+    [key: string]: any;
+}
+interface PublishAgentResponse {
+    published: boolean;
+    agent_id?: string;
+    /** Present when published — the frozen snapshot id and timestamp. */
+    snapshot_id?: string | null;
+    published_at?: string | null;
+    /** Present when published: false because of unresolved blockers. */
+    reason?: string;
+    blockers?: PublishValidationIssue[];
+    warnings?: PublishValidationIssue[];
+    error?: string;
+    details?: string;
+}
 interface ChangeEntry {
     key: string;
     value: any;
@@ -147,9 +174,6 @@ interface EnrichCompanyResponse {
     error?: string;
 }
 interface PreviewStackParams {
-    /** Cost/capability role. `concierge` is not supported by this endpoint. */
-    agent_role?: 'operator' | 'specialist' | 'executive';
-    role?: 'operator' | 'specialist' | 'executive';
     language?: string | null;
     /** Required, non-empty list of BCP-47 languages to resolve a stack for. */
     supported_languages: string[];
@@ -173,6 +197,33 @@ type AddKnowledgeSourceParams = {
     title: string;
     url: string;
 };
+/** A public share link: anyone with the URL can talk to the agent, billed to your workspace. */
+interface AgentShareLink {
+    id: string;
+    url: string;
+    enabled: boolean;
+    minutes_limit: number;
+    minutes_used: number;
+    minutes_reserved: number;
+    minutes_remaining: number;
+    live_calls: number;
+    max_call_seconds: number;
+    max_concurrent: number;
+    calls_per_ip_hour: number;
+    minutes_requested_at: string | null;
+}
+/** All optional; omitted fields keep their current value (or the default on create). */
+interface AgentShareLinkSettings {
+    enabled?: boolean;
+    /** Total talk-time pool for the link, 0–6000 minutes. */
+    minutes_limit?: number;
+    /** Per-call cap, 60–1800 seconds. */
+    max_call_seconds?: number;
+    /** Simultaneous calls, 1–10. */
+    max_concurrent?: number;
+    /** Calls per caller IP per hour, 1–30. */
+    calls_per_ip_hour?: number;
+}
 interface AgentChange {
     change_id: string;
     field_path?: string;
@@ -245,6 +296,13 @@ declare class AgentsResource {
      * Pass agent_id to merge with an existing persisted agent, or supply fields directly.
      */
     validatePublish(params: ValidatePublishParams): Promise<Record<string, any>>;
+    /**
+     * Publish an agent: validate its persisted config and freeze it into the
+     * published snapshot the harness/review pipeline reads as the baseline.
+     * Returns `{ published: false, blockers }` (HTTP 200) when blockers remain —
+     * inspect `blockers` rather than relying on a thrown error.
+     */
+    publish(agentId: string): Promise<PublishAgentResponse>;
     /**
      * Validate and apply a flat-diff change-set against the AgentConfig field registry.
      * Does NOT persist — callers must follow up with update().
@@ -256,9 +314,8 @@ declare class AgentsResource {
     enrichCompany(params: EnrichCompanyParams): Promise<EnrichCompanyResponse>;
     /**
      * Preview the resolved per-language model stack (STT/LLM/TTS), blockers,
-     * warnings, model diffs, and any required role upgrades for a set of
-     * supported languages — without persisting anything. Note: the concierge
-     * (realtime) role is not supported by this endpoint.
+     * warnings, and model diffs for a set of supported languages — without
+     * persisting anything.
      */
     previewStack(params: PreviewStackParams): Promise<Record<string, any>>;
     /**
@@ -275,6 +332,26 @@ declare class AgentsResource {
      * Delete a knowledge source from an agent.
      */
     deleteKnowledgeSource(agentId: string, sourceId: string): Promise<Record<string, any>>;
+    /**
+     * Get the agent's public share link, or `link: null` if none exists.
+     * `link_feature: false` means share links are disabled on this deployment.
+     */
+    getShareLink(agentId: string): Promise<{
+        link_feature: boolean;
+        link: AgentShareLink | null;
+    }>;
+    /**
+     * Create the agent's public share link, or update its settings if one exists.
+     */
+    setShareLink(agentId: string, settings?: AgentShareLinkSettings): Promise<{
+        link: AgentShareLink;
+    }>;
+    /**
+     * Issue a new URL for the share link. The old URL stops working immediately.
+     */
+    regenerateShareLink(agentId: string): Promise<{
+        link: AgentShareLink;
+    }>;
     /**
      * List the recorded configuration changes for an agent (most recent first).
      * Optionally pass an ISO timestamp to only return changes since then.
@@ -299,6 +376,19 @@ declare class AgentsResource {
      */
     runEvals(agentId: string, params?: {
         mode?: 'synthetic' | 'live';
+        judge?: boolean;
+    }): Promise<Record<string, any>>;
+    /**
+     * Run the eval SUITE across many agents at once (agents × seeded scenarios),
+     * bounded by the optional concurrency cap. One eval run is persisted per
+     * agent; the aggregate EvalSuiteReport is returned. Pass `judge: true` to
+     * supplement the heuristics with the opt-in LLM judge (needs a Gemini key).
+     */
+    runEvalSuite(params: {
+        agentIds: string[];
+        scenarioIds?: string[];
+        concurrency?: number;
+        judge?: boolean;
     }): Promise<Record<string, any>>;
     /**
      * List previous evaluation runs for an agent.
@@ -377,6 +467,26 @@ interface BatchCallParams {
     variables?: Record<string, any>;
     post_call?: Record<string, any>;
 }
+interface FanoutCallParams {
+    agent_id: string;
+    to?: string[];
+    recipients?: Array<{
+        to?: string;
+        identity?: string;
+        phone?: string;
+        phone_number?: string;
+        from_number?: string;
+        metadata?: Record<string, any>;
+    }>;
+    from_number?: string;
+    /** Preferred tracking id for this fanout. Falls back to batch_id, then auto-generated. */
+    fanout_id?: string;
+    /** Compatibility alias for fanout_id. */
+    batch_id?: string;
+    metadata?: Record<string, any>;
+    variables?: Record<string, any>;
+    post_call?: Record<string, any>;
+}
 interface CreateCallResponse {
     id: string;
     room_name: string;
@@ -418,7 +528,18 @@ declare class CallsResource {
      */
     create(data: CreateCallParams): Promise<CreateCallResponse>;
     /**
-     * Queue up to 500 outbound PSTN recipients in one request.
+     * Group call fanout: dial up to 500 PSTN participants into a single call room.
+     * Every recipient joins the same call. For independent per-recipient attempts,
+     * retries, and reports, use `campaigns` instead.
+     */
+    fanout(data: FanoutCallParams): Promise<CreateCallResponse & {
+        fanout_id: string;
+        batch_id: string;
+        queued: number;
+    }>;
+    /**
+     * Compatibility alias for {@link fanout}. Creates one call room with multiple
+     * PSTN participants. Queue up to 500 outbound PSTN recipients in one request.
      */
     batch(data: BatchCallParams): Promise<CreateCallResponse & {
         batch_id: string;
@@ -508,13 +629,26 @@ interface NumberRecord {
     id?: string;
     number?: string;
     phone_number?: string;
-    provider?: 'plivo' | 'twilio' | 'vonage';
+    provider?: 'plivo' | 'twilio' | 'vonage' | 'telnyx';
     capabilities?: string[];
     price?: string | number;
     monthly_price?: number;
     agent_id?: string | null;
     assigned_agent_id?: string | null;
     created_at?: string;
+    /** Carrier inbound-webhook provisioning state (set once an agent is attached). */
+    webhook_status?: 'configured' | 'manual_required' | 'failed' | null;
+    webhook_url?: string | null;
+    webhook_error?: string | null;
+    last_inbound_at?: string | null;
+}
+/** Outcome of carrier inbound-webhook auto-provisioning. */
+interface WebhookProvisionResult {
+    status: 'configured' | 'manual_required' | 'failed' | 'no_carrier';
+    provider: string | null;
+    webhookUrl: string | null;
+    verified: boolean;
+    error?: string;
 }
 declare class NumbersResource {
     private client;
@@ -537,11 +671,23 @@ declare class NumbersResource {
         status: 'registered';
         number: string;
         agent_id: string | null;
+        webhook: WebhookProvisionResult | null;
     }>;
     attach(number: string, agentId: string): Promise<{
         status: 'attached';
         agent_id: string;
         number: string;
+        webhook: WebhookProvisionResult | null;
+    }>;
+    /** Clear the agent association without deregistering the number. */
+    detach(number: string): Promise<{
+        status: 'detached';
+        number: string;
+    }>;
+    /** Re-run carrier inbound-webhook auto-provisioning for a number. */
+    provisionWebhook(number: string): Promise<{
+        number: string;
+        webhook: WebhookProvisionResult;
     }>;
     remove(number: string): Promise<{
         status: 'removed';
@@ -641,7 +787,7 @@ declare class KeysResource {
     }>;
 }
 
-type TelephonyProvider = 'plivo' | 'twilio' | 'vonage';
+type TelephonyProvider = 'plivo' | 'twilio' | 'vonage' | 'telnyx';
 interface ConnectTelephonyParams {
     provider: TelephonyProvider;
     auth_id?: string;
@@ -649,6 +795,8 @@ interface ConnectTelephonyParams {
     api_key?: string;
     api_secret?: string;
     signature_secret?: string;
+    /** Telnyx Ed25519 webhook signing secret (optional). */
+    auth_secret?: string;
 }
 declare class TelephonyResource {
     private client;
@@ -700,9 +848,11 @@ declare class BillingResource {
      * MINUTES (the customer-facing unit), not dollars.
      */
     usageSummary(): Promise<UsageSummary>;
-    /** Estimate the cost of a call for a given tier and duration. */
+    /** Estimate the cost of a call for a custom model stack and duration. */
     estimate(data?: {
-        tier?: 'operator' | 'specialist' | 'executive' | 'concierge';
+        stt_model?: string;
+        llm_model?: string;
+        tts_model?: string;
         duration_seconds?: number;
     }): Promise<Record<string, any>>;
     /** Configure auto-recharge. Server rejects (400) if enabled && pack_usd <= threshold_usd. */
@@ -746,6 +896,482 @@ declare class TemplatesResource {
     }>;
 }
 
+interface ListCampaignsParams {
+    limit?: number;
+    offset?: number;
+    status?: CampaignStatus;
+    type?: CampaignType;
+    agent_id?: string;
+}
+interface CampaignListResponse {
+    campaigns: Campaign[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface CreateCampaignParams {
+    agent_id: string;
+    type: CampaignType;
+    name: string;
+    goal?: CampaignGoal;
+    schedule_policy?: Record<string, unknown>;
+    retry_policy?: Record<string, unknown>;
+    concurrency_policy?: Record<string, unknown>;
+    automation_policy?: Record<string, unknown>;
+    reporting_policy?: Record<string, unknown>;
+    compliance_policy?: CampaignCompliancePolicy;
+    metadata?: Record<string, unknown>;
+}
+interface UpdateCampaignParams {
+    name?: string;
+    goal?: CampaignGoal;
+    schedule_policy?: Record<string, unknown>;
+    retry_policy?: Record<string, unknown>;
+    concurrency_policy?: Record<string, unknown>;
+    automation_policy?: Record<string, unknown>;
+    reporting_policy?: Record<string, unknown>;
+    compliance_policy?: CampaignCompliancePolicy;
+    post_call_config_override?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+}
+interface LaunchBlocker {
+    code: string;
+    ok: boolean;
+    detail?: string;
+}
+interface LaunchCampaignResponse {
+    campaign: Campaign;
+    blockers: LaunchBlocker[];
+}
+/**
+ * GET /campaigns/:id/report response. Extends the shared CampaignReport with
+ * the report-endpoint-only derived fields (top failure reasons + cost per
+ * success) that the API adds on top of the persisted shape.
+ */
+interface CampaignReportResponse extends CampaignReport {
+    distributions: CampaignReport['distributions'] & {
+        top_failure_reasons: Array<{
+            reason: string;
+            count: number;
+        }>;
+        cost_per_success_credits: number;
+    };
+}
+interface ListCampaignMembersParams {
+    limit?: number;
+    offset?: number;
+    status?: string;
+}
+interface CampaignMemberListResponse {
+    members: CampaignMember[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface AddCampaignMembersParams {
+    contact_ids: string[];
+    variables_override?: Record<string, string>;
+}
+interface ImportCampaignMembersParams {
+    contacts?: Array<Record<string, unknown>>;
+    csv?: string;
+}
+interface ImportCampaignMembersResponse {
+    created: number;
+    merged: number;
+    /** Members attached to the campaign in this import. */
+    attached: number;
+    invalid: Array<{
+        row: number;
+        reason: string;
+    }>;
+}
+interface UpdateCampaignMemberParams {
+    status?: string;
+    variables_override?: Record<string, string>;
+    next_attempt_at?: string;
+}
+declare class CampaignMembersResource {
+    private client;
+    constructor(client: RymiClient);
+    /** List a campaign's members, paginated. */
+    list(campaignId: string, params?: ListCampaignMembersParams): Promise<CampaignMemberListResponse>;
+    /** Attach existing contacts to a campaign as members. */
+    add(campaignId: string, data: AddCampaignMembersParams): Promise<{
+        members: CampaignMember[];
+    }>;
+    /** Import inline contact rows (JSON or CSV): creates/merges contacts and attaches members in one call. */
+    import(campaignId: string, data: ImportCampaignMembersParams): Promise<ImportCampaignMembersResponse>;
+    /** Update a campaign member (status, variables, next attempt time). */
+    update(campaignId: string, memberId: string, data: UpdateCampaignMemberParams): Promise<{
+        member: CampaignMember;
+    }>;
+    /** Remove a member from a campaign. */
+    remove(campaignId: string, memberId: string): Promise<{
+        status: 'deleted';
+        id: string;
+    }>;
+}
+interface CampaignRoute {
+    id: string;
+    tenant_id: string;
+    campaign_id: string;
+    phone_number: string;
+    schedule: Record<string, unknown>;
+    active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+interface ListCampaignRoutesParams {
+    limit?: number;
+    offset?: number;
+}
+interface CampaignRouteListResponse {
+    routes: CampaignRoute[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface CreateCampaignRouteParams {
+    phone_number: string;
+    schedule?: Record<string, unknown>;
+    active?: boolean;
+}
+interface UpdateCampaignRouteParams {
+    schedule?: Record<string, unknown>;
+    active?: boolean;
+}
+declare class CampaignRoutesResource {
+    private client;
+    constructor(client: RymiClient);
+    /** List a campaign's inbound routing rules. */
+    list(campaignId: string, params?: ListCampaignRoutesParams): Promise<CampaignRouteListResponse>;
+    /** Bind an owned phone number to this campaign for inbound routing. Only one active route per number is allowed. */
+    create(campaignId: string, data: CreateCampaignRouteParams): Promise<{
+        route: CampaignRoute;
+    }>;
+    /** Update an inbound route's schedule or active flag. */
+    update(campaignId: string, routeId: string, data: UpdateCampaignRouteParams): Promise<{
+        route: CampaignRoute;
+    }>;
+    /** Delete an inbound route. */
+    delete(campaignId: string, routeId: string): Promise<{
+        status: 'deleted';
+        id: string;
+    }>;
+}
+interface ListCampaignAttemptsParams {
+    limit?: number;
+    offset?: number;
+    status?: string;
+}
+interface CampaignAttemptListResponse {
+    attempts: CampaignAttempt[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface ListCampaignBatchesParams {
+    limit?: number;
+    offset?: number;
+}
+interface CampaignBatch {
+    id: string;
+    tenant_id: string;
+    campaign_id: string;
+    batch_key: string;
+    status: string;
+    selected_count: number;
+    queued_count: number;
+    completed_count: number;
+    failed_count: number;
+    started_at?: string | null;
+    completed_at?: string | null;
+    created_at: string;
+}
+interface CampaignBatchListResponse {
+    batches: CampaignBatch[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface ListCampaignFollowupsParams {
+    limit?: number;
+    offset?: number;
+    status?: string;
+}
+interface CampaignFollowupJob {
+    id: string;
+    tenant_id: string;
+    campaign_id: string;
+    campaign_attempt_id?: string | null;
+    campaign_member_id?: string | null;
+    kind: string;
+    status: string;
+    scheduled_at: string;
+    consent_checked: boolean;
+    capability_checked: boolean;
+    idempotency_key: string;
+    payload: Record<string, unknown>;
+    result?: Record<string, unknown> | null;
+    created_at: string;
+    updated_at: string;
+}
+interface CampaignFollowupListResponse {
+    followups: CampaignFollowupJob[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface CampaignSuggestion {
+    id: string;
+    tenant_id: string;
+    campaign_id: string;
+    category: string;
+    evidence: Record<string, unknown>;
+    proposal: Record<string, unknown>;
+    status: 'proposed' | 'accepted' | 'dismissed';
+    created_by_model?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+interface ImproveCampaignResponse {
+    suggestions: CampaignSuggestion[];
+}
+interface ListCampaignSuggestionsParams {
+    limit?: number;
+    offset?: number;
+    status?: string;
+}
+interface CampaignSuggestionListResponse {
+    suggestions: CampaignSuggestion[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+declare class CampaignsResource {
+    private client;
+    members: CampaignMembersResource;
+    routes: CampaignRoutesResource;
+    constructor(client: RymiClient);
+    /** List campaigns for the authenticated tenant, paginated. */
+    list(params?: ListCampaignsParams): Promise<CampaignListResponse>;
+    /** Create a new campaign in draft status against a published agent. */
+    create(data: CreateCampaignParams): Promise<{
+        campaign: Campaign;
+    }>;
+    /** Retrieve a single campaign by id. */
+    get(campaignId: string): Promise<{
+        campaign: Campaign;
+    }>;
+    /** Update campaign policy/goal fields. Status and lifecycle fields are not writable here. */
+    update(campaignId: string, data: UpdateCampaignParams): Promise<{
+        campaign: Campaign;
+    }>;
+    /**
+     * Launch a campaign: validates launch blockers, then stamps
+     * `launched_at` + `agent_snapshot_id`, flips members to `ready`, and
+     * transitions status to `running`.
+     */
+    launch(campaignId: string): Promise<LaunchCampaignResponse>;
+    /** Evaluate launch blockers without launching (dry run). Safe from any status. */
+    launchBlockers(campaignId: string): Promise<{
+        blockers: LaunchBlocker[];
+        launchable: boolean;
+    }>;
+    /** Pause a running campaign. In-flight calls finish naturally. */
+    pause(campaignId: string): Promise<{
+        campaign: Campaign;
+    }>;
+    /** Resume a paused campaign. */
+    resume(campaignId: string): Promise<{
+        campaign: Campaign;
+    }>;
+    /** Archive a campaign. Terminal — the scheduler never selects work for it again. */
+    archive(campaignId: string): Promise<{
+        campaign: Campaign;
+    }>;
+    /** Read the campaign report: `stat_*` summary counters + outcome/sentiment/hourly/snapshot distributions. */
+    report(campaignId: string): Promise<CampaignReportResponse>;
+    /** List a campaign's dial attempts, paginated. */
+    attempts(campaignId: string, params?: ListCampaignAttemptsParams): Promise<CampaignAttemptListResponse>;
+    /** List a campaign's sweep-claim batches, paginated. */
+    batches(campaignId: string, params?: ListCampaignBatchesParams): Promise<CampaignBatchListResponse>;
+    /** List a campaign's follow-up jobs, paginated. */
+    followups(campaignId: string, params?: ListCampaignFollowupsParams): Promise<CampaignFollowupListResponse>;
+    /** Run the improve engine: detectors gate an LLM proposal writer, persisting new `campaign_suggestions`. */
+    improve(campaignId: string): Promise<ImproveCampaignResponse>;
+    /** List a campaign's improvement suggestions, paginated. */
+    suggestions(campaignId: string, params?: ListCampaignSuggestionsParams): Promise<CampaignSuggestionListResponse>;
+    /** Accept a suggestion: agent-editing suggestions create an agent-changes draft; campaign-policy suggestions patch the campaign. */
+    acceptSuggestion(campaignId: string, suggestionId: string): Promise<{
+        suggestion: CampaignSuggestion;
+    }>;
+    /** Dismiss a suggestion without applying it. */
+    dismissSuggestion(campaignId: string, suggestionId: string): Promise<{
+        suggestion: CampaignSuggestion;
+    }>;
+}
+
+interface ListContactsParams {
+    limit?: number;
+    offset?: number;
+}
+interface ContactListResponse {
+    contacts: Contact[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+interface CreateContactParams {
+    phone?: string;
+    email?: string;
+    name?: string;
+    timezone?: string;
+    language?: string;
+    tags?: string[];
+    custom_fields?: Record<string, unknown>;
+    consent?: Record<string, boolean>;
+    source?: string;
+}
+interface CreateContactResponse {
+    contact: Contact;
+    deduped: boolean;
+}
+interface UpdateContactParams {
+    phone?: string;
+    email?: string | null;
+    name?: string | null;
+    timezone?: string | null;
+    language?: string | null;
+    tags?: string[];
+    custom_fields?: Record<string, unknown>;
+    consent?: Record<string, boolean>;
+    source?: string | null;
+}
+interface ImportContactsParams {
+    contacts?: Array<Record<string, unknown>>;
+    csv?: string;
+}
+interface ImportContactsResponse {
+    created: number;
+    merged: number;
+    invalid: Array<{
+        row: number;
+        reason: string;
+    }>;
+}
+interface SetConsentParams {
+    channel: 'voice' | 'sms' | 'whatsapp' | 'telegram';
+    granted: boolean;
+    source?: string;
+    method?: string;
+}
+interface SetConsentResponse {
+    contact_id: string;
+    channel: string;
+    consent: {
+        granted: boolean;
+        at: string;
+        source: string;
+        method: string;
+    };
+}
+declare class ContactsResource {
+    private client;
+    constructor(client: RymiClient);
+    /** List tenant-level contacts, paginated. */
+    list(params?: ListContactsParams): Promise<ContactListResponse>;
+    /**
+     * Create a tenant-level contact. If a contact with the same
+     * (tenant, phone) already exists, the existing row is returned instead
+     * of creating a duplicate — check `deduped` in the response.
+     */
+    create(data: CreateContactParams): Promise<CreateContactResponse>;
+    /** Retrieve a single tenant-scoped contact by id. */
+    get(contactId: string): Promise<{
+        contact: Contact;
+    }>;
+    /** Update an existing tenant-scoped contact. Only provided fields change. */
+    update(contactId: string, data: UpdateContactParams): Promise<{
+        contact: Contact;
+    }>;
+    /** Delete a tenant-scoped contact. */
+    delete(contactId: string): Promise<{
+        status: 'deleted';
+        id: string;
+    }>;
+    /**
+     * Bulk import contacts from JSON rows or CSV text. Each row's phone is
+     * normalized to E.164 and upserted on (tenant_id, phone); rows with
+     * unparseable phones are skipped and reported in `invalid`.
+     */
+    import(data: ImportContactsParams): Promise<ImportContactsResponse>;
+    /** Record a consent grant or revoke for one channel, with evidence. Also
+     *  appends an immutable row to the consent_events proof log. */
+    setConsent(contactId: string, data: SetConsentParams): Promise<SetConsentResponse>;
+}
+
+interface AttestParams {
+    kind: 'dnc_external_scrub' | 'ai_disclosure';
+    note?: string;
+}
+interface Attestation {
+    id: string;
+    tenant_id: string;
+    kind: string;
+    attested_by: string | null;
+    note: string | null;
+    created_at: string;
+}
+interface AttestResponse {
+    attestation: Attestation;
+}
+interface ListAttestationsResponse {
+    attestations: Attestation[];
+}
+declare class ComplianceResource {
+    private client;
+    constructor(client: RymiClient);
+    /** Record a compliance attestation (append-only). Campaign launch blockers
+     *  in `attested` mode read the most recent one of the matching `kind`. */
+    attest(data: AttestParams): Promise<AttestResponse>;
+    /** List the tenant's 50 most recent compliance attestations, newest first. */
+    listAttestations(): Promise<ListAttestationsResponse>;
+}
+
+/** A stored API-tool secret. Values are write-only — never returned. */
+interface ToolSecretRecord {
+    name: string;
+    /** The only host this secret is ever sent to. */
+    host: string | null;
+}
+/**
+ * Tenant secrets referenced from call_webhook headers as `{{secrets.NAME}}`.
+ * Each secret is pinned to one host and only interpolated into requests to it.
+ */
+declare class ToolSecretsResource {
+    private client;
+    constructor(client: RymiClient);
+    list(): Promise<{
+        data: ToolSecretRecord[];
+    }>;
+    /** Create or replace. `name` is UPPER_SNAKE_CASE; `host` is a public hostname. */
+    set(name: string, data: {
+        value: string;
+        host: string;
+    }): Promise<{
+        data: {
+            name: string;
+        };
+    }>;
+    delete(name: string): Promise<{
+        data: {
+            name: string;
+        };
+    }>;
+}
+
 declare class Rymi {
     private client;
     agents: AgentsResource;
@@ -757,7 +1383,11 @@ declare class Rymi {
     telephony: TelephonyResource;
     billing: BillingResource;
     templates: TemplatesResource;
+    campaigns: CampaignsResource;
+    contacts: ContactsResource;
+    compliance: ComplianceResource;
+    toolSecrets: ToolSecretsResource;
     constructor(options?: ClientOptions);
 }
 
-export { type AddKnowledgeSourceParams, type AgentCallListResponse, type AgentChange, type AgentKnowledgeSource, type AgentListResponse, type AgentTemplateSummary, AgentsResource, type ApplyChangesParams, type ApplyChangesResponse, type BatchCallParams, BillingResource, type CallListResponse, type CallRecord, CallsResource, type ChangeEntry, type ClientOptions, type ConnectTelephonyParams, type CreateAgentParams, type CreateCallParams, type CreateCallResponse, type CreatePublishableKeyParams, type DncCheckResult, type DncEntry, type DncListResponse, DncResource, type EnrichCompanyParams, type EnrichCompanyResponse, KeysResource, type ListCallsParams, type NumberRecord, NumbersResource, type PreviewStackParams, type PublishableKeyRecord, Rymi, RymiClient, RymiError, type TelephonyProvider, TelephonyResource, TemplatesResource, type UpdateAgentParams, type UsageSummary, type ValidatePublishParams, type WebhookRecord, WebhooksResource, Rymi as default };
+export { type AddCampaignMembersParams, type AddKnowledgeSourceParams, type AgentCallListResponse, type AgentChange, type AgentKnowledgeSource, type AgentListResponse, type AgentShareLink, type AgentShareLinkSettings, type AgentTemplateSummary, AgentsResource, type ApplyChangesParams, type ApplyChangesResponse, type AttestParams, type AttestResponse, type Attestation, type BatchCallParams, BillingResource, type CallListResponse, type CallRecord, CallsResource, type CampaignAttemptListResponse, type CampaignBatch, type CampaignBatchListResponse, type CampaignFollowupJob, type CampaignFollowupListResponse, type CampaignListResponse, type CampaignMemberListResponse, type CampaignReportResponse, type CampaignRoute, type CampaignRouteListResponse, type CampaignSuggestion, type CampaignSuggestionListResponse, CampaignsResource, type ChangeEntry, type ClientOptions, ComplianceResource, type ConnectTelephonyParams, type ContactListResponse, ContactsResource, type CreateAgentParams, type CreateCallParams, type CreateCallResponse, type CreateCampaignParams, type CreateCampaignRouteParams, type CreateContactParams, type CreateContactResponse, type CreatePublishableKeyParams, type DncCheckResult, type DncEntry, type DncListResponse, DncResource, type EnrichCompanyParams, type EnrichCompanyResponse, type FanoutCallParams, type ImportCampaignMembersParams, type ImportCampaignMembersResponse, type ImportContactsParams, type ImportContactsResponse, type ImproveCampaignResponse, KeysResource, type LaunchBlocker, type LaunchCampaignResponse, type ListAttestationsResponse, type ListCallsParams, type ListCampaignAttemptsParams, type ListCampaignBatchesParams, type ListCampaignFollowupsParams, type ListCampaignMembersParams, type ListCampaignRoutesParams, type ListCampaignSuggestionsParams, type ListCampaignsParams, type ListContactsParams, type NumberRecord, NumbersResource, type PreviewStackParams, type PublishAgentResponse, type PublishValidationIssue, type PublishableKeyRecord, Rymi, RymiClient, RymiError, type SetConsentParams, type SetConsentResponse, type TelephonyProvider, TelephonyResource, TemplatesResource, type ToolSecretRecord, ToolSecretsResource, type UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, type WebhookRecord, WebhooksResource, Rymi as default };