@roarkanalytics/sdk 0.1.0-alpha.4 → 0.1.0-alpha.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (12) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +32 -8
  3. package/package.json +1 -1
  4. package/resources/calls.d.ts +16 -6
  5. package/resources/calls.d.ts.map +1 -1
  6. package/resources/calls.js +1 -1
  7. package/resources/calls.mjs +1 -1
  8. package/src/resources/calls.ts +17 -7
  9. package/src/version.ts +1 -1
  10. package/version.d.ts +1 -1
  11. package/version.js +1 -1
  12. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-alpha.6 (2025-02-05)
4
+
5
+ Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([#18](https://github.com/roarkhq/sdk-roark-analytics-node/issues/18)) ([3be0935](https://github.com/roarkhq/sdk-roark-analytics-node/commit/3be0935eb1e2027a8fc4481c52f2c8aaa3ab4273))
10
+ * **api:** api update ([#20](https://github.com/roarkhq/sdk-roark-analytics-node/issues/20)) ([20fdd38](https://github.com/roarkhq/sdk-roark-analytics-node/commit/20fdd3899ed77f9f3ce9c2e4841207dcaf2aefa0))
11
+ * **api:** api update ([#21](https://github.com/roarkhq/sdk-roark-analytics-node/issues/21)) ([283646f](https://github.com/roarkhq/sdk-roark-analytics-node/commit/283646f7f9ddc09d707460c3936b176c07aa34e6))
12
+ * **api:** api update ([#22](https://github.com/roarkhq/sdk-roark-analytics-node/issues/22)) ([2cf4c74](https://github.com/roarkhq/sdk-roark-analytics-node/commit/2cf4c74d4ab7866f430b8381ee0f77733d1907ad))
13
+ * **api:** api update ([#23](https://github.com/roarkhq/sdk-roark-analytics-node/issues/23)) ([5bd6848](https://github.com/roarkhq/sdk-roark-analytics-node/commit/5bd684842db3bab62f281563e2c3db78f47afb4b))
14
+ * **api:** api update ([#24](https://github.com/roarkhq/sdk-roark-analytics-node/issues/24)) ([4100067](https://github.com/roarkhq/sdk-roark-analytics-node/commit/41000673c5f1d89be3652142b6d79f010a6e3853))
15
+ * **api:** api update ([#25](https://github.com/roarkhq/sdk-roark-analytics-node/issues/25)) ([fa0eb0d](https://github.com/roarkhq/sdk-roark-analytics-node/commit/fa0eb0d086c500af26e0dbaf5603075d597d1ba0))
16
+ * **api:** api update ([#26](https://github.com/roarkhq/sdk-roark-analytics-node/issues/26)) ([2c07c42](https://github.com/roarkhq/sdk-roark-analytics-node/commit/2c07c422c401ba6e9a96b6b722e9a5286cf14cd4))
17
+ * **api:** api update ([#27](https://github.com/roarkhq/sdk-roark-analytics-node/issues/27)) ([28a178c](https://github.com/roarkhq/sdk-roark-analytics-node/commit/28a178c2662092f7520533e6c31556c17e2f7999))
18
+ * **api:** api update ([#28](https://github.com/roarkhq/sdk-roark-analytics-node/issues/28)) ([820a23d](https://github.com/roarkhq/sdk-roark-analytics-node/commit/820a23d4df952317fef686c3292e28dc364f4863))
19
+ * **api:** api update ([#29](https://github.com/roarkhq/sdk-roark-analytics-node/issues/29)) ([e99289d](https://github.com/roarkhq/sdk-roark-analytics-node/commit/e99289dedf559145dd7a5ace558921b8b47e8127))
20
+ * **api:** api update ([#30](https://github.com/roarkhq/sdk-roark-analytics-node/issues/30)) ([727a6e4](https://github.com/roarkhq/sdk-roark-analytics-node/commit/727a6e480bc0e376b09b011fd9f4b7c8f4d14ed6))
21
+ * **api:** api update ([#31](https://github.com/roarkhq/sdk-roark-analytics-node/issues/31)) ([463408f](https://github.com/roarkhq/sdk-roark-analytics-node/commit/463408f52fd013ab77e92de18f648182b4221078))
22
+
23
+ ## 0.1.0-alpha.5 (2025-02-04)
24
+
25
+ Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
26
+
27
+ ### Features
28
+
29
+ * **api:** api update ([#15](https://github.com/roarkhq/sdk-roark-analytics-node/issues/15)) ([d638e9e](https://github.com/roarkhq/sdk-roark-analytics-node/commit/d638e9e55f3ad430f0e3d41130fc7b5e1cda1a35))
30
+
3
31
  ## 0.1.0-alpha.4 (2025-02-04)
4
32
 
5
33
  Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
package/README.md CHANGED
@@ -27,7 +27,11 @@ const client = new Roark({
27
27
  });
28
28
 
29
29
  async function main() {
30
- const call = await client.calls.create({ direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' });
30
+ const call = await client.calls.create({
31
+ direction: 'INBOUND',
32
+ sourceRecordingUrl: 'https://example.com/recording.mp3',
33
+ startedAt: '2025-02-04T23:59:46.849Z',
34
+ });
31
35
 
32
36
  console.log(call.data);
33
37
  }
@@ -48,7 +52,11 @@ const client = new Roark({
48
52
  });
49
53
 
50
54
  async function main() {
51
- const params: Roark.CallCreateParams = { direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' };
55
+ const params: Roark.CallCreateParams = {
56
+ direction: 'INBOUND',
57
+ sourceRecordingUrl: 'https://example.com/recording.mp3',
58
+ startedAt: '2025-02-04T23:59:46.849Z',
59
+ };
52
60
  const call: Roark.CallCreateResponse = await client.calls.create(params);
53
61
  }
54
62
 
@@ -67,7 +75,11 @@ a subclass of `APIError` will be thrown:
67
75
  ```ts
68
76
  async function main() {
69
77
  const call = await client.calls
70
- .create({ direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' })
78
+ .create({
79
+ direction: 'INBOUND',
80
+ sourceRecordingUrl: 'https://example.com/recording.mp3',
81
+ startedAt: '2025-02-04T23:59:46.849Z',
82
+ })
71
83
  .catch(async (err) => {
72
84
  if (err instanceof Roark.APIError) {
73
85
  console.log(err.status); // 400
@@ -111,7 +123,7 @@ const client = new Roark({
111
123
  });
112
124
 
113
125
  // Or, configure per-request:
114
- await client.calls.create({ direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' }, {
126
+ await client.calls.create({ direction: 'INBOUND', sourceRecordingUrl: 'https://example.com/recording.mp3', startedAt: '2025-02-04T23:59:46.849Z' }, {
115
127
  maxRetries: 5,
116
128
  });
117
129
  ```
@@ -128,7 +140,7 @@ const client = new Roark({
128
140
  });
129
141
 
130
142
  // Override per-request:
131
- await client.calls.create({ direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' }, {
143
+ await client.calls.create({ direction: 'INBOUND', sourceRecordingUrl: 'https://example.com/recording.mp3', startedAt: '2025-02-04T23:59:46.849Z' }, {
132
144
  timeout: 5 * 1000,
133
145
  });
134
146
  ```
@@ -150,13 +162,21 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
150
162
  const client = new Roark();
151
163
 
152
164
  const response = await client.calls
153
- .create({ direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' })
165
+ .create({
166
+ direction: 'INBOUND',
167
+ sourceRecordingUrl: 'https://example.com/recording.mp3',
168
+ startedAt: '2025-02-04T23:59:46.849Z',
169
+ })
154
170
  .asResponse();
155
171
  console.log(response.headers.get('X-My-Header'));
156
172
  console.log(response.statusText); // access the underlying Response object
157
173
 
158
174
  const { data: call, response: raw } = await client.calls
159
- .create({ direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' })
175
+ .create({
176
+ direction: 'INBOUND',
177
+ sourceRecordingUrl: 'https://example.com/recording.mp3',
178
+ startedAt: '2025-02-04T23:59:46.849Z',
179
+ })
160
180
  .withResponse();
161
181
  console.log(raw.headers.get('X-My-Header'));
162
182
  console.log(call.data);
@@ -264,7 +284,11 @@ const client = new Roark({
264
284
 
265
285
  // Override per-request:
266
286
  await client.calls.create(
267
- { direction: 'INBOUND', startedAt: '2025-02-04T07:16:58.722Z' },
287
+ {
288
+ direction: 'INBOUND',
289
+ sourceRecordingUrl: 'https://example.com/recording.mp3',
290
+ startedAt: '2025-02-04T23:59:46.849Z',
291
+ },
268
292
  {
269
293
  httpAgent: new http.Agent({ keepAlive: false }),
270
294
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@roarkanalytics/sdk",
3
- "version": "0.1.0-alpha.4",
3
+ "version": "0.1.0-alpha.6",
4
4
  "description": "The official TypeScript library for the Roark API",
5
5
  "author": "Roark <james@roark.ai>",
6
6
  "types": "./index.d.ts",
package/resources/calls.d.ts CHANGED
@@ -2,7 +2,7 @@ import { APIResource } from "../resource.js";
2
2
  import * as Core from "../core.js";
3
3
  export declare class Calls extends APIResource {
4
4
  /**
5
- * Upload a call recording.
5
+ * Upload a new call recording
6
6
  */
7
7
  create(body: CallCreateParams, options?: Core.RequestOptions): Core.APIPromise<CallCreateResponse>;
8
8
  }
@@ -47,31 +47,41 @@ export declare namespace CallCreateResponse {
47
47
  }
48
48
  }
49
49
  export interface CallCreateParams {
50
+ /**
51
+ * The original direction of the call
52
+ */
50
53
  direction: 'INBOUND' | 'OUTBOUND';
54
+ /**
55
+ * URL of source recording
56
+ */
57
+ sourceRecordingUrl: string;
51
58
  startedAt: string;
52
59
  /**
53
- * Participant contact information
60
+ * Agent information
54
61
  */
55
62
  agent?: CallCreateParams.Agent;
56
63
  agentSpokeFirst?: boolean;
57
64
  /**
58
- * Participant contact information
65
+ * Customer information
59
66
  */
60
67
  customer?: CallCreateParams.Customer;
61
68
  isTest?: boolean;
62
- sourceRecordingUrl?: string;
69
+ /**
70
+ * URL of source stereo recording. While optional it allows for a richer audio
71
+ * player
72
+ */
63
73
  stereoRecordingUrl?: string;
64
74
  }
65
75
  export declare namespace CallCreateParams {
66
76
  /**
67
- * Participant contact information
77
+ * Agent information
68
78
  */
69
79
  interface Agent {
70
80
  name?: string;
71
81
  phoneNumber?: string;
72
82
  }
73
83
  /**
74
- * Participant contact information
84
+ * Customer information
75
85
  */
76
86
  interface Customer {
77
87
  name?: string;
package/resources/calls.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"calls.d.ts","sourceRoot":"","sources":["../src/resources/calls.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAGnG;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;QAElC,aAAa,EAAE,OAAO,GAAG,KAAK,CAAC;QAE/B,MAAM,EAAE,OAAO,CAAC;QAEhB,SAAS,EAAE,MAAM,CAAC;QAElB,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;QAEnD;;WAEG;QACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;QAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAElC,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAE/B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IAErC,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACrG"}
1
+ {"version":3,"file":"calls.d.ts","sourceRoot":"","sources":["../src/resources/calls.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAGnG;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;QAElC,aAAa,EAAE,OAAO,GAAG,KAAK,CAAC;QAE/B,MAAM,EAAE,OAAO,CAAC;QAEhB,SAAS,EAAE,MAAM,CAAC;QAElB,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;QAEnD;;WAEG;QACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;QAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAElC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAE/B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IAErC,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACrG"}
package/resources/calls.js CHANGED
@@ -5,7 +5,7 @@ exports.Calls = void 0;
5
5
  const resource_1 = require("../resource.js");
6
6
  class Calls extends resource_1.APIResource {
7
7
  /**
8
- * Upload a call recording.
8
+ * Upload a new call recording
9
9
  */
10
10
  create(body, options) {
11
11
  return this._client.post('/call', { body, ...options });
package/resources/calls.mjs CHANGED
@@ -2,7 +2,7 @@
2
2
  import { APIResource } from "../resource.mjs";
3
3
  export class Calls extends APIResource {
4
4
  /**
5
- * Upload a call recording.
5
+ * Upload a new call recording
6
6
  */
7
7
  create(body, options) {
8
8
  return this._client.post('/call', { body, ...options });
package/src/resources/calls.ts CHANGED
@@ -5,7 +5,7 @@ import * as Core from '../core';
5
5
 
6
6
  export class Calls extends APIResource {
7
7
  /**
8
- * Upload a call recording.
8
+ * Upload a new call recording
9
9
  */
10
10
  create(body: CallCreateParams, options?: Core.RequestOptions): Core.APIPromise<CallCreateResponse> {
11
11
  return this._client.post('/call', { body, ...options });
@@ -69,32 +69,42 @@ export namespace CallCreateResponse {
69
69
  }
70
70
 
71
71
  export interface CallCreateParams {
72
+ /**
73
+ * The original direction of the call
74
+ */
72
75
  direction: 'INBOUND' | 'OUTBOUND';
73
76
 
77
+ /**
78
+ * URL of source recording
79
+ */
80
+ sourceRecordingUrl: string;
81
+
74
82
  startedAt: string;
75
83
 
76
84
  /**
77
- * Participant contact information
85
+ * Agent information
78
86
  */
79
87
  agent?: CallCreateParams.Agent;
80
88
 
81
89
  agentSpokeFirst?: boolean;
82
90
 
83
91
  /**
84
- * Participant contact information
92
+ * Customer information
85
93
  */
86
94
  customer?: CallCreateParams.Customer;
87
95
 
88
96
  isTest?: boolean;
89
97
 
90
- sourceRecordingUrl?: string;
91
-
98
+ /**
99
+ * URL of source stereo recording. While optional it allows for a richer audio
100
+ * player
101
+ */
92
102
  stereoRecordingUrl?: string;
93
103
  }
94
104
 
95
105
  export namespace CallCreateParams {
96
106
  /**
97
- * Participant contact information
107
+ * Agent information
98
108
  */
99
109
  export interface Agent {
100
110
  name?: string;
@@ -103,7 +113,7 @@ export namespace CallCreateParams {
103
113
  }
104
114
 
105
115
  /**
106
- * Participant contact information
116
+ * Customer information
107
117
  */
108
118
  export interface Customer {
109
119
  name?: string;
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.1.0-alpha.4'; // x-release-please-version
1
+ export const VERSION = '0.1.0-alpha.6'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.1.0-alpha.4";
1
+ export declare const VERSION = "0.1.0-alpha.6";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.1.0-alpha.4'; // x-release-please-version
4
+ exports.VERSION = '0.1.0-alpha.6'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.1.0-alpha.4'; // x-release-please-version
1
+ export const VERSION = '0.1.0-alpha.6'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map