@roarkanalytics/sdk 2.16.0 → 2.19.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.
- package/CHANGELOG.md +36 -0
- package/core.d.ts.map +1 -1
- package/core.js +5 -0
- package/core.js.map +1 -1
- package/core.mjs +5 -0
- package/core.mjs.map +1 -1
- package/index.d.mts +2 -2
- package/index.d.ts +2 -2
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/call.d.ts +5 -0
- package/resources/call.d.ts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/persona.d.ts +12 -12
- package/resources/persona.d.ts.map +1 -1
- package/resources/simulation.d.ts +129 -7
- package/resources/simulation.d.ts.map +1 -1
- package/resources/simulation.js +6 -0
- package/resources/simulation.js.map +1 -1
- package/resources/simulation.mjs +6 -0
- package/resources/simulation.mjs.map +1 -1
- package/src/core.ts +6 -0
- package/src/index.ts +4 -0
- package/src/resources/call.ts +6 -0
- package/src/resources/index.ts +2 -0
- package/src/resources/persona.ts +18 -12
- package/src/resources/simulation.ts +170 -6
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/resources/persona.ts
CHANGED
|
@@ -109,7 +109,8 @@ export namespace PersonaCreateResponse {
|
|
|
109
109
|
| 'AU'
|
|
110
110
|
| 'IT'
|
|
111
111
|
| 'ID'
|
|
112
|
-
| 'TH'
|
|
112
|
+
| 'TH'
|
|
113
|
+
| 'JP';
|
|
113
114
|
|
|
114
115
|
/**
|
|
115
116
|
* Background noise setting
|
|
@@ -157,7 +158,7 @@ export namespace PersonaCreateResponse {
|
|
|
157
158
|
/**
|
|
158
159
|
* Primary language ISO 639-1 code for the persona
|
|
159
160
|
*/
|
|
160
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
161
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
161
162
|
|
|
162
163
|
/**
|
|
163
164
|
* How reliable the persona's memory is
|
|
@@ -230,7 +231,8 @@ export namespace PersonaUpdateResponse {
|
|
|
230
231
|
| 'AU'
|
|
231
232
|
| 'IT'
|
|
232
233
|
| 'ID'
|
|
233
|
-
| 'TH'
|
|
234
|
+
| 'TH'
|
|
235
|
+
| 'JP';
|
|
234
236
|
|
|
235
237
|
/**
|
|
236
238
|
* Background noise setting
|
|
@@ -278,7 +280,7 @@ export namespace PersonaUpdateResponse {
|
|
|
278
280
|
/**
|
|
279
281
|
* Primary language ISO 639-1 code for the persona
|
|
280
282
|
*/
|
|
281
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
283
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
282
284
|
|
|
283
285
|
/**
|
|
284
286
|
* How reliable the persona's memory is
|
|
@@ -353,7 +355,8 @@ export namespace PersonaListResponse {
|
|
|
353
355
|
| 'AU'
|
|
354
356
|
| 'IT'
|
|
355
357
|
| 'ID'
|
|
356
|
-
| 'TH'
|
|
358
|
+
| 'TH'
|
|
359
|
+
| 'JP';
|
|
357
360
|
|
|
358
361
|
/**
|
|
359
362
|
* Background noise setting
|
|
@@ -401,7 +404,7 @@ export namespace PersonaListResponse {
|
|
|
401
404
|
/**
|
|
402
405
|
* Primary language ISO 639-1 code for the persona
|
|
403
406
|
*/
|
|
404
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
407
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
405
408
|
|
|
406
409
|
/**
|
|
407
410
|
* How reliable the persona's memory is
|
|
@@ -491,7 +494,8 @@ export namespace PersonaGetByIDResponse {
|
|
|
491
494
|
| 'AU'
|
|
492
495
|
| 'IT'
|
|
493
496
|
| 'ID'
|
|
494
|
-
| 'TH'
|
|
497
|
+
| 'TH'
|
|
498
|
+
| 'JP';
|
|
495
499
|
|
|
496
500
|
/**
|
|
497
501
|
* Background noise setting
|
|
@@ -539,7 +543,7 @@ export namespace PersonaGetByIDResponse {
|
|
|
539
543
|
/**
|
|
540
544
|
* Primary language ISO 639-1 code for the persona
|
|
541
545
|
*/
|
|
542
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
546
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
543
547
|
|
|
544
548
|
/**
|
|
545
549
|
* How reliable the persona's memory is
|
|
@@ -602,7 +606,8 @@ export interface PersonaCreateParams {
|
|
|
602
606
|
| 'AU'
|
|
603
607
|
| 'IT'
|
|
604
608
|
| 'ID'
|
|
605
|
-
| 'TH'
|
|
609
|
+
| 'TH'
|
|
610
|
+
| 'JP';
|
|
606
611
|
|
|
607
612
|
/**
|
|
608
613
|
* Gender of the persona
|
|
@@ -612,7 +617,7 @@ export interface PersonaCreateParams {
|
|
|
612
617
|
/**
|
|
613
618
|
* Primary language ISO 639-1 code for the persona
|
|
614
619
|
*/
|
|
615
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
620
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
616
621
|
|
|
617
622
|
/**
|
|
618
623
|
* The name the agent will identify as during conversations
|
|
@@ -702,7 +707,8 @@ export interface PersonaUpdateParams {
|
|
|
702
707
|
| 'AU'
|
|
703
708
|
| 'IT'
|
|
704
709
|
| 'ID'
|
|
705
|
-
| 'TH'
|
|
710
|
+
| 'TH'
|
|
711
|
+
| 'JP';
|
|
706
712
|
|
|
707
713
|
/**
|
|
708
714
|
* Background noise setting
|
|
@@ -750,7 +756,7 @@ export interface PersonaUpdateParams {
|
|
|
750
756
|
/**
|
|
751
757
|
* Primary language ISO 639-1 code for the persona
|
|
752
758
|
*/
|
|
753
|
-
language?: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
759
|
+
language?: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
754
760
|
|
|
755
761
|
/**
|
|
756
762
|
* How reliable the persona's memory is
|
|
@@ -42,6 +42,30 @@ export class Simulation extends APIResource {
|
|
|
42
42
|
return this._client.get(`/v1/simulation/job/${jobId}`, options);
|
|
43
43
|
}
|
|
44
44
|
|
|
45
|
+
/**
|
|
46
|
+
* Returns a paginated list of simulation run plan jobs. Filter by status, plan ID,
|
|
47
|
+
* or label to find specific simulation batches.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const response = await client.simulation.listRunPlanJobs();
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
listRunPlanJobs(
|
|
55
|
+
query?: SimulationListRunPlanJobsParams,
|
|
56
|
+
options?: Core.RequestOptions,
|
|
57
|
+
): Core.APIPromise<SimulationListRunPlanJobsResponse>;
|
|
58
|
+
listRunPlanJobs(options?: Core.RequestOptions): Core.APIPromise<SimulationListRunPlanJobsResponse>;
|
|
59
|
+
listRunPlanJobs(
|
|
60
|
+
query: SimulationListRunPlanJobsParams | Core.RequestOptions = {},
|
|
61
|
+
options?: Core.RequestOptions,
|
|
62
|
+
): Core.APIPromise<SimulationListRunPlanJobsResponse> {
|
|
63
|
+
if (isRequestOptions(query)) {
|
|
64
|
+
return this.listRunPlanJobs({}, query);
|
|
65
|
+
}
|
|
66
|
+
return this._client.get('/v1/simulation/plan/jobs', { query, ...options });
|
|
67
|
+
}
|
|
68
|
+
|
|
45
69
|
/**
|
|
46
70
|
* Returns a paginated list of simulation scenarios for the authenticated project.
|
|
47
71
|
*
|
|
@@ -184,11 +208,23 @@ export namespace SimulationGetRunPlanJobResponse {
|
|
|
184
208
|
*/
|
|
185
209
|
status: string;
|
|
186
210
|
|
|
211
|
+
/**
|
|
212
|
+
* ID of the call created for this simulation job. Null if the call has not been
|
|
213
|
+
* created yet.
|
|
214
|
+
*/
|
|
215
|
+
callId?: string | null;
|
|
216
|
+
|
|
187
217
|
/**
|
|
188
218
|
* When the simulation job completed
|
|
189
219
|
*/
|
|
190
220
|
completedAt?: string | null;
|
|
191
221
|
|
|
222
|
+
/**
|
|
223
|
+
* Phone number provisioned by Roark for this simulation job in E.164 format. Null
|
|
224
|
+
* if the simulation job is queued and has not been assigned a phone number yet.
|
|
225
|
+
*/
|
|
226
|
+
roarkPhoneNumber?: string | null;
|
|
227
|
+
|
|
192
228
|
/**
|
|
193
229
|
* When the simulation job started
|
|
194
230
|
*/
|
|
@@ -245,7 +281,8 @@ export namespace SimulationGetRunPlanJobResponse {
|
|
|
245
281
|
| 'AU'
|
|
246
282
|
| 'IT'
|
|
247
283
|
| 'ID'
|
|
248
|
-
| 'TH'
|
|
284
|
+
| 'TH'
|
|
285
|
+
| 'JP';
|
|
249
286
|
|
|
250
287
|
/**
|
|
251
288
|
* Background noise setting
|
|
@@ -293,7 +330,7 @@ export namespace SimulationGetRunPlanJobResponse {
|
|
|
293
330
|
/**
|
|
294
331
|
* Primary language ISO 639-1 code for the persona
|
|
295
332
|
*/
|
|
296
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
333
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
297
334
|
|
|
298
335
|
/**
|
|
299
336
|
* How reliable the persona's memory is
|
|
@@ -398,11 +435,23 @@ export namespace SimulationGetSimulationJobByIDResponse {
|
|
|
398
435
|
*/
|
|
399
436
|
status: string;
|
|
400
437
|
|
|
438
|
+
/**
|
|
439
|
+
* ID of the call created for this simulation job. Null if the call has not been
|
|
440
|
+
* created yet.
|
|
441
|
+
*/
|
|
442
|
+
callId?: string | null;
|
|
443
|
+
|
|
401
444
|
/**
|
|
402
445
|
* When the job completed
|
|
403
446
|
*/
|
|
404
447
|
completedAt?: string | null;
|
|
405
448
|
|
|
449
|
+
/**
|
|
450
|
+
* Phone number provisioned by Roark for this simulation job in E.164 format. Null
|
|
451
|
+
* if the simulation job is queued and has not been assigned a phone number yet.
|
|
452
|
+
*/
|
|
453
|
+
roarkPhoneNumber?: string | null;
|
|
454
|
+
|
|
406
455
|
/**
|
|
407
456
|
* When the job started
|
|
408
457
|
*/
|
|
@@ -459,7 +508,8 @@ export namespace SimulationGetSimulationJobByIDResponse {
|
|
|
459
508
|
| 'AU'
|
|
460
509
|
| 'IT'
|
|
461
510
|
| 'ID'
|
|
462
|
-
| 'TH'
|
|
511
|
+
| 'TH'
|
|
512
|
+
| 'JP';
|
|
463
513
|
|
|
464
514
|
/**
|
|
465
515
|
* Background noise setting
|
|
@@ -507,7 +557,7 @@ export namespace SimulationGetSimulationJobByIDResponse {
|
|
|
507
557
|
/**
|
|
508
558
|
* Primary language ISO 639-1 code for the persona
|
|
509
559
|
*/
|
|
510
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
560
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
511
561
|
|
|
512
562
|
/**
|
|
513
563
|
* How reliable the persona's memory is
|
|
@@ -567,6 +617,71 @@ export namespace SimulationGetSimulationJobByIDResponse {
|
|
|
567
617
|
}
|
|
568
618
|
}
|
|
569
619
|
|
|
620
|
+
/**
|
|
621
|
+
* Paginated list of simulation run plan jobs
|
|
622
|
+
*/
|
|
623
|
+
export interface SimulationListRunPlanJobsResponse {
|
|
624
|
+
data: Array<SimulationListRunPlanJobsResponse.Data>;
|
|
625
|
+
|
|
626
|
+
pagination: SimulationListRunPlanJobsResponse.Pagination;
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
export namespace SimulationListRunPlanJobsResponse {
|
|
630
|
+
export interface Data {
|
|
631
|
+
/**
|
|
632
|
+
* When the job was created
|
|
633
|
+
*/
|
|
634
|
+
createdAt: string;
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
* ID of the simulation run plan
|
|
638
|
+
*/
|
|
639
|
+
simulationRunPlanId: string;
|
|
640
|
+
|
|
641
|
+
/**
|
|
642
|
+
* ID of the simulation run plan job
|
|
643
|
+
*/
|
|
644
|
+
simulationRunPlanJobId: string;
|
|
645
|
+
|
|
646
|
+
/**
|
|
647
|
+
* Job status
|
|
648
|
+
*/
|
|
649
|
+
status: string;
|
|
650
|
+
|
|
651
|
+
/**
|
|
652
|
+
* How the job was triggered (SCHEDULED or USER_TRIGGERED_FROM_UI)
|
|
653
|
+
*/
|
|
654
|
+
triggeredBy: string;
|
|
655
|
+
|
|
656
|
+
/**
|
|
657
|
+
* When the job ended
|
|
658
|
+
*/
|
|
659
|
+
endedAt?: string | null;
|
|
660
|
+
|
|
661
|
+
/**
|
|
662
|
+
* When the job started
|
|
663
|
+
*/
|
|
664
|
+
startedAt?: string | null;
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
export interface Pagination {
|
|
668
|
+
/**
|
|
669
|
+
* Whether there are more results available
|
|
670
|
+
*/
|
|
671
|
+
hasMore: boolean;
|
|
672
|
+
|
|
673
|
+
/**
|
|
674
|
+
* Total number of matching plan jobs
|
|
675
|
+
*/
|
|
676
|
+
total: number;
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* Cursor to use for fetching the next page
|
|
680
|
+
*/
|
|
681
|
+
nextCursor?: string | null;
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
|
|
570
685
|
export interface SimulationListScenariosResponse {
|
|
571
686
|
data: Array<SimulationListScenariosResponse.Data>;
|
|
572
687
|
|
|
@@ -688,11 +803,23 @@ export namespace SimulationLookupSimulationJobResponse {
|
|
|
688
803
|
*/
|
|
689
804
|
status: string;
|
|
690
805
|
|
|
806
|
+
/**
|
|
807
|
+
* ID of the call created for this simulation job. Null if the call has not been
|
|
808
|
+
* created yet.
|
|
809
|
+
*/
|
|
810
|
+
callId?: string | null;
|
|
811
|
+
|
|
691
812
|
/**
|
|
692
813
|
* When the job completed
|
|
693
814
|
*/
|
|
694
815
|
completedAt?: string | null;
|
|
695
816
|
|
|
817
|
+
/**
|
|
818
|
+
* Phone number provisioned by Roark for this simulation job in E.164 format. Null
|
|
819
|
+
* if the simulation job is queued and has not been assigned a phone number yet.
|
|
820
|
+
*/
|
|
821
|
+
roarkPhoneNumber?: string | null;
|
|
822
|
+
|
|
696
823
|
/**
|
|
697
824
|
* When the job started
|
|
698
825
|
*/
|
|
@@ -749,7 +876,8 @@ export namespace SimulationLookupSimulationJobResponse {
|
|
|
749
876
|
| 'AU'
|
|
750
877
|
| 'IT'
|
|
751
878
|
| 'ID'
|
|
752
|
-
| 'TH'
|
|
879
|
+
| 'TH'
|
|
880
|
+
| 'JP';
|
|
753
881
|
|
|
754
882
|
/**
|
|
755
883
|
* Background noise setting
|
|
@@ -797,7 +925,7 @@ export namespace SimulationLookupSimulationJobResponse {
|
|
|
797
925
|
/**
|
|
798
926
|
* Primary language ISO 639-1 code for the persona
|
|
799
927
|
*/
|
|
800
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH';
|
|
928
|
+
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA';
|
|
801
929
|
|
|
802
930
|
/**
|
|
803
931
|
* How reliable the persona's memory is
|
|
@@ -891,6 +1019,40 @@ export namespace SimulationStartRunPlanJobResponse {
|
|
|
891
1019
|
}
|
|
892
1020
|
}
|
|
893
1021
|
|
|
1022
|
+
export interface SimulationListRunPlanJobsParams {
|
|
1023
|
+
/**
|
|
1024
|
+
* Cursor for pagination - use the nextCursor value from a previous response
|
|
1025
|
+
*/
|
|
1026
|
+
after?: string;
|
|
1027
|
+
|
|
1028
|
+
/**
|
|
1029
|
+
* Filter by label ID attached to the plan job. Use this if you know the label ID.
|
|
1030
|
+
*/
|
|
1031
|
+
labelId?: string;
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* Filter by label name attached to the plan job. More user-friendly alternative to
|
|
1035
|
+
* labelId. Case-insensitive.
|
|
1036
|
+
*/
|
|
1037
|
+
labelName?: string;
|
|
1038
|
+
|
|
1039
|
+
/**
|
|
1040
|
+
* Maximum number of plan jobs to return (default: 20, max: 50)
|
|
1041
|
+
*/
|
|
1042
|
+
limit?: number;
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* Filter by simulation run plan ID
|
|
1046
|
+
*/
|
|
1047
|
+
simulationRunPlanId?: string;
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* Filter by plan job status (PENDING, CREATING_SNAPSHOTS, CREATING_SIMULATIONS,
|
|
1051
|
+
* RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING)
|
|
1052
|
+
*/
|
|
1053
|
+
status?: string;
|
|
1054
|
+
}
|
|
1055
|
+
|
|
894
1056
|
export interface SimulationListScenariosParams {
|
|
895
1057
|
after?: string;
|
|
896
1058
|
|
|
@@ -917,9 +1079,11 @@ export declare namespace Simulation {
|
|
|
917
1079
|
export {
|
|
918
1080
|
type SimulationGetRunPlanJobResponse as SimulationGetRunPlanJobResponse,
|
|
919
1081
|
type SimulationGetSimulationJobByIDResponse as SimulationGetSimulationJobByIDResponse,
|
|
1082
|
+
type SimulationListRunPlanJobsResponse as SimulationListRunPlanJobsResponse,
|
|
920
1083
|
type SimulationListScenariosResponse as SimulationListScenariosResponse,
|
|
921
1084
|
type SimulationLookupSimulationJobResponse as SimulationLookupSimulationJobResponse,
|
|
922
1085
|
type SimulationStartRunPlanJobResponse as SimulationStartRunPlanJobResponse,
|
|
1086
|
+
type SimulationListRunPlanJobsParams as SimulationListRunPlanJobsParams,
|
|
923
1087
|
type SimulationListScenariosParams as SimulationListScenariosParams,
|
|
924
1088
|
type SimulationLookupSimulationJobParams as SimulationLookupSimulationJobParams,
|
|
925
1089
|
};
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '2.
|
|
1
|
+
export const VERSION = '2.19.0'; // x-release-please-version
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "2.
|
|
1
|
+
export declare const VERSION = "2.19.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '2.
|
|
1
|
+
export const VERSION = '2.19.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|