@rymi/node 2.4.0 → 2.5.0

package/README.md

@@ -74,15 +74,15 @@ The client exposes one namespace per resource group:
 | `numbers` | Register and attach phone numbers |
 | `telephony` | Inspect carrier status and provisioned numbers |
 | `keys` | Manage publishable keys |
-| `billing` | Usage summaries and balance |
+| `billing` | Usage summaries, balance, and `setCountry` (billing country, locked after the first paid invoice) |
 | `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) |
+| `compliance` | Attestations, plus workspace settings: `getSettings`, `updateSettings`, `previewSettings` |
 | `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. |
+| `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`), or call `withWorkspace(id)`, to act in one of them. |
 
 ## 📖 Documentation
 

package/dist/index.d.mts

@@ -877,6 +877,11 @@ declare class BillingResource {
     }): Promise<{
         ok: true;
     }>;
+    /** Set the billing country. Locked after the first paid invoice (409 billing_country_locked). */
+    setCountry(billingCountry: string): Promise<{
+        ok: true;
+        billing_country: string;
+    }>;
 }
 
 interface AgentTemplateSummary {
@@ -1372,6 +1377,28 @@ interface AttestResponse {
 interface ListAttestationsResponse {
     attestations: Attestation[];
 }
+interface CallingRules {
+    /** Callee-local hours; null = any hour. */
+    calling_hours: {
+        start_hour: number;
+        end_hour: number;
+    } | null;
+    dnc_check: boolean;
+    require_voice_consent: boolean;
+    /** Recording notice default for new agents. */
+    recording_notice: boolean;
+    /** null = every supported country. */
+    destination_countries: string[] | null;
+    apply_to_single_calls: boolean;
+}
+interface ComplianceSettings {
+    operating_country: string | null;
+    configured: boolean;
+    inherited_from: string | null;
+    rules: CallingRules;
+    edited: Array<keyof CallingRules>;
+    presets: Record<string, CallingRules>;
+}
 declare class ComplianceResource {
     private client;
     constructor(client: RymiClient);
@@ -1380,6 +1407,22 @@ declare class ComplianceResource {
     attest(data: AttestParams): Promise<AttestResponse>;
     /** List the tenant's 50 most recent compliance attestations, newest first. */
     listAttestations(): Promise<ListAttestationsResponse>;
+    /** The workspace's compliance settings, with every country preset. */
+    getSettings(): Promise<ComplianceSettings>;
+    /** Choosing operating_country fills every setting you haven't edited from its preset. */
+    updateSettings(data: {
+        operating_country?: string | null;
+        rules?: Partial<CallingRules>;
+    }): Promise<ComplianceSettings>;
+    /** What choosing a country would change, before saving. */
+    previewSettings(country: string): Promise<{
+        country: string;
+        changes: Array<{
+            key: keyof CallingRules;
+            from: unknown;
+            to: unknown;
+        }>;
+    }>;
 }
 
 /** A stored API-tool secret. Values are write-only — never returned. */
@@ -1485,6 +1528,7 @@ declare class WorkspacesResource {
 
 declare class Rymi {
     private client;
+    private options?;
     agents: AgentsResource;
     calls: CallsResource;
     dnc: DncResource;
@@ -1500,6 +1544,8 @@ declare class Rymi {
     toolSecrets: ToolSecretsResource;
     workspaces: WorkspacesResource;
     constructor(options?: ClientOptions);
+    /** The same client acting in another workspace: `rymi.withWorkspace(id).calls.create(…)`. */
+    withWorkspace(workspace: string): Rymi;
 }
 
-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 };
+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, 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 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

@@ -877,6 +877,11 @@ declare class BillingResource {
     }): Promise<{
         ok: true;
     }>;
+    /** Set the billing country. Locked after the first paid invoice (409 billing_country_locked). */
+    setCountry(billingCountry: string): Promise<{
+        ok: true;
+        billing_country: string;
+    }>;
 }
 
 interface AgentTemplateSummary {
@@ -1372,6 +1377,28 @@ interface AttestResponse {
 interface ListAttestationsResponse {
     attestations: Attestation[];
 }
+interface CallingRules {
+    /** Callee-local hours; null = any hour. */
+    calling_hours: {
+        start_hour: number;
+        end_hour: number;
+    } | null;
+    dnc_check: boolean;
+    require_voice_consent: boolean;
+    /** Recording notice default for new agents. */
+    recording_notice: boolean;
+    /** null = every supported country. */
+    destination_countries: string[] | null;
+    apply_to_single_calls: boolean;
+}
+interface ComplianceSettings {
+    operating_country: string | null;
+    configured: boolean;
+    inherited_from: string | null;
+    rules: CallingRules;
+    edited: Array<keyof CallingRules>;
+    presets: Record<string, CallingRules>;
+}
 declare class ComplianceResource {
     private client;
     constructor(client: RymiClient);
@@ -1380,6 +1407,22 @@ declare class ComplianceResource {
     attest(data: AttestParams): Promise<AttestResponse>;
     /** List the tenant's 50 most recent compliance attestations, newest first. */
     listAttestations(): Promise<ListAttestationsResponse>;
+    /** The workspace's compliance settings, with every country preset. */
+    getSettings(): Promise<ComplianceSettings>;
+    /** Choosing operating_country fills every setting you haven't edited from its preset. */
+    updateSettings(data: {
+        operating_country?: string | null;
+        rules?: Partial<CallingRules>;
+    }): Promise<ComplianceSettings>;
+    /** What choosing a country would change, before saving. */
+    previewSettings(country: string): Promise<{
+        country: string;
+        changes: Array<{
+            key: keyof CallingRules;
+            from: unknown;
+            to: unknown;
+        }>;
+    }>;
 }
 
 /** A stored API-tool secret. Values are write-only — never returned. */
@@ -1485,6 +1528,7 @@ declare class WorkspacesResource {
 
 declare class Rymi {
     private client;
+    private options?;
     agents: AgentsResource;
     calls: CallsResource;
     dnc: DncResource;
@@ -1500,6 +1544,8 @@ declare class Rymi {
     toolSecrets: ToolSecretsResource;
     workspaces: WorkspacesResource;
     constructor(options?: ClientOptions);
+    /** The same client acting in another workspace: `rymi.withWorkspace(id).calls.create(…)`. */
+    withWorkspace(workspace: string): Rymi;
 }
 
-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 };
+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, 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 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

@@ -601,6 +601,10 @@ var BillingResource = class {
   async setAlerts(data) {
     return this.client.put("/billing/alerts", data);
   }
+  /** Set the billing country. Locked after the first paid invoice (409 billing_country_locked). */
+  async setCountry(billingCountry) {
+    return this.client.put("/billing/country", { billing_country: billingCountry });
+  }
 };
 
 // src/resources/templates.ts
@@ -843,6 +847,18 @@ var ComplianceResource = class {
   async listAttestations() {
     return this.client.get("/compliance/attestations");
   }
+  /** The workspace's compliance settings, with every country preset. */
+  async getSettings() {
+    return this.client.get("/compliance/settings");
+  }
+  /** Choosing operating_country fills every setting you haven't edited from its preset. */
+  async updateSettings(data) {
+    return this.client.put("/compliance/settings", data);
+  }
+  /** What choosing a country would change, before saving. */
+  async previewSettings(country) {
+    return this.client.get(`/compliance/settings/preview?country=${encodeURIComponent(country)}`);
+  }
 };
 
 // src/resources/toolSecrets.ts
@@ -895,8 +911,9 @@ var WorkspacesResource = class {
 
 // src/index.ts
 __reExport(index_exports, require("@rymi/sdk-types"), module.exports);
-var Rymi = class {
+var Rymi = class _Rymi {
   client;
+  options;
   agents;
   calls;
   dnc;
@@ -912,6 +929,7 @@ var Rymi = class {
   toolSecrets;
   workspaces;
   constructor(options) {
+    this.options = options;
     this.client = new RymiClient(options);
     this.agents = new AgentsResource(this.client);
     this.calls = new CallsResource(this.client);
@@ -928,6 +946,10 @@ var Rymi = class {
     this.toolSecrets = new ToolSecretsResource(this.client);
     this.workspaces = new WorkspacesResource(this.client);
   }
+  /** The same client acting in another workspace: `rymi.withWorkspace(id).calls.create(…)`. */
+  withWorkspace(workspace) {
+    return new _Rymi({ ...this.options, workspace });
+  }
 };
 var index_default = Rymi;
 // Annotate the CommonJS export names for ESM import in node: