@rymi/node 2.2.0 → 2.4.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({
@@ -79,6 +82,7 @@ The client exposes one namespace per resource group:
 | `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 update workspaces, including client workspaces (`create({ name, parent })`) that your agency pays for, with a monthly `spend_cap_cents_monthly`. `usage(id, { month })` for invoicing; `listMembers`, `addMember`, `removeMember`. Pass `workspace` (or `RYMI_WORKSPACE`) to act in one of them. |
 
 ## 📖 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>;
@@ -1408,6 +1414,75 @@ declare class ToolSecretsResource {
     }>;
 }
 
+interface Workspace {
+    id: string;
+    name: string;
+    role: 'owner' | 'admin' | 'client';
+    /** The agency, for a client workspace. */
+    parent_id: string | null;
+    operating_country: string | null;
+    /** Client workspaces only; absent for the client role. */
+    spend_cap_cents_monthly?: number | null;
+    current?: boolean;
+}
+interface CreateWorkspaceParams {
+    name: string;
+    /** ISO-3166 alpha-2, e.g. "IN". */
+    operating_country?: string | null;
+    /** An agency workspace you run: makes this a client workspace that the agency pays for. */
+    parent?: string;
+}
+interface UpdateWorkspaceParams {
+    name?: string;
+    operating_country?: string | null;
+    /** Client workspaces only. Credits per calendar month (1 credit = $0.01); null removes the cap. */
+    spend_cap_cents_monthly?: number | null;
+}
+interface WorkspaceUsage {
+    workspace_id: string;
+    /** YYYY-MM, UTC. */
+    month: string;
+    calls: number;
+    minutes: number;
+    /** Left out for the client role. */
+    credits?: number;
+}
+interface WorkspaceMember {
+    user_id: string;
+    email: string | null;
+    role: 'owner' | 'admin' | 'client';
+}
+declare class WorkspacesResource {
+    private client;
+    constructor(client: RymiClient);
+    list(): Promise<{
+        workspaces: Workspace[];
+    }>;
+    create(data: CreateWorkspaceParams): Promise<{
+        workspace: Workspace;
+    }>;
+    update(id: string, data: UpdateWorkspaceParams): Promise<{
+        ok: true;
+    }>;
+    /** Calls, minutes and credits for one month (default: this month, UTC). */
+    usage(id: string, params?: {
+        month?: string;
+    }): Promise<WorkspaceUsage>;
+    listMembers(id: string): Promise<{
+        members: WorkspaceMember[];
+    }>;
+    /** Someone without a Rymi account gets an invite email. Client workspaces take the client role. */
+    addMember(id: string, data: {
+        email: string;
+        role?: 'admin' | 'client';
+    }): Promise<{
+        member: WorkspaceMember;
+    }>;
+    removeMember(id: string, userId: string): Promise<{
+        ok: true;
+    }>;
+}
+
 declare class Rymi {
     private client;
     agents: AgentsResource;
@@ -1423,7 +1498,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 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 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 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

@@ -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>;
@@ -1408,6 +1414,75 @@ declare class ToolSecretsResource {
     }>;
 }
 
+interface Workspace {
+    id: string;
+    name: string;
+    role: 'owner' | 'admin' | 'client';
+    /** The agency, for a client workspace. */
+    parent_id: string | null;
+    operating_country: string | null;
+    /** Client workspaces only; absent for the client role. */
+    spend_cap_cents_monthly?: number | null;
+    current?: boolean;
+}
+interface CreateWorkspaceParams {
+    name: string;
+    /** ISO-3166 alpha-2, e.g. "IN". */
+    operating_country?: string | null;
+    /** An agency workspace you run: makes this a client workspace that the agency pays for. */
+    parent?: string;
+}
+interface UpdateWorkspaceParams {
+    name?: string;
+    operating_country?: string | null;
+    /** Client workspaces only. Credits per calendar month (1 credit = $0.01); null removes the cap. */
+    spend_cap_cents_monthly?: number | null;
+}
+interface WorkspaceUsage {
+    workspace_id: string;
+    /** YYYY-MM, UTC. */
+    month: string;
+    calls: number;
+    minutes: number;
+    /** Left out for the client role. */
+    credits?: number;
+}
+interface WorkspaceMember {
+    user_id: string;
+    email: string | null;
+    role: 'owner' | 'admin' | 'client';
+}
+declare class WorkspacesResource {
+    private client;
+    constructor(client: RymiClient);
+    list(): Promise<{
+        workspaces: Workspace[];
+    }>;
+    create(data: CreateWorkspaceParams): Promise<{
+        workspace: Workspace;
+    }>;
+    update(id: string, data: UpdateWorkspaceParams): Promise<{
+        ok: true;
+    }>;
+    /** Calls, minutes and credits for one month (default: this month, UTC). */
+    usage(id: string, params?: {
+        month?: string;
+    }): Promise<WorkspaceUsage>;
+    listMembers(id: string): Promise<{
+        members: WorkspaceMember[];
+    }>;
+    /** Someone without a Rymi account gets an invite email. Client workspaces take the client role. */
+    addMember(id: string, data: {
+        email: string;
+        role?: 'admin' | 'client';
+    }): Promise<{
+        member: WorkspaceMember;
+    }>;
+    removeMember(id: string, userId: string): Promise<{
+        ok: true;
+    }>;
+}
+
 declare class Rymi {
     private client;
     agents: AgentsResource;
@@ -1423,7 +1498,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 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 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 UpdateWorkspaceParams, type UsageSummary, type ValidatePublishParams, type WebhookProvisionResult, type WebhookRecord, WebhooksResource, type Workspace, type WorkspaceMember, type WorkspaceUsage, 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
@@ -858,6 +862,37 @@ 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);
+  }
+  /** Calls, minutes and credits for one month (default: this month, UTC). */
+  async usage(id, params = {}) {
+    const query = params.month ? `?month=${encodeURIComponent(params.month)}` : "";
+    return this.client.get(`/workspaces/${encodeURIComponent(id)}/usage${query}`);
+  }
+  async listMembers(id) {
+    return this.client.get(`/workspaces/${encodeURIComponent(id)}/members`);
+  }
+  /** Someone without a Rymi account gets an invite email. Client workspaces take the client role. */
+  async addMember(id, data) {
+    return this.client.post(`/workspaces/${encodeURIComponent(id)}/members`, data);
+  }
+  async removeMember(id, userId) {
+    return this.client.delete(`/workspaces/${encodeURIComponent(id)}/members/${encodeURIComponent(userId)}`);
+  }
+};
+
 // src/index.ts
 __reExport(index_exports, require("@rymi/sdk-types"), module.exports);
 var Rymi = class {
@@ -875,6 +910,7 @@ var Rymi = class {
   contacts;
   compliance;
   toolSecrets;
+  workspaces;
   constructor(options) {
     this.client = new RymiClient(options);
     this.agents = new AgentsResource(this.client);
@@ -890,6 +926,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;
@@ -911,6 +948,7 @@ var index_default = Rymi;
   TemplatesResource,
   ToolSecretsResource,
   WebhooksResource,
+  WorkspacesResource,
   ...require("@rymi/sdk-types")
 });
 //# sourceMappingURL=index.js.map