@roarkanalytics/sdk 0.34.0 → 0.35.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.35.0 (2025-02-07)
+
+Full Changelog: [v0.34.0...v0.35.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.34.0...v0.35.0)
+
+### Features
+
+* **api:** api update ([#139](https://github.com/roarkhq/sdk-roark-analytics-node/issues/139)) ([02d63aa](https://github.com/roarkhq/sdk-roark-analytics-node/commit/02d63aaf05b508621c22fceb5438f5d5b822127f))
+
 ## 0.34.0 (2025-02-07)
 
 Full Changelog: [v0.33.0...v0.34.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.33.0...v0.34.0)

package/README.md

@@ -28,12 +28,14 @@ const client = new Roark({
 
 async function main() {
   const callAnalysis = await client.callAnalysis.create({
+    callDirection: 'INBOUND',
+    interfaceType: 'PHONE',
     participants: [
       { role: 'AGENT', spokeFirst: true },
       { role: 'AGENT', spokeFirst: false },
     ],
     recordingUrl: 'https://example.com/recording.wav',
-    startedAt: '2025-02-07T13:37:33.456Z',
+    startedAt: '2025-02-07T14:13:41.276Z',
   });
 
   console.log(callAnalysis.data);
@@ -56,12 +58,14 @@ const client = new Roark({
 
 async function main() {
   const params: Roark.CallAnalysisCreateParams = {
+    callDirection: 'INBOUND',
+    interfaceType: 'PHONE',
     participants: [
       { role: 'AGENT', spokeFirst: true },
       { role: 'AGENT', spokeFirst: false },
     ],
     recordingUrl: 'https://example.com/recording.wav',
-    startedAt: '2025-02-07T13:37:33.456Z',
+    startedAt: '2025-02-07T14:13:41.276Z',
   };
   const callAnalysis: Roark.CallAnalysisCreateResponse = await client.callAnalysis.create(params);
 }
@@ -82,12 +86,14 @@ a subclass of `APIError` will be thrown:
 async function main() {
   const callAnalysis = await client.callAnalysis
     .create({
+      callDirection: 'INBOUND',
+      interfaceType: 'PHONE',
       participants: [
         { role: 'AGENT', spokeFirst: true },
         { role: 'AGENT', spokeFirst: false },
       ],
       recordingUrl: 'https://example.com/recording.wav',
-      startedAt: '2025-02-07T13:37:33.456Z',
+      startedAt: '2025-02-07T14:13:41.276Z',
     })
     .catch(async (err) => {
       if (err instanceof Roark.APIError) {
@@ -132,7 +138,7 @@ const client = new Roark({
 });
 
 // Or, configure per-request:
-await client.callAnalysis.create({ participants: [{ role: 'AGENT', spokeFirst: true }, { role: 'AGENT', spokeFirst: false }], recordingUrl: 'https://example.com/recording.wav', startedAt: '2025-02-07T13:37:33.456Z' }, {
+await client.callAnalysis.create({ callDirection: 'INBOUND', interfaceType: 'PHONE', participants: [{ role: 'AGENT', spokeFirst: true }, { role: 'AGENT', spokeFirst: false }], recordingUrl: 'https://example.com/recording.wav', startedAt: '2025-02-07T14:13:41.276Z' }, {
   maxRetries: 5,
 });
 ```
@@ -149,7 +155,7 @@ const client = new Roark({
 });
 
 // Override per-request:
-await client.callAnalysis.create({ participants: [{ role: 'AGENT', spokeFirst: true }, { role: 'AGENT', spokeFirst: false }], recordingUrl: 'https://example.com/recording.wav', startedAt: '2025-02-07T13:37:33.456Z' }, {
+await client.callAnalysis.create({ callDirection: 'INBOUND', interfaceType: 'PHONE', participants: [{ role: 'AGENT', spokeFirst: true }, { role: 'AGENT', spokeFirst: false }], recordingUrl: 'https://example.com/recording.wav', startedAt: '2025-02-07T14:13:41.276Z' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -172,12 +178,14 @@ const client = new Roark();
 
 const response = await client.callAnalysis
   .create({
+    callDirection: 'INBOUND',
+    interfaceType: 'PHONE',
     participants: [
       { role: 'AGENT', spokeFirst: true },
       { role: 'AGENT', spokeFirst: false },
     ],
     recordingUrl: 'https://example.com/recording.wav',
-    startedAt: '2025-02-07T13:37:33.456Z',
+    startedAt: '2025-02-07T14:13:41.276Z',
   })
   .asResponse();
 console.log(response.headers.get('X-My-Header'));
@@ -185,12 +193,14 @@ console.log(response.statusText); // access the underlying Response object
 
 const { data: callAnalysis, response: raw } = await client.callAnalysis
   .create({
+    callDirection: 'INBOUND',
+    interfaceType: 'PHONE',
     participants: [
       { role: 'AGENT', spokeFirst: true },
       { role: 'AGENT', spokeFirst: false },
     ],
     recordingUrl: 'https://example.com/recording.wav',
-    startedAt: '2025-02-07T13:37:33.456Z',
+    startedAt: '2025-02-07T14:13:41.276Z',
   })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
@@ -300,12 +310,14 @@ const client = new Roark({
 // Override per-request:
 await client.callAnalysis.create(
   {
+    callDirection: 'INBOUND',
+    interfaceType: 'PHONE',
     participants: [
       { role: 'AGENT', spokeFirst: true },
       { role: 'AGENT', spokeFirst: false },
     ],
     recordingUrl: 'https://example.com/recording.wav',
-    startedAt: '2025-02-07T13:37:33.456Z',
+    startedAt: '2025-02-07T14:13:41.276Z',
   },
   {
     httpAgent: new http.Agent({ keepAlive: false }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roarkanalytics/sdk",
-  "version": "0.34.0",
+  "version": "0.35.0",
   "description": "The official TypeScript library for the Roark API",
   "author": "Roark <james@roark.ai>",
   "types": "./index.d.ts",

package/resources/call-analysis.d.ts

@@ -48,6 +48,14 @@ export declare namespace CallAnalysisCreateResponse {
     }
 }
 export interface CallAnalysisCreateParams {
+    /**
+     * Direction of the call (INBOUND or OUTBOUND)
+     */
+    callDirection: 'INBOUND' | 'OUTBOUND';
+    /**
+     * Interface type of the call (PHONE or WEB)
+     */
+    interfaceType: 'PHONE' | 'WEB';
     /**
      * Exactly two participants in the call
      */
@@ -56,10 +64,17 @@ export interface CallAnalysisCreateParams {
      * URL of source recording (must be an accessible WAV file). Can be a signed URL.
      */
     recordingUrl: string;
+    /**
+     * When the call started (ISO 8601 format)
+     */
     startedAt: string;
-    callDirection?: 'INBOUND' | 'OUTBOUND';
+    /**
+     * Reason why the call ended (optional)
+     */
     endedReason?: string;
-    interfaceType?: 'PHONE' | 'WEB';
+    /**
+     * Whether this is a test call
+     */
     isTest?: boolean;
     /**
      * URL of source stereo recording in WAV format. Must be accessible. Can be a

package/resources/call-analysis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"call-analysis.d.ts","sourceRoot":"","sources":["../src/resources/call-analysis.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;CAG/C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;KAC5D;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,IAAI;YACnB,EAAE,EAAE,MAAM,CAAC;YAEX,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC;YAEtC,MAAM,EAAE,OAAO,CAAC;YAEhB,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEtC,SAAS,EAAE,MAAM,CAAC;YAElB,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;YAEnD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;gBAEtE,UAAU,EAAE,OAAO,CAAC;gBAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,WAAW,CAAC,EAAE,MAAM,CAAC;aACtB;SACF;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAE1D;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;IAEvC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAEhC,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,WAAW;QAC1B,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;QAEtE,UAAU,EAAE,OAAO,CAAC;QAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"call-analysis.d.ts","sourceRoot":"","sources":["../src/resources/call-analysis.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;CAG/C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;KAC5D;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,IAAI;YACnB,EAAE,EAAE,MAAM,CAAC;YAEX,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC;YAEtC,MAAM,EAAE,OAAO,CAAC;YAEhB,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEtC,SAAS,EAAE,MAAM,CAAC;YAElB,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;YAEnD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;gBAEtE,UAAU,EAAE,OAAO,CAAC;gBAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,WAAW,CAAC,EAAE,MAAM,CAAC;aACtB;SACF;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC;IAEtC;;OAEG;IACH,aAAa,EAAE,OAAO,GAAG,KAAK,CAAC;IAE/B;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAE1D;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,WAAW;QAC1B,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;QAEtE,UAAU,EAAE,OAAO,CAAC;QAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/src/resources/call-analysis.ts

@@ -75,6 +75,16 @@ export namespace CallAnalysisCreateResponse {
 }
 
 export interface CallAnalysisCreateParams {
+  /**
+   * Direction of the call (INBOUND or OUTBOUND)
+   */
+  callDirection: 'INBOUND' | 'OUTBOUND';
+
+  /**
+   * Interface type of the call (PHONE or WEB)
+   */
+  interfaceType: 'PHONE' | 'WEB';
+
   /**
    * Exactly two participants in the call
    */
@@ -85,14 +95,19 @@ export interface CallAnalysisCreateParams {
    */
   recordingUrl: string;
 
+  /**
+   * When the call started (ISO 8601 format)
+   */
   startedAt: string;
 
-  callDirection?: 'INBOUND' | 'OUTBOUND';
-
+  /**
+   * Reason why the call ended (optional)
+   */
   endedReason?: string;
 
-  interfaceType?: 'PHONE' | 'WEB';
-
+  /**
+   * Whether this is a test call
+   */
   isTest?: boolean;
 
   /**

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.34.0'; // x-release-please-version
+export const VERSION = '0.35.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.34.0";
+export declare const VERSION = "0.35.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.34.0'; // x-release-please-version
+exports.VERSION = '0.35.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.34.0'; // x-release-please-version
+export const VERSION = '0.35.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map