@rymi/node 2.7.1 → 2.8.0

package/dist/index.d.mts

@@ -147,6 +147,9 @@ interface PublishAgentResponse {
     /** Present when published — the frozen snapshot id and timestamp. */
     snapshot_id?: string | null;
     published_at?: string | null;
+    version_id?: string | null;
+    version?: number | null;
+    environment?: 'production' | 'staging';
     /** Present when published: false because of unresolved blockers. */
     reason?: string;
     blockers?: PublishValidationIssue[];
@@ -240,6 +243,24 @@ interface AgentChange {
     undone_at?: string | null;
     [key: string]: any;
 }
+interface AgentTaskCallReturnField {
+    name: string;
+    description: string;
+    type?: 'string' | 'number' | 'boolean';
+}
+interface AgentTaskCallParams {
+    to: string;
+    on_behalf_of: string;
+    instructions: string;
+    return_fields: AgentTaskCallReturnField[];
+    opening_line?: string;
+    from_number?: string;
+}
+interface AgentTaskCallResponse {
+    call_id: string;
+    agent_id: string;
+    status: string;
+}
 declare class AgentsResource {
     private client;
     constructor(client: RymiClient);
@@ -254,6 +275,10 @@ declare class AgentsResource {
      * Retrieve a single AI Agent by its unique ID.
      */
     retrieve(agentId: string): Promise<Agent>;
+    /**
+     * Place a one-shot task call through an opted-in agent.
+     */
+    placeTaskCall(agentId: string, body: AgentTaskCallParams): Promise<AgentTaskCallResponse>;
     /**
      * Create a new AI Agent with a complete system prompt and voice settings.
      */
@@ -308,7 +333,27 @@ declare class AgentsResource {
      * Returns `{ published: false, blockers }` (HTTP 200) when blockers remain —
      * inspect `blockers` rather than relying on a thrown error.
      */
-    publish(agentId: string): Promise<PublishAgentResponse>;
+    publish(agentId: string, body?: {
+        environment?: 'production' | 'staging';
+        label?: string | null;
+    }): Promise<PublishAgentResponse>;
+    listVersions(agentId: string): Promise<{
+        versions: Array<{
+            id: string;
+            version: number;
+            label: string | null;
+            content_hash: string;
+            created_at: string;
+            environments: Array<'production' | 'staging'>;
+        }>;
+        production_version_id: string | null;
+        staging_version_id: string | null;
+    }>;
+    pointEnvironment(agentId: string, environment: 'production' | 'staging', versionId: string): Promise<{
+        environment: 'production' | 'staging';
+        version_id: string;
+        version: number;
+    }>;
     /**
      * Validate and apply a flat-diff change-set against the AgentConfig field registry.
      * Does NOT persist — callers must follow up with update().
@@ -455,6 +500,9 @@ interface CreateCallParams {
     metadata?: Record<string, any>;
     variables?: Record<string, any>;
     post_call?: Record<string, any>;
+    /** Test call (not for publishable keys): marks metadata.source as mcp_test and uses the shared test number when no from_number is set. */
+    test?: boolean;
+    use_test_pool?: boolean;
 }
 interface BatchCallParams {
     agent_id: string;
@@ -1647,4 +1695,4 @@ declare class Rymi {
     withWorkspace(workspace: string): Rymi;
 }
 
-export { type Account, type AccountMember, type AccountRole, type AccountWorkspace, AccountsResource, 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, type CallingRules, CallsResource, type CampaignAttemptListResponse, type CampaignBatch, type CampaignBatchListResponse, type CampaignFollowupJob, type CampaignFollowupListResponse, type CampaignIntake, type CampaignIntakeSettings, type CampaignListResponse, type CampaignMemberListResponse, type CampaignReportResponse, type CampaignRoute, type CampaignRouteListResponse, type CampaignSuggestion, type CampaignSuggestionListResponse, CampaignsResource, type ChangeEntry, type ClientOptions, ComplianceResource, type ComplianceSettings, type ConnectTelephonyParams, type ContactListResponse, ContactsResource, type CreateAgentParams, type CreateCallParams, type CreateCallResponse, type CreateCampaignParams, type CreateCampaignRouteParams, type CreateContactParams, type CreateContactResponse, type CreatePublishableKeyParams, type CreateSecretKeyParams, type CreateWorkspaceParams, type CreatedSecretKey, type DncCheckResult, type DncEntry, type DncListResponse, DncResource, type EnrichCompanyParams, type EnrichCompanyResponse, type FanoutCallParams, type ImportCampaignMembersParams, type ImportCampaignMembersResponse, type ImportContactsParams, type ImportContactsResponse, type ImproveCampaignResponse, type KeySelf, 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 SecretKeyKind, type SetConsentParams, type SetConsentResponse, type TelephonyProvider, TelephonyResource, TemplatesResource, type ToolSecretRecord, ToolSecretsResource, type UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UpdateWorkspaceParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, type WebhookRecord, WebhooksResource, type Workspace, type WorkspaceMember, type WorkspaceUsage, WorkspacesResource, Rymi as default };
+export { type Account, type AccountMember, type AccountRole, type AccountWorkspace, AccountsResource, type AddCampaignMembersParams, type AddKnowledgeSourceParams, type AgentCallListResponse, type AgentChange, type AgentKnowledgeSource, type AgentListResponse, type AgentShareLink, type AgentShareLinkSettings, type AgentTaskCallParams, type AgentTaskCallResponse, type AgentTaskCallReturnField, type AgentTemplateSummary, AgentsResource, type ApplyChangesParams, type ApplyChangesResponse, type AttestParams, type AttestResponse, type Attestation, type BatchCallParams, BillingResource, type CallListResponse, type CallRecord, type CallingRules, CallsResource, type CampaignAttemptListResponse, type CampaignBatch, type CampaignBatchListResponse, type CampaignFollowupJob, type CampaignFollowupListResponse, type CampaignIntake, type CampaignIntakeSettings, type CampaignListResponse, type CampaignMemberListResponse, type CampaignReportResponse, type CampaignRoute, type CampaignRouteListResponse, type CampaignSuggestion, type CampaignSuggestionListResponse, CampaignsResource, type ChangeEntry, type ClientOptions, ComplianceResource, type ComplianceSettings, type ConnectTelephonyParams, type ContactListResponse, ContactsResource, type CreateAgentParams, type CreateCallParams, type CreateCallResponse, type CreateCampaignParams, type CreateCampaignRouteParams, type CreateContactParams, type CreateContactResponse, type CreatePublishableKeyParams, type CreateSecretKeyParams, type CreateWorkspaceParams, type CreatedSecretKey, type DncCheckResult, type DncEntry, type DncListResponse, DncResource, type EnrichCompanyParams, type EnrichCompanyResponse, type FanoutCallParams, type ImportCampaignMembersParams, type ImportCampaignMembersResponse, type ImportContactsParams, type ImportContactsResponse, type ImproveCampaignResponse, type KeySelf, 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 SecretKeyKind, type SetConsentParams, type SetConsentResponse, type TelephonyProvider, TelephonyResource, TemplatesResource, type ToolSecretRecord, ToolSecretsResource, type UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UpdateWorkspaceParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, type WebhookRecord, WebhooksResource, type Workspace, type WorkspaceMember, type WorkspaceUsage, WorkspacesResource, Rymi as default };

package/dist/index.d.ts

@@ -147,6 +147,9 @@ interface PublishAgentResponse {
     /** Present when published — the frozen snapshot id and timestamp. */
     snapshot_id?: string | null;
     published_at?: string | null;
+    version_id?: string | null;
+    version?: number | null;
+    environment?: 'production' | 'staging';
     /** Present when published: false because of unresolved blockers. */
     reason?: string;
     blockers?: PublishValidationIssue[];
@@ -240,6 +243,24 @@ interface AgentChange {
     undone_at?: string | null;
     [key: string]: any;
 }
+interface AgentTaskCallReturnField {
+    name: string;
+    description: string;
+    type?: 'string' | 'number' | 'boolean';
+}
+interface AgentTaskCallParams {
+    to: string;
+    on_behalf_of: string;
+    instructions: string;
+    return_fields: AgentTaskCallReturnField[];
+    opening_line?: string;
+    from_number?: string;
+}
+interface AgentTaskCallResponse {
+    call_id: string;
+    agent_id: string;
+    status: string;
+}
 declare class AgentsResource {
     private client;
     constructor(client: RymiClient);
@@ -254,6 +275,10 @@ declare class AgentsResource {
      * Retrieve a single AI Agent by its unique ID.
      */
     retrieve(agentId: string): Promise<Agent>;
+    /**
+     * Place a one-shot task call through an opted-in agent.
+     */
+    placeTaskCall(agentId: string, body: AgentTaskCallParams): Promise<AgentTaskCallResponse>;
     /**
      * Create a new AI Agent with a complete system prompt and voice settings.
      */
@@ -308,7 +333,27 @@ declare class AgentsResource {
      * Returns `{ published: false, blockers }` (HTTP 200) when blockers remain —
      * inspect `blockers` rather than relying on a thrown error.
      */
-    publish(agentId: string): Promise<PublishAgentResponse>;
+    publish(agentId: string, body?: {
+        environment?: 'production' | 'staging';
+        label?: string | null;
+    }): Promise<PublishAgentResponse>;
+    listVersions(agentId: string): Promise<{
+        versions: Array<{
+            id: string;
+            version: number;
+            label: string | null;
+            content_hash: string;
+            created_at: string;
+            environments: Array<'production' | 'staging'>;
+        }>;
+        production_version_id: string | null;
+        staging_version_id: string | null;
+    }>;
+    pointEnvironment(agentId: string, environment: 'production' | 'staging', versionId: string): Promise<{
+        environment: 'production' | 'staging';
+        version_id: string;
+        version: number;
+    }>;
     /**
      * Validate and apply a flat-diff change-set against the AgentConfig field registry.
      * Does NOT persist — callers must follow up with update().
@@ -455,6 +500,9 @@ interface CreateCallParams {
     metadata?: Record<string, any>;
     variables?: Record<string, any>;
     post_call?: Record<string, any>;
+    /** Test call (not for publishable keys): marks metadata.source as mcp_test and uses the shared test number when no from_number is set. */
+    test?: boolean;
+    use_test_pool?: boolean;
 }
 interface BatchCallParams {
     agent_id: string;
@@ -1647,4 +1695,4 @@ declare class Rymi {
     withWorkspace(workspace: string): Rymi;
 }
 
-export { type Account, type AccountMember, type AccountRole, type AccountWorkspace, AccountsResource, 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, type CallingRules, CallsResource, type CampaignAttemptListResponse, type CampaignBatch, type CampaignBatchListResponse, type CampaignFollowupJob, type CampaignFollowupListResponse, type CampaignIntake, type CampaignIntakeSettings, type CampaignListResponse, type CampaignMemberListResponse, type CampaignReportResponse, type CampaignRoute, type CampaignRouteListResponse, type CampaignSuggestion, type CampaignSuggestionListResponse, CampaignsResource, type ChangeEntry, type ClientOptions, ComplianceResource, type ComplianceSettings, type ConnectTelephonyParams, type ContactListResponse, ContactsResource, type CreateAgentParams, type CreateCallParams, type CreateCallResponse, type CreateCampaignParams, type CreateCampaignRouteParams, type CreateContactParams, type CreateContactResponse, type CreatePublishableKeyParams, type CreateSecretKeyParams, type CreateWorkspaceParams, type CreatedSecretKey, type DncCheckResult, type DncEntry, type DncListResponse, DncResource, type EnrichCompanyParams, type EnrichCompanyResponse, type FanoutCallParams, type ImportCampaignMembersParams, type ImportCampaignMembersResponse, type ImportContactsParams, type ImportContactsResponse, type ImproveCampaignResponse, type KeySelf, 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 SecretKeyKind, type SetConsentParams, type SetConsentResponse, type TelephonyProvider, TelephonyResource, TemplatesResource, type ToolSecretRecord, ToolSecretsResource, type UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UpdateWorkspaceParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, type WebhookRecord, WebhooksResource, type Workspace, type WorkspaceMember, type WorkspaceUsage, WorkspacesResource, Rymi as default };
+export { type Account, type AccountMember, type AccountRole, type AccountWorkspace, AccountsResource, type AddCampaignMembersParams, type AddKnowledgeSourceParams, type AgentCallListResponse, type AgentChange, type AgentKnowledgeSource, type AgentListResponse, type AgentShareLink, type AgentShareLinkSettings, type AgentTaskCallParams, type AgentTaskCallResponse, type AgentTaskCallReturnField, type AgentTemplateSummary, AgentsResource, type ApplyChangesParams, type ApplyChangesResponse, type AttestParams, type AttestResponse, type Attestation, type BatchCallParams, BillingResource, type CallListResponse, type CallRecord, type CallingRules, CallsResource, type CampaignAttemptListResponse, type CampaignBatch, type CampaignBatchListResponse, type CampaignFollowupJob, type CampaignFollowupListResponse, type CampaignIntake, type CampaignIntakeSettings, type CampaignListResponse, type CampaignMemberListResponse, type CampaignReportResponse, type CampaignRoute, type CampaignRouteListResponse, type CampaignSuggestion, type CampaignSuggestionListResponse, CampaignsResource, type ChangeEntry, type ClientOptions, ComplianceResource, type ComplianceSettings, type ConnectTelephonyParams, type ContactListResponse, ContactsResource, type CreateAgentParams, type CreateCallParams, type CreateCallResponse, type CreateCampaignParams, type CreateCampaignRouteParams, type CreateContactParams, type CreateContactResponse, type CreatePublishableKeyParams, type CreateSecretKeyParams, type CreateWorkspaceParams, type CreatedSecretKey, type DncCheckResult, type DncEntry, type DncListResponse, DncResource, type EnrichCompanyParams, type EnrichCompanyResponse, type FanoutCallParams, type ImportCampaignMembersParams, type ImportCampaignMembersResponse, type ImportContactsParams, type ImportContactsResponse, type ImproveCampaignResponse, type KeySelf, 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 SecretKeyKind, type SetConsentParams, type SetConsentResponse, type TelephonyProvider, TelephonyResource, TemplatesResource, type ToolSecretRecord, ToolSecretsResource, type UpdateAgentParams, type UpdateCampaignMemberParams, type UpdateCampaignParams, type UpdateCampaignRouteParams, type UpdateContactParams, type UpdateWorkspaceParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, type WebhookRecord, WebhooksResource, type Workspace, type WorkspaceMember, type WorkspaceUsage, WorkspacesResource, Rymi as default };

package/dist/index.js

@@ -159,6 +159,12 @@ var AgentsResource = class {
   async retrieve(agentId) {
     return this.client.get(`/agents/${agentId}`);
   }
+  /**
+   * Place a one-shot task call through an opted-in agent.
+   */
+  async placeTaskCall(agentId, body) {
+    return this.client.post(`/agents/${agentId}/task-calls`, body);
+  }
   /**
    * Create a new AI Agent with a complete system prompt and voice settings.
    */
@@ -213,8 +219,14 @@ var AgentsResource = class {
    * Returns `{ published: false, blockers }` (HTTP 200) when blockers remain —
    * inspect `blockers` rather than relying on a thrown error.
    */
-  async publish(agentId) {
-    return this.client.post(`/agents/${agentId}/publish`, {});
+  async publish(agentId, body = {}) {
+    return this.client.post(`/agents/${agentId}/publish`, body);
+  }
+  async listVersions(agentId) {
+    return this.client.get(`/agents/${agentId}/versions`);
+  }
+  async pointEnvironment(agentId, environment, versionId) {
+    return this.client.post(`/agents/${agentId}/environments/${environment}`, { version_id: versionId });
   }
   /**
    * Validate and apply a flat-diff change-set against the AgentConfig field registry.