@amigo-ai/platform-sdk 0.6.1 → 0.8.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/api.md +9 -0
- package/dist/index.cjs +44 -0
- package/dist/index.cjs.map +3 -3
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -0
- package/dist/index.mjs.map +3 -3
- package/dist/resources/metrics.js +37 -0
- package/dist/resources/metrics.js.map +1 -0
- package/dist/types/generated/api.d.ts +677 -35
- package/dist/types/generated/api.d.ts.map +1 -1
- package/dist/types/index.d.cts +20 -1
- package/dist/types/index.d.cts.map +1 -1
- package/dist/types/index.d.ts +20 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/resources/calls.d.ts +9 -2
- package/dist/types/resources/calls.d.ts.map +1 -1
- package/dist/types/resources/functions.d.ts.map +1 -1
- package/dist/types/resources/metrics.d.ts +136 -0
- package/dist/types/resources/metrics.d.ts.map +1 -0
- package/dist/types/resources/settings.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -5009,7 +5009,7 @@ export interface paths {
|
|
|
5009
5009
|
put?: never;
|
|
5010
5010
|
/**
|
|
5011
5011
|
* Approve review item
|
|
5012
|
-
* @description
|
|
5012
|
+
* @description Marks the review item approved and lets SDP projections rebuild entity state.
|
|
5013
5013
|
*/
|
|
5014
5014
|
post: operations["approve_review_item_v1__workspace_id__review_queue__item_id__approve_post"];
|
|
5015
5015
|
delete?: never;
|
|
@@ -5049,7 +5049,7 @@ export interface paths {
|
|
|
5049
5049
|
put?: never;
|
|
5050
5050
|
/**
|
|
5051
5051
|
* Submit corrected data
|
|
5052
|
-
* @description Creates a
|
|
5052
|
+
* @description Creates a corrected event and lets SDP projections rebuild entity state.
|
|
5053
5053
|
*/
|
|
5054
5054
|
post: operations["correct_review_item_v1__workspace_id__review_queue__item_id__correct_post"];
|
|
5055
5055
|
delete?: never;
|
|
@@ -5109,7 +5109,7 @@ export interface paths {
|
|
|
5109
5109
|
put?: never;
|
|
5110
5110
|
/**
|
|
5111
5111
|
* Reject review item
|
|
5112
|
-
* @description
|
|
5112
|
+
* @description Marks the review item rejected and lets SDP projections rebuild entity state.
|
|
5113
5113
|
*/
|
|
5114
5114
|
post: operations["reject_review_item_v1__workspace_id__review_queue__item_id__reject_post"];
|
|
5115
5115
|
delete?: never;
|
|
@@ -6964,7 +6964,7 @@ export interface paths {
|
|
|
6964
6964
|
};
|
|
6965
6965
|
/**
|
|
6966
6966
|
* List Trigger Runs
|
|
6967
|
-
* @description Execution history
|
|
6967
|
+
* @description Execution history from the Lakebase entity-event timeline read model.
|
|
6968
6968
|
*/
|
|
6969
6969
|
get: operations["list_trigger_runs_v1__workspace_id__triggers__trigger_id__runs_get"];
|
|
6970
6970
|
put?: never;
|
|
@@ -7111,6 +7111,74 @@ export interface paths {
|
|
|
7111
7111
|
patch: operations["update-unification-rule"];
|
|
7112
7112
|
trace?: never;
|
|
7113
7113
|
};
|
|
7114
|
+
"/v1/{workspace_id}/use-cases": {
|
|
7115
|
+
parameters: {
|
|
7116
|
+
query?: never;
|
|
7117
|
+
header?: never;
|
|
7118
|
+
path?: never;
|
|
7119
|
+
cookie?: never;
|
|
7120
|
+
};
|
|
7121
|
+
/**
|
|
7122
|
+
* List channel use cases
|
|
7123
|
+
* @description List use cases with optional filters by entity_name, channel, setup_id. Requires Channel.view permission.
|
|
7124
|
+
*/
|
|
7125
|
+
get: operations["list-use-cases"];
|
|
7126
|
+
put?: never;
|
|
7127
|
+
/**
|
|
7128
|
+
* Create a channel use case
|
|
7129
|
+
* @description Create a voice or email use case. Body is a discriminated union on the `channel` field. Requires Channel.create permission.
|
|
7130
|
+
*/
|
|
7131
|
+
post: operations["create-use-case"];
|
|
7132
|
+
delete?: never;
|
|
7133
|
+
options?: never;
|
|
7134
|
+
head?: never;
|
|
7135
|
+
patch?: never;
|
|
7136
|
+
trace?: never;
|
|
7137
|
+
};
|
|
7138
|
+
"/v1/{workspace_id}/use-cases/{use_case_id}": {
|
|
7139
|
+
parameters: {
|
|
7140
|
+
query?: never;
|
|
7141
|
+
header?: never;
|
|
7142
|
+
path?: never;
|
|
7143
|
+
cookie?: never;
|
|
7144
|
+
};
|
|
7145
|
+
get?: never;
|
|
7146
|
+
put?: never;
|
|
7147
|
+
post?: never;
|
|
7148
|
+
/**
|
|
7149
|
+
* Delete a channel use case
|
|
7150
|
+
* @description Delete a use case. Fails if voice use case still has phone assignments. Requires Channel.delete permission.
|
|
7151
|
+
*/
|
|
7152
|
+
delete: operations["delete-use-case"];
|
|
7153
|
+
options?: never;
|
|
7154
|
+
head?: never;
|
|
7155
|
+
patch?: never;
|
|
7156
|
+
trace?: never;
|
|
7157
|
+
};
|
|
7158
|
+
"/v1/{workspace_id}/voicemail": {
|
|
7159
|
+
parameters: {
|
|
7160
|
+
query?: never;
|
|
7161
|
+
header?: never;
|
|
7162
|
+
path?: never;
|
|
7163
|
+
cookie?: never;
|
|
7164
|
+
};
|
|
7165
|
+
/**
|
|
7166
|
+
* List voicemails
|
|
7167
|
+
* @description List voicemail records with optional filters. Requires Channel.view permission.
|
|
7168
|
+
*/
|
|
7169
|
+
get: operations["list-voicemails"];
|
|
7170
|
+
put?: never;
|
|
7171
|
+
/**
|
|
7172
|
+
* Send a voicemail
|
|
7173
|
+
* @description Send a ringless voicemail. Accepts multipart form with use_case_id, recipient_phone_number (US E.164), and audio MP3 file (10-60s, max 8 MB). Requires Channel.send permission.
|
|
7174
|
+
*/
|
|
7175
|
+
post: operations["send-voicemail"];
|
|
7176
|
+
delete?: never;
|
|
7177
|
+
options?: never;
|
|
7178
|
+
head?: never;
|
|
7179
|
+
patch?: never;
|
|
7180
|
+
trace?: never;
|
|
7181
|
+
};
|
|
7114
7182
|
"/v1/{workspace_id}/voiceprints/enroll": {
|
|
7115
7183
|
parameters: {
|
|
7116
7184
|
query?: never;
|
|
@@ -7235,7 +7303,7 @@ export interface paths {
|
|
|
7235
7303
|
};
|
|
7236
7304
|
/**
|
|
7237
7305
|
* List Deliveries
|
|
7238
|
-
* @description Delivery history
|
|
7306
|
+
* @description Delivery history from the Lakebase entity-event timeline read model.
|
|
7239
7307
|
*/
|
|
7240
7308
|
get: operations["list_deliveries_v1__workspace_id__webhook_destinations__destination_id__deliveries_get"];
|
|
7241
7309
|
put?: never;
|
|
@@ -8964,6 +9032,18 @@ export interface components {
|
|
|
8964
9032
|
*/
|
|
8965
9033
|
sample_rate?: number;
|
|
8966
9034
|
};
|
|
9035
|
+
/** Body_send-voicemail */
|
|
9036
|
+
"Body_send-voicemail": {
|
|
9037
|
+
/** Audio */
|
|
9038
|
+
audio: string;
|
|
9039
|
+
/** Recipient Phone Number */
|
|
9040
|
+
recipient_phone_number: string;
|
|
9041
|
+
/**
|
|
9042
|
+
* Use Case Id
|
|
9043
|
+
* Format: uuid
|
|
9044
|
+
*/
|
|
9045
|
+
use_case_id: string;
|
|
9046
|
+
};
|
|
8967
9047
|
/** Body_verify-voiceprint */
|
|
8968
9048
|
"Body_verify-voiceprint": {
|
|
8969
9049
|
/** Audio */
|
|
@@ -8991,6 +9071,36 @@ export interface components {
|
|
|
8991
9071
|
*/
|
|
8992
9072
|
slot_id: string;
|
|
8993
9073
|
};
|
|
9074
|
+
/** BooleanMetricValueResponse */
|
|
9075
|
+
BooleanMetricValueResponse: {
|
|
9076
|
+
/** Avg Confidence */
|
|
9077
|
+
avg_confidence?: number | null;
|
|
9078
|
+
/** Computed At */
|
|
9079
|
+
computed_at?: string | null;
|
|
9080
|
+
/** Event Count */
|
|
9081
|
+
event_count: number;
|
|
9082
|
+
/** Metric Key */
|
|
9083
|
+
metric_key: string;
|
|
9084
|
+
/**
|
|
9085
|
+
* @description discriminator enum property added by openapi-typescript
|
|
9086
|
+
* @enum {string}
|
|
9087
|
+
*/
|
|
9088
|
+
metric_type: "boolean";
|
|
9089
|
+
/**
|
|
9090
|
+
* Period End
|
|
9091
|
+
* Format: date-time
|
|
9092
|
+
*/
|
|
9093
|
+
period_end: string;
|
|
9094
|
+
/**
|
|
9095
|
+
* Period Start
|
|
9096
|
+
* Format: date-time
|
|
9097
|
+
*/
|
|
9098
|
+
period_start: string;
|
|
9099
|
+
/** Unit */
|
|
9100
|
+
unit?: string | null;
|
|
9101
|
+
/** Value */
|
|
9102
|
+
value: boolean | null;
|
|
9103
|
+
};
|
|
8994
9104
|
/**
|
|
8995
9105
|
* BrandingConfig
|
|
8996
9106
|
* @description Visual branding for patient-facing surfaces.
|
|
@@ -9678,6 +9788,36 @@ export interface components {
|
|
|
9678
9788
|
*/
|
|
9679
9789
|
schema?: string;
|
|
9680
9790
|
};
|
|
9791
|
+
/** CategoricalMetricValueResponse */
|
|
9792
|
+
CategoricalMetricValueResponse: {
|
|
9793
|
+
/** Avg Confidence */
|
|
9794
|
+
avg_confidence?: number | null;
|
|
9795
|
+
/** Computed At */
|
|
9796
|
+
computed_at?: string | null;
|
|
9797
|
+
/** Event Count */
|
|
9798
|
+
event_count: number;
|
|
9799
|
+
/** Metric Key */
|
|
9800
|
+
metric_key: string;
|
|
9801
|
+
/**
|
|
9802
|
+
* @description discriminator enum property added by openapi-typescript
|
|
9803
|
+
* @enum {string}
|
|
9804
|
+
*/
|
|
9805
|
+
metric_type: "categorical";
|
|
9806
|
+
/**
|
|
9807
|
+
* Period End
|
|
9808
|
+
* Format: date-time
|
|
9809
|
+
*/
|
|
9810
|
+
period_end: string;
|
|
9811
|
+
/**
|
|
9812
|
+
* Period Start
|
|
9813
|
+
* Format: date-time
|
|
9814
|
+
*/
|
|
9815
|
+
period_start: string;
|
|
9816
|
+
/** Unit */
|
|
9817
|
+
unit?: string | null;
|
|
9818
|
+
/** Value */
|
|
9819
|
+
value: string | null;
|
|
9820
|
+
};
|
|
9681
9821
|
/**
|
|
9682
9822
|
* ChannelOverride
|
|
9683
9823
|
* @description Per-channel behavior override for a state.
|
|
@@ -10211,6 +10351,17 @@ export interface components {
|
|
|
10211
10351
|
* @description Server clock at query time (UTC).
|
|
10212
10352
|
*/
|
|
10213
10353
|
as_of: string;
|
|
10354
|
+
/**
|
|
10355
|
+
* Read Model Status
|
|
10356
|
+
* @description ready = Lakebase projection returned rows; empty = no summary rows; unavailable = read failed.
|
|
10357
|
+
* @enum {string}
|
|
10358
|
+
*/
|
|
10359
|
+
read_model_status: "ready" | "empty" | "unavailable";
|
|
10360
|
+
/**
|
|
10361
|
+
* Read Model Synced At
|
|
10362
|
+
* @description Most recent platform.connector_health_summary synced_at value in this response.
|
|
10363
|
+
*/
|
|
10364
|
+
read_model_synced_at?: string | null;
|
|
10214
10365
|
/** Sources */
|
|
10215
10366
|
sources?: components["schemas"]["ConnectorHealthItem"][];
|
|
10216
10367
|
};
|
|
@@ -10904,7 +11055,7 @@ export interface components {
|
|
|
10904
11055
|
phone_from?: string | null;
|
|
10905
11056
|
/**
|
|
10906
11057
|
* Phone To
|
|
10907
|
-
* @description Destination phone number in E.164 format
|
|
11058
|
+
* @description Destination phone number in E.164 format.
|
|
10908
11059
|
*/
|
|
10909
11060
|
phone_to: string;
|
|
10910
11061
|
/**
|
|
@@ -12684,6 +12835,35 @@ export interface components {
|
|
|
12684
12835
|
/** Region */
|
|
12685
12836
|
region: string;
|
|
12686
12837
|
};
|
|
12838
|
+
/** EmailUseCaseRequest */
|
|
12839
|
+
EmailUseCaseRequest: {
|
|
12840
|
+
/**
|
|
12841
|
+
* @description discriminator enum property added by openapi-typescript
|
|
12842
|
+
* @enum {string}
|
|
12843
|
+
*/
|
|
12844
|
+
channel: "email";
|
|
12845
|
+
/** Description */
|
|
12846
|
+
description?: string | null;
|
|
12847
|
+
/**
|
|
12848
|
+
* Email Type
|
|
12849
|
+
* @enum {string}
|
|
12850
|
+
*/
|
|
12851
|
+
email_type: "transactional" | "marketing";
|
|
12852
|
+
/** Entity Name */
|
|
12853
|
+
entity_name: string;
|
|
12854
|
+
/** Name */
|
|
12855
|
+
name: string;
|
|
12856
|
+
/**
|
|
12857
|
+
* Sender Email Address
|
|
12858
|
+
* Format: email
|
|
12859
|
+
*/
|
|
12860
|
+
sender_email_address: string;
|
|
12861
|
+
/**
|
|
12862
|
+
* Setup Id
|
|
12863
|
+
* Format: uuid
|
|
12864
|
+
*/
|
|
12865
|
+
setup_id: string;
|
|
12866
|
+
};
|
|
12687
12867
|
/** EmotionBurst */
|
|
12688
12868
|
EmotionBurst: {
|
|
12689
12869
|
/** Score */
|
|
@@ -16454,7 +16634,7 @@ export interface components {
|
|
|
16454
16634
|
/** MetricListResponse */
|
|
16455
16635
|
MetricListResponse: {
|
|
16456
16636
|
/** Metrics */
|
|
16457
|
-
metrics: components["schemas"]["
|
|
16637
|
+
metrics: (components["schemas"]["NumericalMetricValueResponse"] | components["schemas"]["CategoricalMetricValueResponse"] | components["schemas"]["BooleanMetricValueResponse"])[];
|
|
16458
16638
|
};
|
|
16459
16639
|
/**
|
|
16460
16640
|
* MetricSettingsRequest
|
|
@@ -16474,27 +16654,6 @@ export interface components {
|
|
|
16474
16654
|
/** Definitions */
|
|
16475
16655
|
definitions: components["schemas"]["MetricDefinition"][];
|
|
16476
16656
|
};
|
|
16477
|
-
/** MetricValueResponse */
|
|
16478
|
-
MetricValueResponse: {
|
|
16479
|
-
/** Avg Confidence */
|
|
16480
|
-
avg_confidence?: number | null;
|
|
16481
|
-
/** Computed At */
|
|
16482
|
-
computed_at?: string | null;
|
|
16483
|
-
/** Event Count */
|
|
16484
|
-
event_count: number;
|
|
16485
|
-
/** Metric Key */
|
|
16486
|
-
metric_key: string;
|
|
16487
|
-
/** Metric Type */
|
|
16488
|
-
metric_type: string;
|
|
16489
|
-
/** Period End */
|
|
16490
|
-
period_end: string;
|
|
16491
|
-
/** Period Start */
|
|
16492
|
-
period_start: string;
|
|
16493
|
-
/** Unit */
|
|
16494
|
-
unit?: string | null;
|
|
16495
|
-
/** Value */
|
|
16496
|
-
value: unknown;
|
|
16497
|
-
};
|
|
16498
16657
|
/** ModelRegistryResponse */
|
|
16499
16658
|
ModelRegistryResponse: {
|
|
16500
16659
|
/** Count */
|
|
@@ -16687,6 +16846,36 @@ export interface components {
|
|
|
16687
16846
|
/** Smoking */
|
|
16688
16847
|
smoking: components["schemas"]["NoteRollupCategoryEntry"][];
|
|
16689
16848
|
};
|
|
16849
|
+
/** NumericalMetricValueResponse */
|
|
16850
|
+
NumericalMetricValueResponse: {
|
|
16851
|
+
/** Avg Confidence */
|
|
16852
|
+
avg_confidence?: number | null;
|
|
16853
|
+
/** Computed At */
|
|
16854
|
+
computed_at?: string | null;
|
|
16855
|
+
/** Event Count */
|
|
16856
|
+
event_count: number;
|
|
16857
|
+
/** Metric Key */
|
|
16858
|
+
metric_key: string;
|
|
16859
|
+
/**
|
|
16860
|
+
* @description discriminator enum property added by openapi-typescript
|
|
16861
|
+
* @enum {string}
|
|
16862
|
+
*/
|
|
16863
|
+
metric_type: "numerical";
|
|
16864
|
+
/**
|
|
16865
|
+
* Period End
|
|
16866
|
+
* Format: date-time
|
|
16867
|
+
*/
|
|
16868
|
+
period_end: string;
|
|
16869
|
+
/**
|
|
16870
|
+
* Period Start
|
|
16871
|
+
* Format: date-time
|
|
16872
|
+
*/
|
|
16873
|
+
period_start: string;
|
|
16874
|
+
/** Unit */
|
|
16875
|
+
unit?: string | null;
|
|
16876
|
+
/** Value */
|
|
16877
|
+
value: number | null;
|
|
16878
|
+
};
|
|
16690
16879
|
ObserverSSEEvent: components["schemas"]["AgentTranscriptDeltaEvent"] | components["schemas"]["AgentTranscriptEvent"] | components["schemas"]["BargeInEvent"] | components["schemas"]["CompoundEmotionEvent"] | components["schemas"]["EmotionEvent"] | components["schemas"]["EmpathyClassifiedEvent"] | components["schemas"]["ForwardCallResolvedEvent"] | components["schemas"]["LatencyEvent"] | components["schemas"]["NavTimingEvent"] | components["schemas"]["ParticipantJoinedEvent"] | components["schemas"]["ParticipantLeftEvent"] | components["schemas"]["SessionEndEvent"] | components["schemas"]["SessionInfoEvent"] | components["schemas"]["SessionStartEvent"] | components["schemas"]["SpeakerMutedEvent"] | components["schemas"]["StateTransitionEvent"] | components["schemas"]["ToolCallCompletedEvent"] | components["schemas"]["ToolCallStartedEvent"] | components["schemas"]["UserTranscriptEvent"] | components["schemas"]["VoiceContextAppliedEvent"];
|
|
16691
16880
|
/** OcrRequest */
|
|
16692
16881
|
OcrRequest: {
|
|
@@ -18194,6 +18383,14 @@ export interface components {
|
|
|
18194
18383
|
entity_resolution?: {
|
|
18195
18384
|
[key: string]: unknown;
|
|
18196
18385
|
} | null;
|
|
18386
|
+
/**
|
|
18387
|
+
* Event Read Model Status
|
|
18388
|
+
* @default empty
|
|
18389
|
+
* @enum {string}
|
|
18390
|
+
*/
|
|
18391
|
+
event_read_model_status?: "ready" | "empty" | "unavailable";
|
|
18392
|
+
/** Event Read Model Synced At */
|
|
18393
|
+
event_read_model_synced_at?: string | null;
|
|
18197
18394
|
/** Gap Scanner */
|
|
18198
18395
|
gap_scanner?: {
|
|
18199
18396
|
[key: string]: unknown;
|
|
@@ -21712,8 +21909,27 @@ export interface components {
|
|
|
21712
21909
|
/** Source System */
|
|
21713
21910
|
source_system?: string | null;
|
|
21714
21911
|
};
|
|
21912
|
+
/** TimelineActor */
|
|
21913
|
+
TimelineActor: {
|
|
21914
|
+
/**
|
|
21915
|
+
* Kind
|
|
21916
|
+
* @enum {string}
|
|
21917
|
+
*/
|
|
21918
|
+
kind: "agent" | "human" | "operator" | "system" | "tool";
|
|
21919
|
+
/** Label */
|
|
21920
|
+
label: string;
|
|
21921
|
+
/** Participant Id */
|
|
21922
|
+
participant_id?: string | null;
|
|
21923
|
+
/**
|
|
21924
|
+
* Role
|
|
21925
|
+
* @enum {string}
|
|
21926
|
+
*/
|
|
21927
|
+
role: "agent" | "caller" | "operator" | "runtime" | "state" | "tool";
|
|
21928
|
+
};
|
|
21715
21929
|
/** TimelineSegment */
|
|
21716
21930
|
TimelineSegment: {
|
|
21931
|
+
/** @description Actor responsible for the segment. Inferred for legacy producers. */
|
|
21932
|
+
actor?: components["schemas"]["TimelineActor"] | null;
|
|
21717
21933
|
/** Audio Ttfb Ms */
|
|
21718
21934
|
audio_ttfb_ms?: number | null;
|
|
21719
21935
|
/** Audio Window End */
|
|
@@ -21736,8 +21952,11 @@ export interface components {
|
|
|
21736
21952
|
from_state?: string | null;
|
|
21737
21953
|
/** Label */
|
|
21738
21954
|
label: string;
|
|
21739
|
-
/**
|
|
21740
|
-
|
|
21955
|
+
/**
|
|
21956
|
+
* Lane
|
|
21957
|
+
* @enum {string}
|
|
21958
|
+
*/
|
|
21959
|
+
lane: "agent" | "caller" | "events" | "operator" | "system" | "tool";
|
|
21741
21960
|
/** Nav Ms */
|
|
21742
21961
|
nav_ms?: number | null;
|
|
21743
21962
|
/** Render Ms */
|
|
@@ -21754,10 +21973,18 @@ export interface components {
|
|
|
21754
21973
|
to_state?: string | null;
|
|
21755
21974
|
/** Tool Name */
|
|
21756
21975
|
tool_name?: string | null;
|
|
21976
|
+
/**
|
|
21977
|
+
* Track
|
|
21978
|
+
* @description Actor-semantic display track for the segment. Inferred for legacy producers.
|
|
21979
|
+
*/
|
|
21980
|
+
track?: ("agent" | "caller" | "operator" | "system" | "tool") | null;
|
|
21757
21981
|
/** Turn Index */
|
|
21758
21982
|
turn_index: number;
|
|
21759
|
-
/**
|
|
21760
|
-
|
|
21983
|
+
/**
|
|
21984
|
+
* Type
|
|
21985
|
+
* @enum {string}
|
|
21986
|
+
*/
|
|
21987
|
+
type: "agent_speech" | "barge_in" | "caller_speech" | "filler_hesitation" | "filler_nav" | "greeting" | "interrupted_speech" | "processing_gap" | "silence" | "silence_check" | "state_transition" | "tool_call";
|
|
21761
21988
|
/** Valence */
|
|
21762
21989
|
valence?: number | null;
|
|
21763
21990
|
};
|
|
@@ -23180,6 +23407,44 @@ export interface components {
|
|
|
23180
23407
|
*/
|
|
23181
23408
|
value: number;
|
|
23182
23409
|
};
|
|
23410
|
+
/** UseCaseListResponse */
|
|
23411
|
+
UseCaseListResponse: {
|
|
23412
|
+
/** Items */
|
|
23413
|
+
items: components["schemas"]["UseCaseResponse"][];
|
|
23414
|
+
};
|
|
23415
|
+
/** UseCaseResponse */
|
|
23416
|
+
UseCaseResponse: {
|
|
23417
|
+
/** Channel */
|
|
23418
|
+
channel: string;
|
|
23419
|
+
/** Configuration Set Name */
|
|
23420
|
+
configuration_set_name?: string | null;
|
|
23421
|
+
/**
|
|
23422
|
+
* Created At
|
|
23423
|
+
* Format: date-time
|
|
23424
|
+
*/
|
|
23425
|
+
created_at: string;
|
|
23426
|
+
/** Description */
|
|
23427
|
+
description: string | null;
|
|
23428
|
+
/** Email Type */
|
|
23429
|
+
email_type?: string | null;
|
|
23430
|
+
/** Entity Name */
|
|
23431
|
+
entity_name: string;
|
|
23432
|
+
/** Id */
|
|
23433
|
+
id: string;
|
|
23434
|
+
/** Name */
|
|
23435
|
+
name: string;
|
|
23436
|
+
/** Sender Email Address */
|
|
23437
|
+
sender_email_address?: string | null;
|
|
23438
|
+
/** Setup Id */
|
|
23439
|
+
setup_id: string;
|
|
23440
|
+
/** Tier */
|
|
23441
|
+
tier?: string | null;
|
|
23442
|
+
/**
|
|
23443
|
+
* Updated At
|
|
23444
|
+
* Format: date-time
|
|
23445
|
+
*/
|
|
23446
|
+
updated_at: string;
|
|
23447
|
+
};
|
|
23183
23448
|
/** UserTranscriptEvent */
|
|
23184
23449
|
UserTranscriptEvent: {
|
|
23185
23450
|
/**
|
|
@@ -23470,6 +23735,60 @@ export interface components {
|
|
|
23470
23735
|
/** Volume */
|
|
23471
23736
|
volume: number | null;
|
|
23472
23737
|
};
|
|
23738
|
+
/** VoiceUseCaseRequest */
|
|
23739
|
+
VoiceUseCaseRequest: {
|
|
23740
|
+
/**
|
|
23741
|
+
* @description discriminator enum property added by openapi-typescript
|
|
23742
|
+
* @enum {string}
|
|
23743
|
+
*/
|
|
23744
|
+
channel: "inbound_voice" | "outbound_voice" | "ringless_voicemail";
|
|
23745
|
+
/** Description */
|
|
23746
|
+
description?: string | null;
|
|
23747
|
+
/** Entity Name */
|
|
23748
|
+
entity_name: string;
|
|
23749
|
+
/** Name */
|
|
23750
|
+
name: string;
|
|
23751
|
+
/**
|
|
23752
|
+
* Setup Id
|
|
23753
|
+
* Format: uuid
|
|
23754
|
+
*/
|
|
23755
|
+
setup_id: string;
|
|
23756
|
+
};
|
|
23757
|
+
/** VoicemailListResponse */
|
|
23758
|
+
VoicemailListResponse: {
|
|
23759
|
+
/** Items */
|
|
23760
|
+
items: components["schemas"]["VoicemailResponse"][];
|
|
23761
|
+
};
|
|
23762
|
+
/** VoicemailResponse */
|
|
23763
|
+
VoicemailResponse: {
|
|
23764
|
+
/**
|
|
23765
|
+
* Created At
|
|
23766
|
+
* Format: date-time
|
|
23767
|
+
*/
|
|
23768
|
+
created_at: string;
|
|
23769
|
+
/** Recipient Phone Number */
|
|
23770
|
+
recipient_phone_number: string;
|
|
23771
|
+
/** Setup Id */
|
|
23772
|
+
setup_id: string;
|
|
23773
|
+
/** Status */
|
|
23774
|
+
status: string;
|
|
23775
|
+
/**
|
|
23776
|
+
* Updated At
|
|
23777
|
+
* Format: date-time
|
|
23778
|
+
*/
|
|
23779
|
+
updated_at: string;
|
|
23780
|
+
/** Use Case Id */
|
|
23781
|
+
use_case_id: string;
|
|
23782
|
+
/** Voicemail Id */
|
|
23783
|
+
voicemail_id: string;
|
|
23784
|
+
};
|
|
23785
|
+
/** VoicemailSentResponse */
|
|
23786
|
+
VoicemailSentResponse: {
|
|
23787
|
+
/** Sender Phone Number */
|
|
23788
|
+
sender_phone_number: string;
|
|
23789
|
+
/** Voicemail Id */
|
|
23790
|
+
voicemail_id: string;
|
|
23791
|
+
};
|
|
23473
23792
|
/** VoiceprintEnrollResponse */
|
|
23474
23793
|
VoiceprintEnrollResponse: {
|
|
23475
23794
|
/**
|
|
@@ -23921,6 +24240,36 @@ export interface components {
|
|
|
23921
24240
|
updated_at: string;
|
|
23922
24241
|
};
|
|
23923
24242
|
WorkspaceSSEEvent: components["schemas"]["CallStartedEvent"] | components["schemas"]["CallEndedEvent"] | components["schemas"]["CallEscalatedEvent"] | components["schemas"]["EncounterUpdatedEvent"] | components["schemas"]["NarrativeUpdatedEvent"] | components["schemas"]["ReviewSubmittedEvent"] | components["schemas"]["SimulationTurnStoredEvent"] | components["schemas"]["SurfaceCreatedEvent"] | components["schemas"]["SurfaceDeliveredEvent"] | components["schemas"]["SurfaceUpdatedEvent"] | components["schemas"]["SurfaceArchivedEvent"] | components["schemas"]["SurfaceReshapedEvent"] | components["schemas"]["SurfaceSubmittedEvent"] | components["schemas"]["SurfaceFieldSavedEvent"] | components["schemas"]["SurfaceOpenedEvent"] | components["schemas"]["SurfacePendingReviewEvent"] | components["schemas"]["SurfaceReviewApprovedEvent"] | components["schemas"]["SurfaceReviewRejectedEvent"] | components["schemas"]["TextStartedEvent"] | components["schemas"]["TextCompletedEvent"] | components["schemas"]["TriggerFiredEvent"] | components["schemas"]["TriggerCompletedEvent"] | components["schemas"]["TriggerFailedEvent"] | components["schemas"]["PipelineSyncCompletedEvent"] | components["schemas"]["PipelineErrorEvent"] | components["schemas"]["OperatorRegisteredEvent"] | components["schemas"]["OperatorStatusChangedEvent"] | components["schemas"]["OperatorProfileUpdatedEvent"] | components["schemas"]["OperatorJoinedCallEvent"] | components["schemas"]["OperatorLeftCallEvent"] | components["schemas"]["OperatorModeChangedEvent"] | components["schemas"]["OperatorWrapUpEvent"];
|
|
24243
|
+
/** WorldDashboardResponse */
|
|
24244
|
+
WorldDashboardResponse: {
|
|
24245
|
+
/** Avg Confidence */
|
|
24246
|
+
avg_confidence?: number | null;
|
|
24247
|
+
entity_counts: components["schemas"]["EntityStatsSummary"];
|
|
24248
|
+
/**
|
|
24249
|
+
* Event Read Model Status
|
|
24250
|
+
* @description ready = Lakebase projection returned a row; empty = no summary row; unavailable = read failed.
|
|
24251
|
+
* @default empty
|
|
24252
|
+
* @enum {string}
|
|
24253
|
+
*/
|
|
24254
|
+
event_read_model_status?: "ready" | "empty" | "unavailable";
|
|
24255
|
+
/**
|
|
24256
|
+
* Event Read Model Synced At
|
|
24257
|
+
* @description platform.event_velocity_summary synced_at for this workspace.
|
|
24258
|
+
*/
|
|
24259
|
+
event_read_model_synced_at?: string | null;
|
|
24260
|
+
/**
|
|
24261
|
+
* Events 24H
|
|
24262
|
+
* @default 0
|
|
24263
|
+
*/
|
|
24264
|
+
events_24h?: number;
|
|
24265
|
+
/**
|
|
24266
|
+
* Events 7D
|
|
24267
|
+
* @default 0
|
|
24268
|
+
*/
|
|
24269
|
+
events_7d?: number;
|
|
24270
|
+
/** Sources */
|
|
24271
|
+
sources?: components["schemas"]["SourceBreakdownItem"][];
|
|
24272
|
+
};
|
|
23924
24273
|
/**
|
|
23925
24274
|
* WrapUpRequest
|
|
23926
24275
|
* @description Request to record operator intervention wrap-up.
|
|
@@ -27967,6 +28316,13 @@ export interface operations {
|
|
|
27967
28316
|
};
|
|
27968
28317
|
content?: never;
|
|
27969
28318
|
};
|
|
28319
|
+
/** @description Channel manager phone selection timed out */
|
|
28320
|
+
504: {
|
|
28321
|
+
headers: {
|
|
28322
|
+
[name: string]: unknown;
|
|
28323
|
+
};
|
|
28324
|
+
content?: never;
|
|
28325
|
+
};
|
|
27970
28326
|
};
|
|
27971
28327
|
};
|
|
27972
28328
|
"get-phone-call-volume": {
|
|
@@ -40676,6 +41032,294 @@ export interface operations {
|
|
|
40676
41032
|
};
|
|
40677
41033
|
};
|
|
40678
41034
|
};
|
|
41035
|
+
"list-use-cases": {
|
|
41036
|
+
parameters: {
|
|
41037
|
+
query?: {
|
|
41038
|
+
entity_name?: string | null;
|
|
41039
|
+
channel?: ("outbound_voice" | "inbound_voice" | "ringless_voicemail" | "email") | null;
|
|
41040
|
+
setup_id?: string | null;
|
|
41041
|
+
};
|
|
41042
|
+
header?: never;
|
|
41043
|
+
path: {
|
|
41044
|
+
workspace_id: string;
|
|
41045
|
+
};
|
|
41046
|
+
cookie?: never;
|
|
41047
|
+
};
|
|
41048
|
+
requestBody?: never;
|
|
41049
|
+
responses: {
|
|
41050
|
+
/** @description Successful Response */
|
|
41051
|
+
200: {
|
|
41052
|
+
headers: {
|
|
41053
|
+
[name: string]: unknown;
|
|
41054
|
+
};
|
|
41055
|
+
content: {
|
|
41056
|
+
"application/json": components["schemas"]["UseCaseListResponse"];
|
|
41057
|
+
};
|
|
41058
|
+
};
|
|
41059
|
+
/** @description Insufficient permissions. */
|
|
41060
|
+
403: {
|
|
41061
|
+
headers: {
|
|
41062
|
+
[name: string]: unknown;
|
|
41063
|
+
};
|
|
41064
|
+
content?: never;
|
|
41065
|
+
};
|
|
41066
|
+
/** @description Validation Error */
|
|
41067
|
+
422: {
|
|
41068
|
+
headers: {
|
|
41069
|
+
[name: string]: unknown;
|
|
41070
|
+
};
|
|
41071
|
+
content: {
|
|
41072
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
41073
|
+
};
|
|
41074
|
+
};
|
|
41075
|
+
};
|
|
41076
|
+
};
|
|
41077
|
+
"create-use-case": {
|
|
41078
|
+
parameters: {
|
|
41079
|
+
query?: never;
|
|
41080
|
+
header?: never;
|
|
41081
|
+
path: {
|
|
41082
|
+
workspace_id: string;
|
|
41083
|
+
};
|
|
41084
|
+
cookie?: never;
|
|
41085
|
+
};
|
|
41086
|
+
requestBody: {
|
|
41087
|
+
content: {
|
|
41088
|
+
"application/json": components["schemas"]["VoiceUseCaseRequest"] | components["schemas"]["EmailUseCaseRequest"];
|
|
41089
|
+
};
|
|
41090
|
+
};
|
|
41091
|
+
responses: {
|
|
41092
|
+
/** @description Successful Response */
|
|
41093
|
+
201: {
|
|
41094
|
+
headers: {
|
|
41095
|
+
[name: string]: unknown;
|
|
41096
|
+
};
|
|
41097
|
+
content: {
|
|
41098
|
+
"application/json": components["schemas"]["UseCaseResponse"];
|
|
41099
|
+
};
|
|
41100
|
+
};
|
|
41101
|
+
/** @description Insufficient permissions. */
|
|
41102
|
+
403: {
|
|
41103
|
+
headers: {
|
|
41104
|
+
[name: string]: unknown;
|
|
41105
|
+
};
|
|
41106
|
+
content?: never;
|
|
41107
|
+
};
|
|
41108
|
+
/** @description Setup not found. */
|
|
41109
|
+
404: {
|
|
41110
|
+
headers: {
|
|
41111
|
+
[name: string]: unknown;
|
|
41112
|
+
};
|
|
41113
|
+
content?: never;
|
|
41114
|
+
};
|
|
41115
|
+
/** @description Use case already exists or setup not approved. */
|
|
41116
|
+
409: {
|
|
41117
|
+
headers: {
|
|
41118
|
+
[name: string]: unknown;
|
|
41119
|
+
};
|
|
41120
|
+
content?: never;
|
|
41121
|
+
};
|
|
41122
|
+
/** @description Validation Error */
|
|
41123
|
+
422: {
|
|
41124
|
+
headers: {
|
|
41125
|
+
[name: string]: unknown;
|
|
41126
|
+
};
|
|
41127
|
+
content: {
|
|
41128
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
41129
|
+
};
|
|
41130
|
+
};
|
|
41131
|
+
/** @description Channel manager unavailable. */
|
|
41132
|
+
502: {
|
|
41133
|
+
headers: {
|
|
41134
|
+
[name: string]: unknown;
|
|
41135
|
+
};
|
|
41136
|
+
content?: never;
|
|
41137
|
+
};
|
|
41138
|
+
/** @description Channel manager timed out. */
|
|
41139
|
+
504: {
|
|
41140
|
+
headers: {
|
|
41141
|
+
[name: string]: unknown;
|
|
41142
|
+
};
|
|
41143
|
+
content?: never;
|
|
41144
|
+
};
|
|
41145
|
+
};
|
|
41146
|
+
};
|
|
41147
|
+
"delete-use-case": {
|
|
41148
|
+
parameters: {
|
|
41149
|
+
query?: never;
|
|
41150
|
+
header?: never;
|
|
41151
|
+
path: {
|
|
41152
|
+
use_case_id: string;
|
|
41153
|
+
workspace_id: string;
|
|
41154
|
+
};
|
|
41155
|
+
cookie?: never;
|
|
41156
|
+
};
|
|
41157
|
+
requestBody?: never;
|
|
41158
|
+
responses: {
|
|
41159
|
+
/** @description Successful Response */
|
|
41160
|
+
204: {
|
|
41161
|
+
headers: {
|
|
41162
|
+
[name: string]: unknown;
|
|
41163
|
+
};
|
|
41164
|
+
content?: never;
|
|
41165
|
+
};
|
|
41166
|
+
/** @description Insufficient permissions. */
|
|
41167
|
+
403: {
|
|
41168
|
+
headers: {
|
|
41169
|
+
[name: string]: unknown;
|
|
41170
|
+
};
|
|
41171
|
+
content?: never;
|
|
41172
|
+
};
|
|
41173
|
+
/** @description Use case not found. */
|
|
41174
|
+
404: {
|
|
41175
|
+
headers: {
|
|
41176
|
+
[name: string]: unknown;
|
|
41177
|
+
};
|
|
41178
|
+
content?: never;
|
|
41179
|
+
};
|
|
41180
|
+
/** @description Use case has active phone assignments. */
|
|
41181
|
+
409: {
|
|
41182
|
+
headers: {
|
|
41183
|
+
[name: string]: unknown;
|
|
41184
|
+
};
|
|
41185
|
+
content?: never;
|
|
41186
|
+
};
|
|
41187
|
+
/** @description Validation Error */
|
|
41188
|
+
422: {
|
|
41189
|
+
headers: {
|
|
41190
|
+
[name: string]: unknown;
|
|
41191
|
+
};
|
|
41192
|
+
content: {
|
|
41193
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
41194
|
+
};
|
|
41195
|
+
};
|
|
41196
|
+
/** @description Channel manager unavailable. */
|
|
41197
|
+
502: {
|
|
41198
|
+
headers: {
|
|
41199
|
+
[name: string]: unknown;
|
|
41200
|
+
};
|
|
41201
|
+
content?: never;
|
|
41202
|
+
};
|
|
41203
|
+
/** @description Channel manager timed out. */
|
|
41204
|
+
504: {
|
|
41205
|
+
headers: {
|
|
41206
|
+
[name: string]: unknown;
|
|
41207
|
+
};
|
|
41208
|
+
content?: never;
|
|
41209
|
+
};
|
|
41210
|
+
};
|
|
41211
|
+
};
|
|
41212
|
+
"list-voicemails": {
|
|
41213
|
+
parameters: {
|
|
41214
|
+
query?: {
|
|
41215
|
+
use_case_id?: string | null;
|
|
41216
|
+
setup_id?: string | null;
|
|
41217
|
+
status?: string[] | null;
|
|
41218
|
+
recipient_phone_number?: string | null;
|
|
41219
|
+
};
|
|
41220
|
+
header?: never;
|
|
41221
|
+
path: {
|
|
41222
|
+
workspace_id: string;
|
|
41223
|
+
};
|
|
41224
|
+
cookie?: never;
|
|
41225
|
+
};
|
|
41226
|
+
requestBody?: never;
|
|
41227
|
+
responses: {
|
|
41228
|
+
/** @description Successful Response */
|
|
41229
|
+
200: {
|
|
41230
|
+
headers: {
|
|
41231
|
+
[name: string]: unknown;
|
|
41232
|
+
};
|
|
41233
|
+
content: {
|
|
41234
|
+
"application/json": components["schemas"]["VoicemailListResponse"];
|
|
41235
|
+
};
|
|
41236
|
+
};
|
|
41237
|
+
/** @description Insufficient permissions. */
|
|
41238
|
+
403: {
|
|
41239
|
+
headers: {
|
|
41240
|
+
[name: string]: unknown;
|
|
41241
|
+
};
|
|
41242
|
+
content?: never;
|
|
41243
|
+
};
|
|
41244
|
+
/** @description Validation Error */
|
|
41245
|
+
422: {
|
|
41246
|
+
headers: {
|
|
41247
|
+
[name: string]: unknown;
|
|
41248
|
+
};
|
|
41249
|
+
content: {
|
|
41250
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
41251
|
+
};
|
|
41252
|
+
};
|
|
41253
|
+
};
|
|
41254
|
+
};
|
|
41255
|
+
"send-voicemail": {
|
|
41256
|
+
parameters: {
|
|
41257
|
+
query?: never;
|
|
41258
|
+
header?: never;
|
|
41259
|
+
path: {
|
|
41260
|
+
workspace_id: string;
|
|
41261
|
+
};
|
|
41262
|
+
cookie?: never;
|
|
41263
|
+
};
|
|
41264
|
+
requestBody: {
|
|
41265
|
+
content: {
|
|
41266
|
+
"multipart/form-data": components["schemas"]["Body_send-voicemail"];
|
|
41267
|
+
};
|
|
41268
|
+
};
|
|
41269
|
+
responses: {
|
|
41270
|
+
/** @description Successful Response */
|
|
41271
|
+
201: {
|
|
41272
|
+
headers: {
|
|
41273
|
+
[name: string]: unknown;
|
|
41274
|
+
};
|
|
41275
|
+
content: {
|
|
41276
|
+
"application/json": components["schemas"]["VoicemailSentResponse"];
|
|
41277
|
+
};
|
|
41278
|
+
};
|
|
41279
|
+
/** @description Insufficient permissions. */
|
|
41280
|
+
403: {
|
|
41281
|
+
headers: {
|
|
41282
|
+
[name: string]: unknown;
|
|
41283
|
+
};
|
|
41284
|
+
content?: never;
|
|
41285
|
+
};
|
|
41286
|
+
/** @description Use case not found or no phone assigned. */
|
|
41287
|
+
404: {
|
|
41288
|
+
headers: {
|
|
41289
|
+
[name: string]: unknown;
|
|
41290
|
+
};
|
|
41291
|
+
content?: never;
|
|
41292
|
+
};
|
|
41293
|
+
/** @description Audio exceeds 8 MB. */
|
|
41294
|
+
413: {
|
|
41295
|
+
headers: {
|
|
41296
|
+
[name: string]: unknown;
|
|
41297
|
+
};
|
|
41298
|
+
content?: never;
|
|
41299
|
+
};
|
|
41300
|
+
/** @description Invalid audio or configuration. */
|
|
41301
|
+
422: {
|
|
41302
|
+
headers: {
|
|
41303
|
+
[name: string]: unknown;
|
|
41304
|
+
};
|
|
41305
|
+
content?: never;
|
|
41306
|
+
};
|
|
41307
|
+
/** @description Channel manager unavailable. */
|
|
41308
|
+
502: {
|
|
41309
|
+
headers: {
|
|
41310
|
+
[name: string]: unknown;
|
|
41311
|
+
};
|
|
41312
|
+
content?: never;
|
|
41313
|
+
};
|
|
41314
|
+
/** @description Channel manager timed out. */
|
|
41315
|
+
504: {
|
|
41316
|
+
headers: {
|
|
41317
|
+
[name: string]: unknown;
|
|
41318
|
+
};
|
|
41319
|
+
content?: never;
|
|
41320
|
+
};
|
|
41321
|
+
};
|
|
41322
|
+
};
|
|
40679
41323
|
"enroll-voiceprint": {
|
|
40680
41324
|
parameters: {
|
|
40681
41325
|
query?: never;
|
|
@@ -41176,9 +41820,7 @@ export interface operations {
|
|
|
41176
41820
|
[name: string]: unknown;
|
|
41177
41821
|
};
|
|
41178
41822
|
content: {
|
|
41179
|
-
"application/json":
|
|
41180
|
-
[key: string]: unknown;
|
|
41181
|
-
};
|
|
41823
|
+
"application/json": components["schemas"]["WorldDashboardResponse"];
|
|
41182
41824
|
};
|
|
41183
41825
|
};
|
|
41184
41826
|
};
|