nixflex 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0
+
+- New: `client.storage` - connect your own S3-compatible bucket for call recordings (data residency). `storage.set()` verifies with a probe write before saving, `storage.get()` never returns the secret, `storage.delete()` disconnects. Recordings then upload to your bucket and `recording_url` becomes a `byo:` path. See https://docs.nixflex.com/advanced/your-own-storage
+
 ## 0.3.1 (2026-08-24)
 
 - Voicemail as a structured setting: `voicemail_leave_enabled` + `voicemail_message` on Agent (applies to dashboard-imported numbers) and on PhoneNumber / PhoneNumberUpdateParams (the only voicemail control for API-imported numbers - no inheritance across the two worlds)

package/dist/index.cjs

@@ -465,6 +465,28 @@ var UsageResource = class {
     return this.http.request("GET", "/usage", void 0, void 0, opts);
   }
 };
+var Storage = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Connect your own S3-compatible bucket for call recordings (data residency).
+   * The connection is verified with a probe write BEFORE saving - broken
+   * credentials are rejected, never stored. Recordings then upload to your
+   * bucket and Nixflex keeps no copy; recording_url becomes a byo: path. */
+  set(params, opts) {
+    return this.http.request("PUT", "/account/storage", params, void 0, opts);
+  }
+  /** Current storage configuration. The secret is never included. */
+  get(opts) {
+    return this.http.request("GET", "/account/storage", void 0, void 0, opts);
+  }
+  /** Disconnect and clear. Recordings return to Nixflex EU storage from the
+   * next call; files already in your bucket are untouched - they are yours. */
+  delete(opts) {
+    return this.http.request("DELETE", "/account/storage", void 0, void 0, opts);
+  }
+};
 var Webhooks = class {
   constructor(http) {
     this.http = http;
@@ -512,6 +534,8 @@ var Nixflex = class {
   usage;
   /** Per-number post-call webhook configuration. */
   webhooks;
+  /** Your own S3-compatible recording storage (data residency). */
+  storage;
   constructor(options) {
     const http = new HttpClient(options);
     this.agents = new Agents(http);
@@ -522,6 +546,7 @@ var Nixflex = class {
     this.keys = new Keys(http);
     this.usage = new UsageResource(http);
     this.webhooks = new Webhooks(http);
+    this.storage = new Storage(http);
   }
   /** Create a brand-new API key (unauthenticated signup endpoint - most
    * developers use the dashboard instead). The key_secret is shown ONCE.

package/dist/index.d.cts

@@ -576,6 +576,38 @@ interface WebhookConfigResponse {
     phone_number?: string;
     url?: string | null;
 }
+/** Your own S3-compatible recording storage (BYO storage). */
+interface StorageConfig {
+    storage_enabled: boolean;
+    endpoint: string | null;
+    region: string | null;
+    bucket: string | null;
+    access_key: string | null;
+}
+interface StorageSetParams {
+    /** The exact bucket name at your provider. */
+    bucket: string;
+    /** Access key ID with permission to write objects. */
+    access_key: string;
+    /** Secret access key. Write-only - stored encrypted, never returned. */
+    secret_key: string;
+    /** https:// endpoint of your provider. Leave empty for Amazon S3. */
+    endpoint?: string;
+    /** Your bucket's region. Defaults to auto. */
+    region?: string;
+}
+interface StorageSetResponse {
+    ok: boolean;
+    storage_enabled: boolean;
+    bucket: string;
+    endpoint: string | null;
+    region: string;
+    verified: boolean;
+}
+interface StorageDeleteResponse {
+    ok: boolean;
+    storage_enabled: boolean;
+}
 
 declare class PhoneNumbers {
     private readonly http;
@@ -663,6 +695,21 @@ declare class UsageResource {
     get(opts?: RequestOptions): Promise<Usage>;
 }
 
+declare class Storage {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Connect your own S3-compatible bucket for call recordings (data residency).
+     * The connection is verified with a probe write BEFORE saving - broken
+     * credentials are rejected, never stored. Recordings then upload to your
+     * bucket and Nixflex keeps no copy; recording_url becomes a byo: path. */
+    set(params: StorageSetParams, opts?: RequestOptions): Promise<StorageSetResponse>;
+    /** Current storage configuration. The secret is never included. */
+    get(opts?: RequestOptions): Promise<StorageConfig>;
+    /** Disconnect and clear. Recordings return to Nixflex EU storage from the
+     * next call; files already in your bucket are untouched - they are yours. */
+    delete(opts?: RequestOptions): Promise<StorageDeleteResponse>;
+}
+
 declare class Webhooks {
     private readonly http;
     constructor(http: HttpClient);
@@ -752,6 +799,8 @@ declare class Nixflex {
     readonly usage: UsageResource;
     /** Per-number post-call webhook configuration. */
     readonly webhooks: Webhooks;
+    /** Your own S3-compatible recording storage (data residency). */
+    readonly storage: Storage;
     constructor(options: NixflexClientOptions);
     /** Create a brand-new API key (unauthenticated signup endpoint - most
      * developers use the dashboard instead). The key_secret is shown ONCE.
@@ -762,4 +811,4 @@ declare class Nixflex {
     }, baseUrl?: string): Promise<KeyCreateResponse>;
 }
 
-export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type TransferType, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };
+export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type StorageConfig, type StorageDeleteResponse, type StorageSetParams, type StorageSetResponse, type TransferType, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };

package/dist/index.d.ts

@@ -576,6 +576,38 @@ interface WebhookConfigResponse {
     phone_number?: string;
     url?: string | null;
 }
+/** Your own S3-compatible recording storage (BYO storage). */
+interface StorageConfig {
+    storage_enabled: boolean;
+    endpoint: string | null;
+    region: string | null;
+    bucket: string | null;
+    access_key: string | null;
+}
+interface StorageSetParams {
+    /** The exact bucket name at your provider. */
+    bucket: string;
+    /** Access key ID with permission to write objects. */
+    access_key: string;
+    /** Secret access key. Write-only - stored encrypted, never returned. */
+    secret_key: string;
+    /** https:// endpoint of your provider. Leave empty for Amazon S3. */
+    endpoint?: string;
+    /** Your bucket's region. Defaults to auto. */
+    region?: string;
+}
+interface StorageSetResponse {
+    ok: boolean;
+    storage_enabled: boolean;
+    bucket: string;
+    endpoint: string | null;
+    region: string;
+    verified: boolean;
+}
+interface StorageDeleteResponse {
+    ok: boolean;
+    storage_enabled: boolean;
+}
 
 declare class PhoneNumbers {
     private readonly http;
@@ -663,6 +695,21 @@ declare class UsageResource {
     get(opts?: RequestOptions): Promise<Usage>;
 }
 
+declare class Storage {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Connect your own S3-compatible bucket for call recordings (data residency).
+     * The connection is verified with a probe write BEFORE saving - broken
+     * credentials are rejected, never stored. Recordings then upload to your
+     * bucket and Nixflex keeps no copy; recording_url becomes a byo: path. */
+    set(params: StorageSetParams, opts?: RequestOptions): Promise<StorageSetResponse>;
+    /** Current storage configuration. The secret is never included. */
+    get(opts?: RequestOptions): Promise<StorageConfig>;
+    /** Disconnect and clear. Recordings return to Nixflex EU storage from the
+     * next call; files already in your bucket are untouched - they are yours. */
+    delete(opts?: RequestOptions): Promise<StorageDeleteResponse>;
+}
+
 declare class Webhooks {
     private readonly http;
     constructor(http: HttpClient);
@@ -752,6 +799,8 @@ declare class Nixflex {
     readonly usage: UsageResource;
     /** Per-number post-call webhook configuration. */
     readonly webhooks: Webhooks;
+    /** Your own S3-compatible recording storage (data residency). */
+    readonly storage: Storage;
     constructor(options: NixflexClientOptions);
     /** Create a brand-new API key (unauthenticated signup endpoint - most
      * developers use the dashboard instead). The key_secret is shown ONCE.
@@ -762,4 +811,4 @@ declare class Nixflex {
     }, baseUrl?: string): Promise<KeyCreateResponse>;
 }
 
-export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type TransferType, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };
+export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type StorageConfig, type StorageDeleteResponse, type StorageSetParams, type StorageSetResponse, type TransferType, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };

package/dist/index.js

@@ -429,6 +429,28 @@ var UsageResource = class {
     return this.http.request("GET", "/usage", void 0, void 0, opts);
   }
 };
+var Storage = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Connect your own S3-compatible bucket for call recordings (data residency).
+   * The connection is verified with a probe write BEFORE saving - broken
+   * credentials are rejected, never stored. Recordings then upload to your
+   * bucket and Nixflex keeps no copy; recording_url becomes a byo: path. */
+  set(params, opts) {
+    return this.http.request("PUT", "/account/storage", params, void 0, opts);
+  }
+  /** Current storage configuration. The secret is never included. */
+  get(opts) {
+    return this.http.request("GET", "/account/storage", void 0, void 0, opts);
+  }
+  /** Disconnect and clear. Recordings return to Nixflex EU storage from the
+   * next call; files already in your bucket are untouched - they are yours. */
+  delete(opts) {
+    return this.http.request("DELETE", "/account/storage", void 0, void 0, opts);
+  }
+};
 var Webhooks = class {
   constructor(http) {
     this.http = http;
@@ -476,6 +498,8 @@ var Nixflex = class {
   usage;
   /** Per-number post-call webhook configuration. */
   webhooks;
+  /** Your own S3-compatible recording storage (data residency). */
+  storage;
   constructor(options) {
     const http = new HttpClient(options);
     this.agents = new Agents(http);
@@ -486,6 +510,7 @@ var Nixflex = class {
     this.keys = new Keys(http);
     this.usage = new UsageResource(http);
     this.webhooks = new Webhooks(http);
+    this.storage = new Storage(http);
   }
   /** Create a brand-new API key (unauthenticated signup endpoint - most
    * developers use the dashboard instead). The key_secret is shown ONCE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nixflex",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Official Node.js SDK for the Nixflex voice AI platform - AI phone agents, outbound campaigns, and SMS.",
   "keywords": [
     "nixflex",