@amigo-ai/platform-sdk 0.5.2 → 0.5.3
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/README.md +81 -7
- package/api.md +3 -0
- package/dist/index.cjs +42 -10
- package/dist/index.cjs.map +2 -2
- package/dist/index.mjs +42 -10
- package/dist/index.mjs.map +2 -2
- package/dist/resources/base.js +7 -2
- package/dist/resources/base.js.map +1 -1
- package/dist/resources/operators.js.map +1 -1
- package/dist/resources/personas.js.map +1 -1
- package/dist/resources/webhook-destinations.js.map +1 -1
- package/dist/resources/workspaces.js +22 -0
- package/dist/resources/workspaces.js.map +1 -1
- package/dist/resources/world.js.map +1 -1
- package/dist/types/generated/api.d.ts +13373 -13213
- package/dist/types/generated/api.d.ts.map +1 -1
- package/dist/types/resources/actions.d.ts +166 -166
- package/dist/types/resources/agents.d.ts +88 -88
- package/dist/types/resources/analytics.d.ts +39 -39
- package/dist/types/resources/api-keys.d.ts +29 -29
- package/dist/types/resources/audit.d.ts +73 -73
- package/dist/types/resources/base.d.ts.map +1 -1
- package/dist/types/resources/billing.d.ts +36 -36
- package/dist/types/resources/calls.d.ts +106 -106
- package/dist/types/resources/compliance.d.ts +17 -17
- package/dist/types/resources/context-graphs.d.ts +643 -643
- package/dist/types/resources/data-sources.d.ts +81 -81
- package/dist/types/resources/functions.d.ts +22 -22
- package/dist/types/resources/functions.d.ts.map +1 -1
- package/dist/types/resources/integrations.d.ts +258 -258
- package/dist/types/resources/memory.d.ts +35 -35
- package/dist/types/resources/operators.d.ts +147 -147
- package/dist/types/resources/operators.d.ts.map +1 -1
- package/dist/types/resources/personas.d.ts +37 -37
- package/dist/types/resources/personas.d.ts.map +1 -1
- package/dist/types/resources/phone-numbers.d.ts +62 -62
- package/dist/types/resources/recordings.d.ts +9 -9
- package/dist/types/resources/review-queue.d.ts +331 -331
- package/dist/types/resources/safety.d.ts +33 -33
- package/dist/types/resources/services.d.ts +142 -142
- package/dist/types/resources/settings.d.ts +254 -254
- package/dist/types/resources/settings.d.ts.map +1 -1
- package/dist/types/resources/simulations.d.ts +73 -73
- package/dist/types/resources/skills.d.ts +163 -163
- package/dist/types/resources/triggers.d.ts +74 -74
- package/dist/types/resources/webhook-destinations.d.ts +57 -57
- package/dist/types/resources/webhook-destinations.d.ts.map +1 -1
- package/dist/types/resources/workspaces.d.ts +69 -35
- package/dist/types/resources/workspaces.d.ts.map +1 -1
- package/dist/types/resources/world.d.ts +216 -216
- package/dist/types/resources/world.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -28,153 +28,153 @@ export interface EntityAccessLogParams {
|
|
|
28
28
|
export declare class AuditResource extends WorkspaceScopedResource {
|
|
29
29
|
list(params?: ListAuditParams): Promise<{
|
|
30
30
|
events: {
|
|
31
|
-
action: string;
|
|
32
|
-
actor_credential_id?: string | null | undefined;
|
|
33
|
-
actor_entity_id?: string | null | undefined;
|
|
34
31
|
id: string;
|
|
32
|
+
workspace_id: string;
|
|
33
|
+
timestamp: string;
|
|
34
|
+
service: string;
|
|
35
|
+
actor_entity_id?: string | null | undefined;
|
|
36
|
+
actor_credential_id?: string | null | undefined;
|
|
37
|
+
action: string;
|
|
38
|
+
resource_type: string;
|
|
39
|
+
resource_id?: string | null | undefined;
|
|
40
|
+
resource_name?: string | null | undefined;
|
|
35
41
|
ip_address?: string | null | undefined;
|
|
42
|
+
user_agent?: string | null | undefined;
|
|
36
43
|
metadata?: {
|
|
37
44
|
[x: string]: unknown;
|
|
38
45
|
} | null | undefined;
|
|
39
46
|
phi_accessed?: boolean | undefined;
|
|
40
|
-
resource_id?: string | null | undefined;
|
|
41
|
-
resource_name?: string | null | undefined;
|
|
42
|
-
resource_type: string;
|
|
43
|
-
service: string;
|
|
44
|
-
timestamp: string;
|
|
45
|
-
user_agent?: string | null | undefined;
|
|
46
|
-
workspace_id: string;
|
|
47
47
|
}[];
|
|
48
|
-
|
|
48
|
+
total: number;
|
|
49
49
|
limit: number;
|
|
50
50
|
offset: number;
|
|
51
|
-
|
|
51
|
+
has_more: boolean;
|
|
52
52
|
} & import("../index.js").ResponseMetadata>;
|
|
53
53
|
listAutoPaging(params?: ListAuditParams): AsyncGenerator<{
|
|
54
|
-
action: string;
|
|
55
|
-
actor_credential_id?: string | null | undefined;
|
|
56
|
-
actor_entity_id?: string | null | undefined;
|
|
57
54
|
id: string;
|
|
55
|
+
workspace_id: string;
|
|
56
|
+
timestamp: string;
|
|
57
|
+
service: string;
|
|
58
|
+
actor_entity_id?: string | null | undefined;
|
|
59
|
+
actor_credential_id?: string | null | undefined;
|
|
60
|
+
action: string;
|
|
61
|
+
resource_type: string;
|
|
62
|
+
resource_id?: string | null | undefined;
|
|
63
|
+
resource_name?: string | null | undefined;
|
|
58
64
|
ip_address?: string | null | undefined;
|
|
65
|
+
user_agent?: string | null | undefined;
|
|
59
66
|
metadata?: {
|
|
60
67
|
[x: string]: unknown;
|
|
61
68
|
} | null | undefined;
|
|
62
69
|
phi_accessed?: boolean | undefined;
|
|
63
|
-
resource_id?: string | null | undefined;
|
|
64
|
-
resource_name?: string | null | undefined;
|
|
65
|
-
resource_type: string;
|
|
66
|
-
service: string;
|
|
67
|
-
timestamp: string;
|
|
68
|
-
user_agent?: string | null | undefined;
|
|
69
|
-
workspace_id: string;
|
|
70
70
|
}, any, any>;
|
|
71
71
|
getSummary(params?: {
|
|
72
72
|
date_from?: string | null;
|
|
73
73
|
date_to?: string | null;
|
|
74
74
|
}): Promise<{
|
|
75
|
-
phi_access_events: number;
|
|
76
|
-
services_with_events: number;
|
|
77
75
|
total_events: number;
|
|
76
|
+
phi_access_events: number;
|
|
78
77
|
unique_actors: number;
|
|
78
|
+
services_with_events: number;
|
|
79
79
|
} & import("../index.js").ResponseMetadata>;
|
|
80
80
|
getPhiAccess(params?: PhiAccessParams): Promise<{
|
|
81
81
|
events: {
|
|
82
|
-
action: string;
|
|
83
|
-
actor_credential_id?: string | null | undefined;
|
|
84
|
-
actor_entity_id?: string | null | undefined;
|
|
85
82
|
id: string;
|
|
83
|
+
workspace_id: string;
|
|
84
|
+
timestamp: string;
|
|
85
|
+
service: string;
|
|
86
|
+
actor_entity_id?: string | null | undefined;
|
|
87
|
+
actor_credential_id?: string | null | undefined;
|
|
88
|
+
action: string;
|
|
89
|
+
resource_type: string;
|
|
90
|
+
resource_id?: string | null | undefined;
|
|
91
|
+
resource_name?: string | null | undefined;
|
|
86
92
|
ip_address?: string | null | undefined;
|
|
93
|
+
user_agent?: string | null | undefined;
|
|
87
94
|
metadata?: {
|
|
88
95
|
[x: string]: unknown;
|
|
89
96
|
} | null | undefined;
|
|
90
97
|
phi_accessed?: boolean | undefined;
|
|
91
|
-
resource_id?: string | null | undefined;
|
|
92
|
-
resource_name?: string | null | undefined;
|
|
93
|
-
resource_type: string;
|
|
94
|
-
service: string;
|
|
95
|
-
timestamp: string;
|
|
96
|
-
user_agent?: string | null | undefined;
|
|
97
|
-
workspace_id: string;
|
|
98
98
|
}[];
|
|
99
|
-
|
|
99
|
+
total: number;
|
|
100
100
|
limit: number;
|
|
101
101
|
offset: number;
|
|
102
|
-
|
|
102
|
+
has_more: boolean;
|
|
103
103
|
} & import("../index.js").ResponseMetadata>;
|
|
104
104
|
getPhiAccessAutoPaging(params?: PhiAccessParams): AsyncGenerator<{
|
|
105
|
-
action: string;
|
|
106
|
-
actor_credential_id?: string | null | undefined;
|
|
107
|
-
actor_entity_id?: string | null | undefined;
|
|
108
105
|
id: string;
|
|
106
|
+
workspace_id: string;
|
|
107
|
+
timestamp: string;
|
|
108
|
+
service: string;
|
|
109
|
+
actor_entity_id?: string | null | undefined;
|
|
110
|
+
actor_credential_id?: string | null | undefined;
|
|
111
|
+
action: string;
|
|
112
|
+
resource_type: string;
|
|
113
|
+
resource_id?: string | null | undefined;
|
|
114
|
+
resource_name?: string | null | undefined;
|
|
109
115
|
ip_address?: string | null | undefined;
|
|
116
|
+
user_agent?: string | null | undefined;
|
|
110
117
|
metadata?: {
|
|
111
118
|
[x: string]: unknown;
|
|
112
119
|
} | null | undefined;
|
|
113
120
|
phi_accessed?: boolean | undefined;
|
|
114
|
-
resource_id?: string | null | undefined;
|
|
115
|
-
resource_name?: string | null | undefined;
|
|
116
|
-
resource_type: string;
|
|
117
|
-
service: string;
|
|
118
|
-
timestamp: string;
|
|
119
|
-
user_agent?: string | null | undefined;
|
|
120
|
-
workspace_id: string;
|
|
121
121
|
}, any, any>;
|
|
122
122
|
createExport(body: components['schemas']['AuditExportRequest']): Promise<{
|
|
123
|
-
created_at: string;
|
|
124
|
-
download_url: string;
|
|
125
123
|
export_id: string;
|
|
126
|
-
row_count: number;
|
|
127
124
|
s3_key: string;
|
|
125
|
+
row_count: number;
|
|
126
|
+
download_url: string;
|
|
127
|
+
created_at: string;
|
|
128
128
|
} & import("../index.js").ResponseMetadata>;
|
|
129
129
|
listExports(): Promise<{
|
|
130
130
|
exports: {
|
|
131
|
-
download_url?: string | null | undefined;
|
|
132
131
|
key: string;
|
|
133
|
-
last_modified?: string | null | undefined;
|
|
134
132
|
size: number;
|
|
133
|
+
last_modified?: string | null | undefined;
|
|
134
|
+
download_url?: string | null | undefined;
|
|
135
135
|
}[];
|
|
136
136
|
} & import("../index.js").ResponseMetadata>;
|
|
137
137
|
getEntityAccessLog(entityId: string, params?: EntityAccessLogParams): Promise<{
|
|
138
138
|
events: {
|
|
139
|
-
action: string;
|
|
140
|
-
actor_credential_id?: string | null | undefined;
|
|
141
|
-
actor_entity_id?: string | null | undefined;
|
|
142
139
|
id: string;
|
|
140
|
+
workspace_id: string;
|
|
141
|
+
timestamp: string;
|
|
142
|
+
service: string;
|
|
143
|
+
actor_entity_id?: string | null | undefined;
|
|
144
|
+
actor_credential_id?: string | null | undefined;
|
|
145
|
+
action: string;
|
|
146
|
+
resource_type: string;
|
|
147
|
+
resource_id?: string | null | undefined;
|
|
148
|
+
resource_name?: string | null | undefined;
|
|
143
149
|
ip_address?: string | null | undefined;
|
|
150
|
+
user_agent?: string | null | undefined;
|
|
144
151
|
metadata?: {
|
|
145
152
|
[x: string]: unknown;
|
|
146
153
|
} | null | undefined;
|
|
147
154
|
phi_accessed?: boolean | undefined;
|
|
148
|
-
resource_id?: string | null | undefined;
|
|
149
|
-
resource_name?: string | null | undefined;
|
|
150
|
-
resource_type: string;
|
|
151
|
-
service: string;
|
|
152
|
-
timestamp: string;
|
|
153
|
-
user_agent?: string | null | undefined;
|
|
154
|
-
workspace_id: string;
|
|
155
155
|
}[];
|
|
156
|
-
|
|
156
|
+
total: number;
|
|
157
157
|
limit: number;
|
|
158
158
|
offset: number;
|
|
159
|
-
|
|
159
|
+
has_more: boolean;
|
|
160
160
|
} & import("../index.js").ResponseMetadata>;
|
|
161
161
|
getEntityAccessLogAutoPaging(entityId: string, params?: EntityAccessLogParams): AsyncGenerator<{
|
|
162
|
-
action: string;
|
|
163
|
-
actor_credential_id?: string | null | undefined;
|
|
164
|
-
actor_entity_id?: string | null | undefined;
|
|
165
162
|
id: string;
|
|
163
|
+
workspace_id: string;
|
|
164
|
+
timestamp: string;
|
|
165
|
+
service: string;
|
|
166
|
+
actor_entity_id?: string | null | undefined;
|
|
167
|
+
actor_credential_id?: string | null | undefined;
|
|
168
|
+
action: string;
|
|
169
|
+
resource_type: string;
|
|
170
|
+
resource_id?: string | null | undefined;
|
|
171
|
+
resource_name?: string | null | undefined;
|
|
166
172
|
ip_address?: string | null | undefined;
|
|
173
|
+
user_agent?: string | null | undefined;
|
|
167
174
|
metadata?: {
|
|
168
175
|
[x: string]: unknown;
|
|
169
176
|
} | null | undefined;
|
|
170
177
|
phi_accessed?: boolean | undefined;
|
|
171
|
-
resource_id?: string | null | undefined;
|
|
172
|
-
resource_name?: string | null | undefined;
|
|
173
|
-
resource_type: string;
|
|
174
|
-
service: string;
|
|
175
|
-
timestamp: string;
|
|
176
|
-
user_agent?: string | null | undefined;
|
|
177
|
-
workspace_id: string;
|
|
178
178
|
}, any, any>;
|
|
179
179
|
}
|
|
180
180
|
//# sourceMappingURL=audit.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/resources/base.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAA+B,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC3F,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAO9C,8BAAsB,uBAAuB;IAEzC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa;IACxC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM;gBADnB,MAAM,EAAE,aAAa,EACrB,WAAW,EAAE,MAAM;IAGxC,WAAW,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;cAQ/B,oBAAoB,CACnC,KAAK,SAAS;QACZ,KAAK,CAAC,EAAE,SAAS,OAAO,EAAE,CAAA;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACnC,EACD,OAAO,EAEP,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK,CAAC,EAC9C,MAAM,EAAE,OAAO,GACd,cAAc,CAAC,KAAK,SAAS;QAAE,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAA;KAAE,GAAG,KAAK,GAAG,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/resources/base.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAA+B,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC3F,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAO9C,8BAAsB,uBAAuB;IAEzC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa;IACxC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM;gBADnB,MAAM,EAAE,aAAa,EACrB,WAAW,EAAE,MAAM;IAGxC,WAAW,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;cAQ/B,oBAAoB,CACnC,KAAK,SAAS;QACZ,KAAK,CAAC,EAAE,SAAS,OAAO,EAAE,CAAA;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACnC,EACD,OAAO,EAEP,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK,CAAC,EAC9C,MAAM,EAAE,OAAO,GACd,cAAc,CAAC,KAAK,SAAS;QAAE,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAA;KAAE,GAAG,KAAK,GAAG,KAAK,CAAC;cA0BpE,0BAA0B,CACzC,KAAK,SAAS;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EACjE,KAAK,EACL,OAAO,EAEP,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK,CAAC,EAC9C,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,SAAS,KAAK,EAAE,EAC9C,MAAM,EAAE,OAAO,GACd,cAAc,CAAC,KAAK,CAAC;CAiBzB;AAED,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,oBAAoB,GAC5B,aAAa,CAoFf;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,aAAa,GAAG;IAClE,UAAU,EAAE,aAAa,CAAA;IACzB,OAAO,EAAE,oBAAoB,GAAG,SAAS,CAAA;CAC1C,CAMA;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}
|
|
@@ -17,21 +17,21 @@ export interface UsageTrendsParams {
|
|
|
17
17
|
export declare class BillingResource extends WorkspaceScopedResource {
|
|
18
18
|
/** Get composite billing dashboard — KPIs, period comparison, top meters, invoice summary */
|
|
19
19
|
getDashboard(): Promise<{
|
|
20
|
+
workspace_id: string;
|
|
20
21
|
current_period_total: number;
|
|
21
|
-
delta_pct: number | null;
|
|
22
|
-
invoice_status_summary: {
|
|
23
|
-
[x: string]: number;
|
|
24
|
-
};
|
|
25
|
-
period_end: string | null;
|
|
26
|
-
period_start: string | null;
|
|
27
22
|
previous_period_total: number | null;
|
|
23
|
+
delta_pct: number | null;
|
|
28
24
|
top_meters: {
|
|
29
|
-
display_name: string;
|
|
30
25
|
meter_key: string;
|
|
31
|
-
|
|
26
|
+
display_name: string;
|
|
32
27
|
value: number;
|
|
28
|
+
unit: string;
|
|
33
29
|
}[];
|
|
34
|
-
|
|
30
|
+
invoice_status_summary: {
|
|
31
|
+
[x: string]: number;
|
|
32
|
+
};
|
|
33
|
+
period_start: string | null;
|
|
34
|
+
period_end: string | null;
|
|
35
35
|
} & import("../index.js").ResponseMetadata>;
|
|
36
36
|
/** Get usage summary for the workspace */
|
|
37
37
|
getUsage(): Promise<{
|
|
@@ -39,62 +39,62 @@ export declare class BillingResource extends WorkspaceScopedResource {
|
|
|
39
39
|
} & import("../index.js").ResponseMetadata>;
|
|
40
40
|
/** Get usage time-series per meter for trend charts */
|
|
41
41
|
getUsageTrends(params?: UsageTrendsParams): Promise<{
|
|
42
|
-
meter_key: string;
|
|
43
|
-
period_end: string;
|
|
44
42
|
period_start: string;
|
|
45
|
-
|
|
43
|
+
period_end: string;
|
|
44
|
+
meter_key: string;
|
|
46
45
|
value: number;
|
|
46
|
+
unit: string;
|
|
47
47
|
}[] & import("../index.js").ResponseMetadata>;
|
|
48
48
|
/** List invoices for the workspace */
|
|
49
49
|
listInvoices(params?: ListInvoicesParams): Promise<{
|
|
50
|
-
continuation_token?: number | null | undefined;
|
|
51
|
-
has_more: boolean;
|
|
52
50
|
items: {
|
|
53
|
-
adjustments: string;
|
|
54
|
-
created_at: string | null;
|
|
55
|
-
customer_id: string;
|
|
56
51
|
id: string;
|
|
52
|
+
customer_id: string;
|
|
57
53
|
invoice_number: string;
|
|
54
|
+
period_start: string;
|
|
55
|
+
period_end: string;
|
|
56
|
+
subtotal: string;
|
|
57
|
+
adjustments: string;
|
|
58
|
+
total: string;
|
|
59
|
+
status: "draft" | "sent" | "paid" | "void";
|
|
58
60
|
line_items: {
|
|
59
|
-
description?: string | undefined;
|
|
60
61
|
meter_key: string;
|
|
62
|
+
description?: string | undefined;
|
|
61
63
|
quantity: string;
|
|
62
|
-
total: string;
|
|
63
64
|
unit_price: string;
|
|
65
|
+
total: string;
|
|
64
66
|
}[];
|
|
65
|
-
paid_at: string | null;
|
|
66
67
|
pdf_s3_key: string | null;
|
|
67
|
-
period_end: string;
|
|
68
|
-
period_start: string;
|
|
69
68
|
sent_at: string | null;
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
total: string;
|
|
69
|
+
paid_at: string | null;
|
|
70
|
+
created_at: string | null;
|
|
73
71
|
updated_at: string | null;
|
|
74
72
|
}[];
|
|
73
|
+
has_more: boolean;
|
|
74
|
+
continuation_token?: number | null | undefined;
|
|
75
75
|
total?: number | null | undefined;
|
|
76
76
|
} & import("../index.js").ResponseMetadata>;
|
|
77
77
|
listInvoicesAutoPaging(params?: ListInvoicesParams): AsyncGenerator<{
|
|
78
|
-
adjustments: string;
|
|
79
|
-
created_at: string | null;
|
|
80
|
-
customer_id: string;
|
|
81
78
|
id: string;
|
|
79
|
+
customer_id: string;
|
|
82
80
|
invoice_number: string;
|
|
81
|
+
period_start: string;
|
|
82
|
+
period_end: string;
|
|
83
|
+
subtotal: string;
|
|
84
|
+
adjustments: string;
|
|
85
|
+
total: string;
|
|
86
|
+
status: "draft" | "sent" | "paid" | "void";
|
|
83
87
|
line_items: {
|
|
84
|
-
description?: string | undefined;
|
|
85
88
|
meter_key: string;
|
|
89
|
+
description?: string | undefined;
|
|
86
90
|
quantity: string;
|
|
87
|
-
total: string;
|
|
88
91
|
unit_price: string;
|
|
92
|
+
total: string;
|
|
89
93
|
}[];
|
|
90
|
-
paid_at: string | null;
|
|
91
94
|
pdf_s3_key: string | null;
|
|
92
|
-
period_end: string;
|
|
93
|
-
period_start: string;
|
|
94
95
|
sent_at: string | null;
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
total: string;
|
|
96
|
+
paid_at: string | null;
|
|
97
|
+
created_at: string | null;
|
|
98
98
|
updated_at: string | null;
|
|
99
99
|
}, any, any>;
|
|
100
100
|
/** Get invoice detail */
|
|
@@ -20,51 +20,51 @@ export interface ListCallsParams extends ListParams {
|
|
|
20
20
|
export declare class CallsResource extends WorkspaceScopedResource {
|
|
21
21
|
/** List calls with optional filtering */
|
|
22
22
|
list(params?: ListCallsParams): Promise<{
|
|
23
|
-
continuation_token?: number | null | undefined;
|
|
24
|
-
has_more: boolean;
|
|
25
23
|
items: {
|
|
24
|
+
entity_id: string;
|
|
26
25
|
call_sid?: string | null | undefined;
|
|
27
|
-
caller_id?: string | null | undefined;
|
|
28
|
-
completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null | undefined;
|
|
29
26
|
direction?: ("inbound" | "outbound" | "playground" | "simulated" | "test") | null | undefined;
|
|
27
|
+
phone_number?: string | null | undefined;
|
|
28
|
+
caller_id?: string | null | undefined;
|
|
29
|
+
started_at?: string | null | undefined;
|
|
30
30
|
duration_seconds?: number | null | undefined;
|
|
31
|
-
|
|
31
|
+
status?: ("initiated" | "ringing" | "in-progress" | "completed" | "busy" | "no-answer" | "canceled" | "failed" | "unknown") | null | undefined;
|
|
32
32
|
escalation_status?: ("none" | "requested" | "connected" | "handback" | "completed") | null | undefined;
|
|
33
|
-
|
|
34
|
-
fork_turn_index?: number | null | undefined;
|
|
33
|
+
turns?: number | null | undefined;
|
|
35
34
|
has_recording?: boolean | null | undefined;
|
|
36
|
-
parent_session_id?: string | null | undefined;
|
|
37
|
-
phone_number?: string | null | undefined;
|
|
38
35
|
quality_score?: number | null | undefined;
|
|
39
|
-
|
|
36
|
+
final_state?: string | null | undefined;
|
|
37
|
+
completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null | undefined;
|
|
40
38
|
service_id?: string | null | undefined;
|
|
41
39
|
source?: ("real" | "simulated" | "playground" | "scribe") | null | undefined;
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
40
|
+
run_id?: string | null | undefined;
|
|
41
|
+
parent_session_id?: string | null | undefined;
|
|
42
|
+
fork_turn_index?: number | null | undefined;
|
|
45
43
|
}[];
|
|
46
44
|
total: number;
|
|
45
|
+
has_more: boolean;
|
|
46
|
+
continuation_token?: number | null | undefined;
|
|
47
47
|
} & import("../index.js").ResponseMetadata>;
|
|
48
48
|
listAutoPaging(params?: ListCallsParams): AsyncGenerator<{
|
|
49
|
+
entity_id: string;
|
|
49
50
|
call_sid?: string | null | undefined;
|
|
50
|
-
caller_id?: string | null | undefined;
|
|
51
|
-
completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null | undefined;
|
|
52
51
|
direction?: ("inbound" | "outbound" | "playground" | "simulated" | "test") | null | undefined;
|
|
52
|
+
phone_number?: string | null | undefined;
|
|
53
|
+
caller_id?: string | null | undefined;
|
|
54
|
+
started_at?: string | null | undefined;
|
|
53
55
|
duration_seconds?: number | null | undefined;
|
|
54
|
-
|
|
56
|
+
status?: ("initiated" | "ringing" | "in-progress" | "completed" | "busy" | "no-answer" | "canceled" | "failed" | "unknown") | null | undefined;
|
|
55
57
|
escalation_status?: ("none" | "requested" | "connected" | "handback" | "completed") | null | undefined;
|
|
56
|
-
|
|
57
|
-
fork_turn_index?: number | null | undefined;
|
|
58
|
+
turns?: number | null | undefined;
|
|
58
59
|
has_recording?: boolean | null | undefined;
|
|
59
|
-
parent_session_id?: string | null | undefined;
|
|
60
|
-
phone_number?: string | null | undefined;
|
|
61
60
|
quality_score?: number | null | undefined;
|
|
62
|
-
|
|
61
|
+
final_state?: string | null | undefined;
|
|
62
|
+
completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null | undefined;
|
|
63
63
|
service_id?: string | null | undefined;
|
|
64
64
|
source?: ("real" | "simulated" | "playground" | "scribe") | null | undefined;
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
65
|
+
run_id?: string | null | undefined;
|
|
66
|
+
parent_session_id?: string | null | undefined;
|
|
67
|
+
fork_turn_index?: number | null | undefined;
|
|
68
68
|
}, any, any>;
|
|
69
69
|
/** Get full call detail including turns, escalation, safety, and recording info */
|
|
70
70
|
get(callId: string): Promise<{
|
|
@@ -74,66 +74,66 @@ export declare class CallsResource extends WorkspaceScopedResource {
|
|
|
74
74
|
getIntelligence(callId: string): Promise<{
|
|
75
75
|
call_id: string;
|
|
76
76
|
call_sid?: string | null | undefined;
|
|
77
|
-
completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null | undefined;
|
|
78
|
-
conversation_summary?: {
|
|
79
|
-
avg_turn_duration_seconds?: number | null | undefined;
|
|
80
|
-
barge_in_count?: number | undefined;
|
|
81
|
-
loop_count?: number | undefined;
|
|
82
|
-
topic_changes?: number | undefined;
|
|
83
|
-
} | null | undefined;
|
|
84
|
-
created_at?: string | null | undefined;
|
|
85
77
|
direction?: "inbound" | "outbound" | "playground" | "simulated" | "test" | undefined;
|
|
86
78
|
duration_seconds?: number | undefined;
|
|
87
|
-
|
|
88
|
-
avg_valence?: number | null | undefined;
|
|
89
|
-
caller_distress_detected?: boolean | undefined;
|
|
90
|
-
dominant_emotion?: string | null | undefined;
|
|
91
|
-
emotion_shifts?: number | undefined;
|
|
92
|
-
} | null | undefined;
|
|
93
|
-
final_state?: string | null | undefined;
|
|
94
|
-
key_moments?: {
|
|
95
|
-
description: string;
|
|
96
|
-
severity?: "info" | "warning" | "error" | undefined;
|
|
97
|
-
turn?: number | null | undefined;
|
|
98
|
-
type: "latency_spike" | "silence" | "barge_in" | "loop" | "tool_failure" | "escalation" | "safety_flag" | "high_risk" | "elevated_risk";
|
|
99
|
-
}[] | undefined;
|
|
100
|
-
latency_summary?: {
|
|
101
|
-
p50_audio_ttfb_ms?: number | null | undefined;
|
|
102
|
-
p95_audio_ttfb_ms?: number | null | undefined;
|
|
103
|
-
silence_ratio?: number | null | undefined;
|
|
104
|
-
total_silence_seconds?: number | null | undefined;
|
|
105
|
-
} | null | undefined;
|
|
106
|
-
operator_summary?: {
|
|
107
|
-
escalated?: boolean | undefined;
|
|
108
|
-
operator_handle_time_seconds?: number | null | undefined;
|
|
109
|
-
} | null | undefined;
|
|
79
|
+
quality_score?: number | null | undefined;
|
|
110
80
|
quality_breakdown?: {
|
|
81
|
+
score: number;
|
|
111
82
|
components: {
|
|
112
83
|
name: "latency" | "silence" | "barge_ins" | "loops" | "escalation" | "tool_failures";
|
|
113
84
|
penalty: number;
|
|
114
|
-
severity?: "none" | "minor" | "major" | "critical" | undefined;
|
|
115
|
-
threshold?: string | null | undefined;
|
|
116
85
|
value?: number | null | undefined;
|
|
86
|
+
threshold?: string | null | undefined;
|
|
87
|
+
severity?: "none" | "minor" | "major" | "critical" | undefined;
|
|
117
88
|
}[];
|
|
118
|
-
score: number;
|
|
119
89
|
workspace_avg?: number | null | undefined;
|
|
120
90
|
workspace_percentile?: number | null | undefined;
|
|
121
91
|
} | null | undefined;
|
|
122
|
-
|
|
92
|
+
key_moments?: {
|
|
93
|
+
turn?: number | null | undefined;
|
|
94
|
+
type: "latency_spike" | "silence" | "barge_in" | "loop" | "tool_failure" | "escalation" | "safety_flag" | "high_risk" | "elevated_risk";
|
|
95
|
+
severity?: "info" | "warning" | "error" | undefined;
|
|
96
|
+
description: string;
|
|
97
|
+
}[] | undefined;
|
|
98
|
+
emotion_summary?: {
|
|
99
|
+
dominant_emotion?: string | null | undefined;
|
|
100
|
+
avg_valence?: number | null | undefined;
|
|
101
|
+
emotion_shifts?: number | undefined;
|
|
102
|
+
caller_distress_detected?: boolean | undefined;
|
|
103
|
+
} | null | undefined;
|
|
123
104
|
risk_summary?: {
|
|
124
105
|
composite_score?: number | undefined;
|
|
125
|
-
flags?: string[] | undefined;
|
|
126
106
|
level?: "low" | "medium" | "high" | "critical" | undefined;
|
|
107
|
+
flags?: string[] | undefined;
|
|
127
108
|
} | null | undefined;
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
109
|
+
latency_summary?: {
|
|
110
|
+
p50_audio_ttfb_ms?: number | null | undefined;
|
|
111
|
+
p95_audio_ttfb_ms?: number | null | undefined;
|
|
112
|
+
silence_ratio?: number | null | undefined;
|
|
113
|
+
total_silence_seconds?: number | null | undefined;
|
|
114
|
+
} | null | undefined;
|
|
115
|
+
conversation_summary?: {
|
|
116
|
+
barge_in_count?: number | undefined;
|
|
117
|
+
loop_count?: number | undefined;
|
|
118
|
+
topic_changes?: number | undefined;
|
|
119
|
+
avg_turn_duration_seconds?: number | null | undefined;
|
|
131
120
|
} | null | undefined;
|
|
132
121
|
tool_summary?: {
|
|
122
|
+
total_calls?: number | undefined;
|
|
133
123
|
failed?: number | undefined;
|
|
134
124
|
failure_rate?: number | undefined;
|
|
135
|
-
total_calls?: number | undefined;
|
|
136
125
|
} | null | undefined;
|
|
126
|
+
safety_summary?: {
|
|
127
|
+
match_count?: number | undefined;
|
|
128
|
+
categories?: string[] | undefined;
|
|
129
|
+
} | null | undefined;
|
|
130
|
+
operator_summary?: {
|
|
131
|
+
escalated?: boolean | undefined;
|
|
132
|
+
operator_handle_time_seconds?: number | null | undefined;
|
|
133
|
+
} | null | undefined;
|
|
134
|
+
completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null | undefined;
|
|
135
|
+
final_state?: string | null | undefined;
|
|
136
|
+
created_at?: string | null | undefined;
|
|
137
137
|
} & import("../index.js").ResponseMetadata>;
|
|
138
138
|
/** Get active intelligence across all in-progress calls */
|
|
139
139
|
getActiveIntelligence(): Promise<{
|
|
@@ -143,86 +143,86 @@ export declare class CallsResource extends WorkspaceScopedResource {
|
|
|
143
143
|
getBenchmarks(params?: {
|
|
144
144
|
days?: number;
|
|
145
145
|
}): Promise<{
|
|
146
|
-
avg_duration_seconds?: number | null | undefined;
|
|
147
146
|
avg_quality_score?: number | null | undefined;
|
|
148
|
-
escalation_rate?: number | undefined;
|
|
149
|
-
p25_quality_score?: number | null | undefined;
|
|
150
147
|
p50_quality_score?: number | null | undefined;
|
|
148
|
+
p25_quality_score?: number | null | undefined;
|
|
151
149
|
p75_quality_score?: number | null | undefined;
|
|
150
|
+
total_calls?: number | undefined;
|
|
151
|
+
avg_duration_seconds?: number | null | undefined;
|
|
152
|
+
escalation_rate?: number | undefined;
|
|
152
153
|
quality_distribution?: {
|
|
153
154
|
[x: string]: number;
|
|
154
155
|
} | undefined;
|
|
155
|
-
total_calls?: number | undefined;
|
|
156
156
|
} & import("../index.js").ResponseMetadata>;
|
|
157
157
|
/** Get phone number call volume breakdown */
|
|
158
158
|
getPhoneVolume(params?: {
|
|
159
159
|
days?: number;
|
|
160
160
|
}): Promise<{
|
|
161
|
+
phone_number: string;
|
|
162
|
+
total_calls: number;
|
|
163
|
+
inbound: number;
|
|
164
|
+
outbound: number;
|
|
161
165
|
avg_duration_seconds?: number | null | undefined;
|
|
162
166
|
by_date?: {
|
|
163
|
-
count: number;
|
|
164
167
|
date: string;
|
|
168
|
+
count: number;
|
|
165
169
|
}[] | undefined;
|
|
166
|
-
inbound: number;
|
|
167
|
-
outbound: number;
|
|
168
|
-
phone_number: string;
|
|
169
|
-
total_calls: number;
|
|
170
170
|
}[] & import("../index.js").ResponseMetadata>;
|
|
171
171
|
/** Get deep call trace analysis */
|
|
172
172
|
getTraceAnalysis(callId: string): Promise<{
|
|
173
|
-
call_entity_id?: string | null | undefined;
|
|
174
173
|
call_sid: string;
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
}[] | undefined;
|
|
181
|
-
computed_at?: string | null | undefined;
|
|
182
|
-
counterfactuals?: {
|
|
183
|
-
actual: string;
|
|
184
|
-
alternative: string;
|
|
185
|
-
predicted_impact: string;
|
|
174
|
+
status?: "ready" | "pending" | "unavailable" | undefined;
|
|
175
|
+
summary?: string | null | undefined;
|
|
176
|
+
outcome?: ("succeeded" | "partially" | "failed" | "abandoned") | null | undefined;
|
|
177
|
+
key_moment_count?: number | undefined;
|
|
178
|
+
key_moments?: {
|
|
186
179
|
timestamp_seconds?: number | null | undefined;
|
|
180
|
+
what_happened: string;
|
|
181
|
+
quality?: ("optimal" | "adequate" | "suboptimal") | null | undefined;
|
|
182
|
+
reasoning?: string | null | undefined;
|
|
183
|
+
decision_factors?: {
|
|
184
|
+
factor: string;
|
|
185
|
+
source_type: "transcript" | "tone" | "tool_result" | "emotion" | "silence" | "barge_in" | "breathing" | "speech_rate";
|
|
186
|
+
}[] | undefined;
|
|
187
|
+
alternative?: string | null | undefined;
|
|
187
188
|
}[] | undefined;
|
|
188
|
-
deep_understanding?: string | null | undefined;
|
|
189
|
-
emergent_patterns?: string[] | undefined;
|
|
190
189
|
emotional_arc?: string | null | undefined;
|
|
191
190
|
emotional_shifts?: {
|
|
192
|
-
agent_awareness?: string | null | undefined;
|
|
193
|
-
from_state?: string | null | undefined;
|
|
194
191
|
timestamp_seconds?: number | null | undefined;
|
|
192
|
+
from_state?: string | null | undefined;
|
|
195
193
|
to_state?: string | null | undefined;
|
|
196
194
|
trigger?: string | null | undefined;
|
|
195
|
+
agent_awareness?: string | null | undefined;
|
|
197
196
|
}[] | undefined;
|
|
198
197
|
interaction_dynamics?: {
|
|
198
|
+
turn_taking_quality?: string | null | undefined;
|
|
199
199
|
information_density?: string | null | undefined;
|
|
200
|
-
rapport_trajectory?: string | null | undefined;
|
|
201
200
|
repair_effectiveness?: string | null | undefined;
|
|
202
|
-
|
|
201
|
+
rapport_trajectory?: string | null | undefined;
|
|
203
202
|
} | null | undefined;
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
quality?: ("optimal" | "adequate" | "suboptimal") | null | undefined;
|
|
212
|
-
reasoning?: string | null | undefined;
|
|
203
|
+
coaching?: {
|
|
204
|
+
moment_timestamp?: number | null | undefined;
|
|
205
|
+
observation: string;
|
|
206
|
+
recommendation: string;
|
|
207
|
+
expected_impact?: string | null | undefined;
|
|
208
|
+
}[] | undefined;
|
|
209
|
+
counterfactuals?: {
|
|
213
210
|
timestamp_seconds?: number | null | undefined;
|
|
214
|
-
|
|
211
|
+
actual: string;
|
|
212
|
+
alternative: string;
|
|
213
|
+
predicted_impact: string;
|
|
215
214
|
}[] | undefined;
|
|
216
|
-
|
|
217
|
-
outcome?: ("succeeded" | "partially" | "failed" | "abandoned") | null | undefined;
|
|
215
|
+
deep_understanding?: string | null | undefined;
|
|
218
216
|
signal_response_alignment?: {
|
|
217
|
+
signal: string;
|
|
219
218
|
agent_response: string;
|
|
220
219
|
alignment: "aligned" | "misaligned" | "partial";
|
|
221
220
|
insight?: string | null | undefined;
|
|
222
|
-
signal: string;
|
|
223
221
|
}[] | undefined;
|
|
224
|
-
|
|
225
|
-
|
|
222
|
+
missed_opportunities?: string[] | undefined;
|
|
223
|
+
emergent_patterns?: string[] | undefined;
|
|
224
|
+
call_entity_id?: string | null | undefined;
|
|
225
|
+
computed_at?: string | null | undefined;
|
|
226
226
|
} & import("../index.js").ResponseMetadata>;
|
|
227
227
|
}
|
|
228
228
|
//# sourceMappingURL=calls.d.ts.map
|