npm - nixflex - Versions diffs - 0.2.1 → 0.3.0 - Mend

nixflex 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,56 @@
+## 0.3.0 (2026-08-23)
+- Call type: `charged_minutes` (minutes actually billed - transfers stop the meter at handoff, so this can be less than the recording length)
+- Call type: `ended_reason` documented with the full value list, including the new `callee_hangup` (outbound) and carrier words (`busy`, `failed`, `no-answer`, `canceled`)
+- No breaking changes. `list` pagination (`limit`/`offset`) shipped previously in 0.2.x.
+# Changelog
+All notable changes to the `nixflex` package. This project follows
+[semantic versioning](https://semver.org): patch for fixes, minor for new
+features, major for breaking changes. Published methods are never removed or
+renamed within a major version.
+## 0.2.2
+- Corrected the SMS campaign documentation: rom_number may be on either carrier
+  (Twilio or Telnyx). An earlier docs page wrongly stated Telnyx was rejected at
+  create; the engine routes by provider. No code behaviour changed.
+## 0.2.1
+- Added MIT `LICENSE`, this changelog, and repository/homepage/issue metadata
+  so the npm page links back to the source and docs.
+- Documented `verifyWebhookSignature` in the README.
+- Continuous integration now builds and runs the test suite on every push.
+- No API changes.
+## 0.2.0
+- **Added** `verifyWebhookSignature(rawBody, signatureHeader, keySecret)` and
+  `client.webhooks.verify(...)` - verifies the `X-Nixflex-Signature` header
+  (HMAC-SHA256 over `"<timestamp>.<body>"`) with a constant-time comparison and
+  a configurable replay window (5 minutes by default). Never throws.
+- **Added** `client.calls.delete(callId)` - permanently erases one call record,
+  transcript, and recording file.
+- **Added** `client.calls.deleteAll()` - erases all calls, recordings, and SMS
+  messages on the key.
+- Added `@types/node` as a development dependency (required for `Buffer` and
+  `node:crypto` types in the generated declarations).
+## 0.1.0
+First public release.
+- `agents` - create, list, get, update, delete, `iter()`
+- `calls` - create outbound, list, get, `iter()`
+- `campaigns` - create and launch voice batch campaigns
+- `phoneNumbers` - import, list, update, delete, monitor and web-call toggles
+- `sms` - single sends and bulk campaigns
+- `keys` - rotate the API secret
+- `usage` - account usage and limits
+- `webhooks` - per-number webhook configuration
+- Typed errors per HTTP status, automatic retry on `429` honouring
+  `Retry-After`, retries on network failure, and no blind retry of `POST`
+  requests after a `5xx` (a call is never dialled twice).
+- Dual ESM and CommonJS builds, TypeScript declarations, zero runtime
+  dependencies, Node 18 or newer.

package/dist/index.cjs CHANGED Viewed

@@ -403,8 +403,8 @@ var SmsCampaigns = class {
   }
   http;
   /** Create a one-time SMS broadcast ({{variable}} templating per recipient,
-   * up to 10,000 recipients). Requires a TWILIO from_number - Telnyx numbers
-   * are rejected at create (single sends support both carriers). */
+   * up to 10,000 recipients). from_number may be on either carrier (Twilio or
+   * Telnyx) and must be a number on your own account. */
   create(params, opts) {
     return this.http.request("POST", "/sms/campaigns", params, void 0, opts);
   }

package/dist/index.d.cts CHANGED Viewed

@@ -183,7 +183,14 @@ interface Call {
     answered_at: number | null;
     /** TIME CONNECTED in ms (answer to hangup) - the number you are billed on. Ring time excluded, so on outbound this is NOT end_timestamp - start_timestamp. */
     duration_ms: number;
+    /** Why the call ended: completed, transferred, voicemail_detected, silence_timeout,
+     * ivr_timeout, max_duration_reached, caller_hangup (inbound), callee_hangup (outbound),
+     * busy / failed / no-answer / canceled (carrier words for calls that never connected),
+     * concurrency_limit, and rare infrastructure endings. */
     ended_reason: string;
+    /** Minutes actually charged for this call. Transfers stop the meter at handoff, so
+     * this can be less than duration_ms suggests - the recording runs to the end either way. */
+    charged_minutes?: number;
     /** A single string, one turn per line - not an array of turn objects. */
     transcript: string;
     call_summary: string;
@@ -452,8 +459,11 @@ interface SmsCampaignRecipient {
     /** Fills {{placeholders}} in the template. Missing variables render as empty strings. */
     variables?: Record<string, string>;
 }
-/** SMS campaigns currently require a TWILIO from_number - Telnyx numbers are
- * rejected at create (single sends via sms.send work on both carriers). */
+/** from_number may be on EITHER carrier (Twilio or Telnyx) - the campaign
+ * sends using that number's own credentials, so it must be a number on your
+ * account. (An earlier doc page wrongly said Telnyx was rejected at create;
+ * the engine routes by provider and has done since the Twilio-only lookup
+ * was removed.) */
 interface SmsCampaignCreateParams {
     agent_id: string;
     /** Your imported TWILIO number. */
@@ -589,8 +599,8 @@ declare class SmsCampaigns {
     private readonly http;
     constructor(http: HttpClient);
     /** Create a one-time SMS broadcast ({{variable}} templating per recipient,
-     * up to 10,000 recipients). Requires a TWILIO from_number - Telnyx numbers
-     * are rejected at create (single sends support both carriers). */
+     * up to 10,000 recipients). from_number may be on either carrier (Twilio or
+     * Telnyx) and must be a number on your own account. */
     create(params: SmsCampaignCreateParams, opts?: RequestOptions): Promise<SmsCampaign>;
     /** Launch a draft/scheduled campaign immediately. */
     launch(campaignId: string, opts?: RequestOptions): Promise<SmsCampaignLaunchResponse>;

package/dist/index.d.ts CHANGED Viewed

@@ -183,7 +183,14 @@ interface Call {
     answered_at: number | null;
     /** TIME CONNECTED in ms (answer to hangup) - the number you are billed on. Ring time excluded, so on outbound this is NOT end_timestamp - start_timestamp. */
     duration_ms: number;
+    /** Why the call ended: completed, transferred, voicemail_detected, silence_timeout,
+     * ivr_timeout, max_duration_reached, caller_hangup (inbound), callee_hangup (outbound),
+     * busy / failed / no-answer / canceled (carrier words for calls that never connected),
+     * concurrency_limit, and rare infrastructure endings. */
     ended_reason: string;
+    /** Minutes actually charged for this call. Transfers stop the meter at handoff, so
+     * this can be less than duration_ms suggests - the recording runs to the end either way. */
+    charged_minutes?: number;
     /** A single string, one turn per line - not an array of turn objects. */
     transcript: string;
     call_summary: string;
@@ -452,8 +459,11 @@ interface SmsCampaignRecipient {
     /** Fills {{placeholders}} in the template. Missing variables render as empty strings. */
     variables?: Record<string, string>;
 }
-/** SMS campaigns currently require a TWILIO from_number - Telnyx numbers are
- * rejected at create (single sends via sms.send work on both carriers). */
+/** from_number may be on EITHER carrier (Twilio or Telnyx) - the campaign
+ * sends using that number's own credentials, so it must be a number on your
+ * account. (An earlier doc page wrongly said Telnyx was rejected at create;
+ * the engine routes by provider and has done since the Twilio-only lookup
+ * was removed.) */
 interface SmsCampaignCreateParams {
     agent_id: string;
     /** Your imported TWILIO number. */
@@ -589,8 +599,8 @@ declare class SmsCampaigns {
     private readonly http;
     constructor(http: HttpClient);
     /** Create a one-time SMS broadcast ({{variable}} templating per recipient,
-     * up to 10,000 recipients). Requires a TWILIO from_number - Telnyx numbers
-     * are rejected at create (single sends support both carriers). */
+     * up to 10,000 recipients). from_number may be on either carrier (Twilio or
+     * Telnyx) and must be a number on your own account. */
     create(params: SmsCampaignCreateParams, opts?: RequestOptions): Promise<SmsCampaign>;
     /** Launch a draft/scheduled campaign immediately. */
     launch(campaignId: string, opts?: RequestOptions): Promise<SmsCampaignLaunchResponse>;

package/dist/index.js CHANGED Viewed

@@ -367,8 +367,8 @@ var SmsCampaigns = class {
   }
   http;
   /** Create a one-time SMS broadcast ({{variable}} templating per recipient,
-   * up to 10,000 recipients). Requires a TWILIO from_number - Telnyx numbers
-   * are rejected at create (single sends support both carriers). */
+   * up to 10,000 recipients). from_number may be on either carrier (Twilio or
+   * Telnyx) and must be a number on your own account. */
   create(params, opts) {
     return this.http.request("POST", "/sms/campaigns", params, void 0, opts);
   }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "nixflex",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Official Node.js SDK for the Nixflex voice AI platform - AI phone agents, outbound campaigns, and SMS.",
   "keywords": [
     "nixflex",
@@ -39,7 +39,8 @@
   "files": [
     "dist",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18"