@rymi/node 2.1.0 → 2.3.0

package/README.md

@@ -43,6 +43,9 @@ yarn add @rymi/node
 import { Rymi } from '@rymi/node';
 
 const rymi = new Rymi({ apiKey: process.env.RYMI_API_KEY });
+// Optional: act in another workspace you can reach.
+// const rymi = new Rymi({ apiKey: process.env.RYMI_API_KEY, workspace: 'workspace-id' });
+// Or set RYMI_WORKSPACE. The client sends it as the Rymi-Workspace header.
 
 // Create a voice agent
 const agent = await rymi.agents.create({
@@ -75,6 +78,11 @@ The client exposes one namespace per resource group:
 | `templates` | Prebuilt agent templates |
 | `webhooks` | Create webhooks and verify incoming signatures |
 | `dnc` | Do-not-call list management |
+| `campaigns` | Outbound/inbound calling campaigns: members, launch/pause, reports, improvement suggestions, inbound routes, and the lead-intake URL (`campaigns.intake`) |
+| `contacts` | Contacts and per-channel consent |
+| `compliance` | Compliance attestations (e.g. an external DNC scrub) |
+| `toolSecrets` | Secrets for API-tool headers, referenced as `{{secrets.NAME}}` |
+| `workspaces` | List, create and rename workspaces. Pass `workspace` (or `RYMI_WORKSPACE`) to act in one of them. A workspace you create does not get the free monthly credit. You can own at most 20. |
 
 ## 📖 Documentation
 

package/dist/index.d.mts

@@ -15,6 +15,11 @@ interface ClientOptions {
      * network socket (e.g. Fastify app.inject). Defaults to global fetch.
      */
     fetch?: typeof globalThis.fetch;
+    /**
+     * Act in this workspace (sent as `Rymi-Workspace`). Defaults to the
+     * `RYMI_WORKSPACE` environment variable, else the key's own workspace.
+     */
+    workspace?: string;
 }
 declare class RymiError extends Error {
     status?: number;
@@ -25,6 +30,7 @@ declare class RymiClient {
     private apiKey;
     private baseURL;
     private fetchImpl;
+    private workspace?;
     constructor(options?: ClientOptions);
     private request;
     get<T>(path: string): Promise<T>;
@@ -1149,10 +1155,46 @@ interface CampaignSuggestionListResponse {
     offset: number;
     limit: number;
 }
+/** A campaign's lead-intake URL settings. The URL itself is only returned on create/rotate. */
+interface CampaignIntake {
+    enabled: true;
+    assume_voice_consent: boolean;
+    default_country: string | null;
+    created_at: string;
+    rotated_at: string;
+    last_used_at: string | null;
+}
+interface CampaignIntakeSettings {
+    /** Treat every lead posted to the URL as having voice consent (e.g. a subscribe form with a consent line). */
+    assume_voice_consent?: boolean;
+    /** ISO-3166 alpha-2 (e.g. "IN") used for numbers posted without a +country code. */
+    default_country?: string | null;
+}
+declare class CampaignIntakeResource {
+    private client;
+    constructor(client: RymiClient);
+    /** Get the campaign's lead-intake settings, or `intake: null` if it has none. */
+    get(campaignId: string): Promise<{
+        intake: CampaignIntake | null;
+    }>;
+    /** Create the lead-intake URL (returned once as `url`), or update its settings (`url: null`). */
+    set(campaignId: string, settings?: CampaignIntakeSettings): Promise<{
+        intake: CampaignIntake;
+        url: string | null;
+    }>;
+    /** Issue a new URL. The old one stops accepting leads immediately. */
+    rotate(campaignId: string): Promise<{
+        intake: CampaignIntake;
+        url: string;
+    }>;
+    /** Remove the lead-intake URL. */
+    disable(campaignId: string): Promise<void>;
+}
 declare class CampaignsResource {
     private client;
     members: CampaignMembersResource;
     routes: CampaignRoutesResource;
+    intake: CampaignIntakeResource;
     constructor(client: RymiClient);
     /** List campaigns for the authenticated tenant, paginated. */
     list(params?: ListCampaignsParams): Promise<CampaignListResponse>;
@@ -1372,6 +1414,36 @@ declare class ToolSecretsResource {
     }>;
 }
 
+interface Workspace {
+    id: string;
+    name: string;
+    role: 'owner' | 'admin' | 'client';
+    parent_id: string | null;
+    operating_country: string | null;
+    current?: boolean;
+}
+interface CreateWorkspaceParams {
+    name: string;
+    /** ISO-3166 alpha-2, e.g. "IN". */
+    operating_country?: string | null;
+}
+declare class WorkspacesResource {
+    private client;
+    constructor(client: RymiClient);
+    list(): Promise<{
+        workspaces: Workspace[];
+    }>;
+    create(data: CreateWorkspaceParams): Promise<{
+        workspace: Workspace;
+    }>;
+    update(id: string, data: {
+        name?: string;
+        operating_country?: string | null;
+    }): Promise<{
+        ok: true;
+    }>;
+}
+
 declare class Rymi {
     private client;
     agents: AgentsResource;
@@ -1387,7 +1459,8 @@ declare class Rymi {
     contacts: ContactsResource;
     compliance: ComplianceResource;
     toolSecrets: ToolSecretsResource;
+    workspaces: WorkspacesResource;
     constructor(options?: ClientOptions);
 }
 
-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 };
+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 CampaignIntake, type CampaignIntakeSettings, 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 CreateWorkspaceParams, 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, type Workspace, WorkspacesResource, Rymi as default };

package/dist/index.d.ts

@@ -15,6 +15,11 @@ interface ClientOptions {
      * network socket (e.g. Fastify app.inject). Defaults to global fetch.
      */
     fetch?: typeof globalThis.fetch;
+    /**
+     * Act in this workspace (sent as `Rymi-Workspace`). Defaults to the
+     * `RYMI_WORKSPACE` environment variable, else the key's own workspace.
+     */
+    workspace?: string;
 }
 declare class RymiError extends Error {
     status?: number;
@@ -25,6 +30,7 @@ declare class RymiClient {
     private apiKey;
     private baseURL;
     private fetchImpl;
+    private workspace?;
     constructor(options?: ClientOptions);
     private request;
     get<T>(path: string): Promise<T>;
@@ -1149,10 +1155,46 @@ interface CampaignSuggestionListResponse {
     offset: number;
     limit: number;
 }
+/** A campaign's lead-intake URL settings. The URL itself is only returned on create/rotate. */
+interface CampaignIntake {
+    enabled: true;
+    assume_voice_consent: boolean;
+    default_country: string | null;
+    created_at: string;
+    rotated_at: string;
+    last_used_at: string | null;
+}
+interface CampaignIntakeSettings {
+    /** Treat every lead posted to the URL as having voice consent (e.g. a subscribe form with a consent line). */
+    assume_voice_consent?: boolean;
+    /** ISO-3166 alpha-2 (e.g. "IN") used for numbers posted without a +country code. */
+    default_country?: string | null;
+}
+declare class CampaignIntakeResource {
+    private client;
+    constructor(client: RymiClient);
+    /** Get the campaign's lead-intake settings, or `intake: null` if it has none. */
+    get(campaignId: string): Promise<{
+        intake: CampaignIntake | null;
+    }>;
+    /** Create the lead-intake URL (returned once as `url`), or update its settings (`url: null`). */
+    set(campaignId: string, settings?: CampaignIntakeSettings): Promise<{
+        intake: CampaignIntake;
+        url: string | null;
+    }>;
+    /** Issue a new URL. The old one stops accepting leads immediately. */
+    rotate(campaignId: string): Promise<{
+        intake: CampaignIntake;
+        url: string;
+    }>;
+    /** Remove the lead-intake URL. */
+    disable(campaignId: string): Promise<void>;
+}
 declare class CampaignsResource {
     private client;
     members: CampaignMembersResource;
     routes: CampaignRoutesResource;
+    intake: CampaignIntakeResource;
     constructor(client: RymiClient);
     /** List campaigns for the authenticated tenant, paginated. */
     list(params?: ListCampaignsParams): Promise<CampaignListResponse>;
@@ -1372,6 +1414,36 @@ declare class ToolSecretsResource {
     }>;
 }
 
+interface Workspace {
+    id: string;
+    name: string;
+    role: 'owner' | 'admin' | 'client';
+    parent_id: string | null;
+    operating_country: string | null;
+    current?: boolean;
+}
+interface CreateWorkspaceParams {
+    name: string;
+    /** ISO-3166 alpha-2, e.g. "IN". */
+    operating_country?: string | null;
+}
+declare class WorkspacesResource {
+    private client;
+    constructor(client: RymiClient);
+    list(): Promise<{
+        workspaces: Workspace[];
+    }>;
+    create(data: CreateWorkspaceParams): Promise<{
+        workspace: Workspace;
+    }>;
+    update(id: string, data: {
+        name?: string;
+        operating_country?: string | null;
+    }): Promise<{
+        ok: true;
+    }>;
+}
+
 declare class Rymi {
     private client;
     agents: AgentsResource;
@@ -1387,7 +1459,8 @@ declare class Rymi {
     contacts: ContactsResource;
     compliance: ComplianceResource;
     toolSecrets: ToolSecretsResource;
+    workspaces: WorkspacesResource;
     constructor(options?: ClientOptions);
 }
 
-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 };
+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 CampaignIntake, type CampaignIntakeSettings, 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 CreateWorkspaceParams, 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, type Workspace, WorkspacesResource, Rymi as default };

package/dist/index.js

@@ -47,6 +47,7 @@ __export(index_exports, {
   TemplatesResource: () => TemplatesResource,
   ToolSecretsResource: () => ToolSecretsResource,
   WebhooksResource: () => WebhooksResource,
+  WorkspacesResource: () => WorkspacesResource,
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
@@ -66,6 +67,7 @@ var RymiClient = class {
   apiKey;
   baseURL;
   fetchImpl;
+  workspace;
   constructor(options) {
     const key = options?.apiKey || (typeof process !== "undefined" ? process.env.RYMI_API_KEY : void 0);
     if (!key) {
@@ -77,6 +79,7 @@ var RymiClient = class {
     if (this.baseURL.endsWith("/")) {
       this.baseURL = this.baseURL.slice(0, -1);
     }
+    this.workspace = options?.workspace || (typeof process !== "undefined" ? process.env.RYMI_WORKSPACE : void 0) || void 0;
   }
   async request(method, path, body) {
     const url = `${this.baseURL}${path.startsWith("/") ? path : `/${path}`}`;
@@ -85,6 +88,7 @@ var RymiClient = class {
       "Accept": "application/json",
       "User-Agent": "rymi-node/1.0.0"
     };
+    if (this.workspace) headers["Rymi-Workspace"] = this.workspace;
     const init = {
       method,
       headers
@@ -668,14 +672,37 @@ var CampaignRoutesResource = class {
     return this.client.delete(`/campaigns/${campaignId}/routes/${routeId}`);
   }
 };
+var CampaignIntakeResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get the campaign's lead-intake settings, or `intake: null` if it has none. */
+  async get(campaignId) {
+    return this.client.get(`/campaigns/${campaignId}/intake`);
+  }
+  /** Create the lead-intake URL (returned once as `url`), or update its settings (`url: null`). */
+  async set(campaignId, settings = {}) {
+    return this.client.put(`/campaigns/${campaignId}/intake`, settings);
+  }
+  /** Issue a new URL. The old one stops accepting leads immediately. */
+  async rotate(campaignId) {
+    return this.client.post(`/campaigns/${campaignId}/intake/rotate`, {});
+  }
+  /** Remove the lead-intake URL. */
+  async disable(campaignId) {
+    return this.client.delete(`/campaigns/${campaignId}/intake`);
+  }
+};
 var CampaignsResource = class {
   constructor(client) {
     this.client = client;
     this.members = new CampaignMembersResource(client);
     this.routes = new CampaignRoutesResource(client);
+    this.intake = new CampaignIntakeResource(client);
   }
   members;
   routes;
+  intake;
   /** List campaigns for the authenticated tenant, paginated. */
   async list(params = {}) {
     return this.client.get(`/campaigns${buildQuery4(params)}`);
@@ -835,6 +862,22 @@ var ToolSecretsResource = class {
   }
 };
 
+// src/resources/workspaces.ts
+var WorkspacesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list() {
+    return this.client.get("/workspaces");
+  }
+  async create(data) {
+    return this.client.post("/workspaces", data);
+  }
+  async update(id, data) {
+    return this.client.patch(`/workspaces/${encodeURIComponent(id)}`, data);
+  }
+};
+
 // src/index.ts
 __reExport(index_exports, require("@rymi/sdk-types"), module.exports);
 var Rymi = class {
@@ -852,6 +895,7 @@ var Rymi = class {
   contacts;
   compliance;
   toolSecrets;
+  workspaces;
   constructor(options) {
     this.client = new RymiClient(options);
     this.agents = new AgentsResource(this.client);
@@ -867,6 +911,7 @@ var Rymi = class {
     this.contacts = new ContactsResource(this.client);
     this.compliance = new ComplianceResource(this.client);
     this.toolSecrets = new ToolSecretsResource(this.client);
+    this.workspaces = new WorkspacesResource(this.client);
   }
 };
 var index_default = Rymi;
@@ -888,6 +933,7 @@ var index_default = Rymi;
   TemplatesResource,
   ToolSecretsResource,
   WebhooksResource,
+  WorkspacesResource,
   ...require("@rymi/sdk-types")
 });
 //# sourceMappingURL=index.js.map