@rymi/node 2.0.0 → 2.1.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Agent, CampaignAttempt, Campaign, CampaignMember, CampaignReport, CampaignStatus, CampaignType, CampaignGoal, CampaignCompliancePolicy, Contact } 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 {
@@ -66,6 +66,7 @@ interface CreateAgentParams {
     /** 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;
@@ -100,6 +101,8 @@ interface UpdateAgentParams {
     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[];
@@ -194,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;
@@ -302,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.
@@ -1290,6 +1340,38 @@ declare class ComplianceResource {
     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;
@@ -1304,7 +1386,8 @@ declare class Rymi {
     campaigns: CampaignsResource;
     contacts: ContactsResource;
     compliance: ComplianceResource;
+    toolSecrets: ToolSecretsResource;
     constructor(options?: ClientOptions);
 }
 
-export { type AddCampaignMembersParams, type AddKnowledgeSourceParams, type AgentCallListResponse, type AgentChange, type AgentKnowledgeSource, type AgentListResponse, 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 UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, 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 };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Agent, CampaignAttempt, Campaign, CampaignMember, CampaignReport, CampaignStatus, CampaignType, CampaignGoal, CampaignCompliancePolicy, Contact } 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 {
@@ -66,6 +66,7 @@ interface CreateAgentParams {
     /** 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;
@@ -100,6 +101,8 @@ interface UpdateAgentParams {
     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[];
@@ -194,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;
@@ -302,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.
@@ -1290,6 +1340,38 @@ declare class ComplianceResource {
     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;
@@ -1304,7 +1386,8 @@ declare class Rymi {
     campaigns: CampaignsResource;
     contacts: ContactsResource;
     compliance: ComplianceResource;
+    toolSecrets: ToolSecretsResource;
     constructor(options?: ClientOptions);
 }
 
-export { type AddCampaignMembersParams, type AddKnowledgeSourceParams, type AgentCallListResponse, type AgentChange, type AgentKnowledgeSource, type AgentListResponse, 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 UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, 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 };

package/dist/index.js

@@ -45,6 +45,7 @@ __export(index_exports, {
   RymiError: () => RymiError,
   TelephonyResource: () => TelephonyResource,
   TemplatesResource: () => TemplatesResource,
+  ToolSecretsResource: () => ToolSecretsResource,
   WebhooksResource: () => WebhooksResource,
   default: () => index_default
 });
@@ -249,6 +250,26 @@ var AgentsResource = class {
   async deleteKnowledgeSource(agentId, sourceId) {
     return this.client.delete(`/agents/${agentId}/knowledge-sources/${sourceId}`);
   }
+  /**
+   * Get the agent's public share link, or `link: null` if none exists.
+   * `link_feature: false` means share links are disabled on this deployment.
+   */
+  async getShareLink(agentId) {
+    const res = await this.client.get(`/agents/${agentId}/testers`);
+    return { link_feature: res.link_feature, link: res.link };
+  }
+  /**
+   * Create the agent's public share link, or update its settings if one exists.
+   */
+  async setShareLink(agentId, settings = {}) {
+    return this.client.put(`/agents/${agentId}/share-link`, settings);
+  }
+  /**
+   * Issue a new URL for the share link. The old URL stops working immediately.
+   */
+  async regenerateShareLink(agentId) {
+    return this.client.post(`/agents/${agentId}/share-link/regenerate`, {});
+  }
   /**
    * List the recorded configuration changes for an agent (most recent first).
    * Optionally pass an ISO timestamp to only return changes since then.
@@ -797,6 +818,23 @@ var ComplianceResource = class {
   }
 };
 
+// src/resources/toolSecrets.ts
+var ToolSecretsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list() {
+    return this.client.get("/tool-secrets");
+  }
+  /** Create or replace. `name` is UPPER_SNAKE_CASE; `host` is a public hostname. */
+  async set(name, data) {
+    return this.client.put(`/tool-secrets/${encodeURIComponent(name)}`, data);
+  }
+  async delete(name) {
+    return this.client.delete(`/tool-secrets/${encodeURIComponent(name)}`);
+  }
+};
+
 // src/index.ts
 __reExport(index_exports, require("@rymi/sdk-types"), module.exports);
 var Rymi = class {
@@ -813,6 +851,7 @@ var Rymi = class {
   campaigns;
   contacts;
   compliance;
+  toolSecrets;
   constructor(options) {
     this.client = new RymiClient(options);
     this.agents = new AgentsResource(this.client);
@@ -827,6 +866,7 @@ var Rymi = class {
     this.campaigns = new CampaignsResource(this.client);
     this.contacts = new ContactsResource(this.client);
     this.compliance = new ComplianceResource(this.client);
+    this.toolSecrets = new ToolSecretsResource(this.client);
   }
 };
 var index_default = Rymi;
@@ -846,6 +886,7 @@ var index_default = Rymi;
   RymiError,
   TelephonyResource,
   TemplatesResource,
+  ToolSecretsResource,
   WebhooksResource,
   ...require("@rymi/sdk-types")
 });