@amigo-ai/platform-sdk 0.14.0 → 0.15.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.
@@ -1961,7 +1961,43 @@ export interface paths {
1961
1961
  patch?: never;
1962
1962
  trace?: never;
1963
1963
  };
1964
- "/v1/{workspace_id}/conversations/messages": {
1964
+ "/v1/{workspace_id}/conversations": {
1965
+ parameters: {
1966
+ query?: never;
1967
+ header?: never;
1968
+ path?: never;
1969
+ cookie?: never;
1970
+ };
1971
+ /** List conversations */
1972
+ get: operations["list_conversations_v1__workspace_id__conversations_get"];
1973
+ put?: never;
1974
+ /** Create a new conversation */
1975
+ post: operations["create_conversation_v1__workspace_id__conversations_post"];
1976
+ delete?: never;
1977
+ options?: never;
1978
+ head?: never;
1979
+ patch?: never;
1980
+ trace?: never;
1981
+ };
1982
+ "/v1/{workspace_id}/conversations/{conversation_id}": {
1983
+ parameters: {
1984
+ query?: never;
1985
+ header?: never;
1986
+ path?: never;
1987
+ cookie?: never;
1988
+ };
1989
+ /** Get conversation detail with turns */
1990
+ get: operations["get_conversation_v1__workspace_id__conversations__conversation_id__get"];
1991
+ put?: never;
1992
+ post?: never;
1993
+ /** Close a conversation */
1994
+ delete: operations["close_conversation_v1__workspace_id__conversations__conversation_id__delete"];
1995
+ options?: never;
1996
+ head?: never;
1997
+ patch?: never;
1998
+ trace?: never;
1999
+ };
2000
+ "/v1/{workspace_id}/conversations/{conversation_id}/turns": {
1965
2001
  parameters: {
1966
2002
  query?: never;
1967
2003
  header?: never;
@@ -1970,11 +2006,8 @@ export interface paths {
1970
2006
  };
1971
2007
  get?: never;
1972
2008
  put?: never;
1973
- /**
1974
- * Send a text message and receive the agent's response
1975
- * @description Process a single text message through the agent and return the response synchronously. If `conversation_id` is omitted, a new conversation is created. If provided, the existing conversation is resumed from its frozen state (prior context and commitments are preserved). For real-time streaming, use the WebSocket endpoint at `ws /agent/text-stream`.
1976
- */
1977
- post: operations["send_message_v1__workspace_id__conversations_messages_post"];
2009
+ /** Send a message and get the agent's response */
2010
+ post: operations["create_turn_v1__workspace_id__conversations__conversation_id__turns_post"];
1978
2011
  delete?: never;
1979
2012
  options?: never;
1980
2013
  head?: never;
@@ -9659,7 +9692,7 @@ export interface components {
9659
9692
  */
9660
9693
  completion_reason?: ("completed" | "abandoned" | "escalated" | "transferred" | "timeout" | "error" | "voicemail" | "no_answer" | "caller_hangup" | "forwarded" | "terminal_state" | "warm_transfer_completed" | "no_inbound_audio" | "cancelled") | null;
9661
9694
  /** @description Conversation flow metrics */
9662
- conversation_summary?: components["schemas"]["ConversationSummary"] | null;
9695
+ conversation_summary?: components["schemas"]["src__routes__calls__ConversationSummary"] | null;
9663
9696
  /**
9664
9697
  * Created At
9665
9698
  * @description When intelligence was computed
@@ -10143,6 +10176,15 @@ export interface components {
10143
10176
  */
10144
10177
  status: "accepted" | "skipped";
10145
10178
  };
10179
+ /**
10180
+ * ChannelKind
10181
+ * @description HSM execution channel type.
10182
+ *
10183
+ * Determines how the HSM engine communicates with end users.
10184
+ * Each kind maps to one or more providers.
10185
+ * @enum {string}
10186
+ */
10187
+ ChannelKind: "voice" | "sms" | "whatsapp" | "imessage" | "email" | "web" | "scribe";
10146
10188
  /**
10147
10189
  * ChannelOverride
10148
10190
  * @description Per-channel behavior override for a state.
@@ -10909,6 +10951,35 @@ export interface components {
10909
10951
  /** Workspace Id */
10910
10952
  workspace_id: string;
10911
10953
  };
10954
+ /** ConversationActorStartFailedRequest */
10955
+ ConversationActorStartFailedRequest: {
10956
+ channel_kind: components["schemas"]["ChannelKind"];
10957
+ provider: components["schemas"]["ProviderType"];
10958
+ /** Provider Thread Id */
10959
+ provider_thread_id: string;
10960
+ };
10961
+ /** ConversationActorStartFailedResponse */
10962
+ ConversationActorStartFailedResponse: {
10963
+ /**
10964
+ * Conversation Id
10965
+ * Format: uuid
10966
+ */
10967
+ conversation_id: string;
10968
+ /** Rolled Back */
10969
+ rolled_back: boolean;
10970
+ /**
10971
+ * Status
10972
+ * @enum {string}
10973
+ */
10974
+ status: "active" | "frozen" | "closed";
10975
+ /** Version */
10976
+ version: number;
10977
+ /**
10978
+ * Workspace Id
10979
+ * Format: uuid
10980
+ */
10981
+ workspace_id: string;
10982
+ };
10912
10983
  /** ConversationConfig */
10913
10984
  ConversationConfig: {
10914
10985
  /** Agent Id */
@@ -10928,44 +10999,159 @@ export interface components {
10928
10999
  /** Navigation Model */
10929
11000
  navigation_model?: string | null;
10930
11001
  };
10931
- /** ConversationMessage */
10932
- ConversationMessage: {
11002
+ /** ConversationDetail */
11003
+ ConversationDetail: {
11004
+ /** Channel Kind */
11005
+ channel_kind: string;
11006
+ /** Created At */
11007
+ created_at: string;
11008
+ /** Entity Id */
11009
+ entity_id?: string | null;
11010
+ /** Id */
11011
+ id: string;
11012
+ /** Plan */
11013
+ plan?: string | null;
10933
11014
  /**
10934
- * Role
11015
+ * Status
10935
11016
  * @enum {string}
10936
11017
  */
10937
- role: "agent" | "user" | "system";
10938
- /** Text */
10939
- text: string;
11018
+ status: "active" | "frozen" | "closed";
11019
+ /**
11020
+ * Turn Count
11021
+ * @default 0
11022
+ */
11023
+ turn_count?: number;
11024
+ /**
11025
+ * Turns
11026
+ * @default []
11027
+ */
11028
+ turns?: components["schemas"]["ConversationTurn"][];
11029
+ /** Updated At */
11030
+ updated_at: string;
10940
11031
  };
10941
- /**
10942
- * ConversationSummary
10943
- * @description Conversation flow metrics.
10944
- */
10945
- ConversationSummary: {
11032
+ /** ConversationListResponse */
11033
+ ConversationListResponse: {
11034
+ /** Has More */
11035
+ has_more: boolean;
11036
+ /** Items */
11037
+ items: components["schemas"]["src__routes__conversations__ConversationSummary"][];
11038
+ /** Total */
11039
+ total: number;
11040
+ };
11041
+ /** ConversationReactivationResponse */
11042
+ ConversationReactivationResponse: {
10946
11043
  /**
10947
- * Avg Turn Duration Seconds
10948
- * @description Average turn duration
11044
+ * Conversation Id
11045
+ * Format: uuid
10949
11046
  */
10950
- avg_turn_duration_seconds?: number | null;
11047
+ conversation_id: string;
10951
11048
  /**
10952
- * Barge In Count
10953
- * @description Number of caller interruptions
10954
- * @default 0
11049
+ * Status
11050
+ * @enum {string}
10955
11051
  */
10956
- barge_in_count?: number;
11052
+ status: "active" | "reactivated";
11053
+ /** Version */
11054
+ version: number;
10957
11055
  /**
10958
- * Loop Count
10959
- * @description Number of detected conversation loops
10960
- * @default 0
11056
+ * Workspace Id
11057
+ * Format: uuid
10961
11058
  */
10962
- loop_count?: number;
11059
+ workspace_id: string;
11060
+ };
11061
+ /** ConversationStateSaveRequest */
11062
+ ConversationStateSaveRequest: {
11063
+ /** Entity Id */
11064
+ entity_id?: string | null;
11065
+ /** Resume At */
11066
+ resume_at?: string | null;
11067
+ /** State */
11068
+ state: {
11069
+ [key: string]: unknown;
11070
+ };
10963
11071
  /**
10964
- * Topic Changes
10965
- * @description Number of topic transitions
10966
- * @default 0
11072
+ * Status
11073
+ * @enum {string}
10967
11074
  */
10968
- topic_changes?: number;
11075
+ status: "active" | "frozen" | "closed";
11076
+ /** Version */
11077
+ version: number;
11078
+ };
11079
+ /** ConversationStateSaveResponse */
11080
+ ConversationStateSaveResponse: {
11081
+ /**
11082
+ * Conversation Id
11083
+ * Format: uuid
11084
+ */
11085
+ conversation_id: string;
11086
+ /**
11087
+ * Status
11088
+ * @enum {string}
11089
+ */
11090
+ status: "active" | "frozen" | "closed";
11091
+ /** Version */
11092
+ version: number;
11093
+ /**
11094
+ * Workspace Id
11095
+ * Format: uuid
11096
+ */
11097
+ workspace_id: string;
11098
+ };
11099
+ /** ConversationThreadRequest */
11100
+ ConversationThreadRequest: {
11101
+ channel_kind: components["schemas"]["ChannelKind"];
11102
+ /** Entity Id */
11103
+ entity_id?: string | null;
11104
+ provider: components["schemas"]["ProviderType"];
11105
+ /** Provider Thread Id */
11106
+ provider_thread_id: string;
11107
+ };
11108
+ /** ConversationThreadResponse */
11109
+ ConversationThreadResponse: {
11110
+ channel_kind: components["schemas"]["ChannelKind"];
11111
+ /**
11112
+ * Conversation Id
11113
+ * Format: uuid
11114
+ */
11115
+ conversation_id: string;
11116
+ /** Created */
11117
+ created: boolean;
11118
+ /** Created At */
11119
+ created_at: number;
11120
+ /** Entity Id */
11121
+ entity_id?: string | null;
11122
+ provider: components["schemas"]["ProviderType"];
11123
+ /** Provider Thread Id */
11124
+ provider_thread_id: string;
11125
+ /** Reactivated */
11126
+ reactivated: boolean;
11127
+ /** State */
11128
+ state: {
11129
+ [key: string]: unknown;
11130
+ };
11131
+ /**
11132
+ * Status
11133
+ * @constant
11134
+ */
11135
+ status: "active";
11136
+ /** Version */
11137
+ version: number;
11138
+ /**
11139
+ * Workspace Id
11140
+ * Format: uuid
11141
+ */
11142
+ workspace_id: string;
11143
+ };
11144
+ /** ConversationTurn */
11145
+ ConversationTurn: {
11146
+ /**
11147
+ * Role
11148
+ * @enum {string}
11149
+ */
11150
+ role: "agent" | "user" | "system";
11151
+ /** Text */
11152
+ text: string;
11153
+ /** Timestamp */
11154
+ timestamp?: string | null;
10969
11155
  };
10970
11156
  /** ConvertEnvironmentRequest */
10971
11157
  ConvertEnvironmentRequest: {
@@ -11189,6 +11375,13 @@ export interface components {
11189
11375
  /** Topology Description */
11190
11376
  topology_description?: string | null;
11191
11377
  };
11378
+ /** CreateConversationRequest */
11379
+ CreateConversationRequest: {
11380
+ /** Entity Id */
11381
+ entity_id?: string | null;
11382
+ /** Service Id */
11383
+ service_id: string;
11384
+ };
11192
11385
  /** CreateCustomerRequest */
11193
11386
  CreateCustomerRequest: {
11194
11387
  /** Address */
@@ -19169,6 +19362,15 @@ export interface components {
19169
19362
  /** Trigger Delay Ms */
19170
19363
  trigger_delay_ms?: number | null;
19171
19364
  };
19365
+ /**
19366
+ * ProviderType
19367
+ * @description Messaging provider that implements a channel.
19368
+ *
19369
+ * Multiple providers can serve the same ChannelKind (e.g., Twilio and
19370
+ * Infobip both support SMS).
19371
+ * @enum {string}
19372
+ */
19373
+ ProviderType: "twilio" | "infobip" | "sendblue" | "gmail" | "websocket";
19172
19374
  /** ProvisionResponse */
19173
19375
  ProvisionResponse: {
19174
19376
  workspace: components["schemas"]["WorkspaceResponse"];
@@ -20440,41 +20642,6 @@ export interface components {
20440
20642
  */
20441
20643
  status: "delivered" | "failed";
20442
20644
  };
20443
- /** SendMessageRequest */
20444
- SendMessageRequest: {
20445
- /**
20446
- * Conversation Id
20447
- * @description Existing conversation ID to resume. Omit to start a new conversation.
20448
- */
20449
- conversation_id?: string | null;
20450
- /**
20451
- * Entity Id
20452
- * @description Patient entity ID for context loading.
20453
- */
20454
- entity_id?: string | null;
20455
- /**
20456
- * Message
20457
- * @description User message text
20458
- */
20459
- message: string;
20460
- /**
20461
- * Service Id
20462
- * @description Agent service ID
20463
- */
20464
- service_id: string;
20465
- };
20466
- /** SendMessageResponse */
20467
- SendMessageResponse: {
20468
- /** Conversation Id */
20469
- conversation_id: string;
20470
- /** Messages */
20471
- messages: components["schemas"]["ConversationMessage"][];
20472
- /**
20473
- * Status
20474
- * @enum {string}
20475
- */
20476
- status: "active" | "completed" | "error";
20477
- };
20478
20645
  /**
20479
20646
  * Service
20480
20647
  * @description A service links an agent + context graph + version sets.
@@ -23493,6 +23660,20 @@ export interface components {
23493
23660
  /** User Transcript */
23494
23661
  user_transcript?: string | null;
23495
23662
  };
23663
+ /** TurnConversationSnapshot */
23664
+ TurnConversationSnapshot: {
23665
+ /** Id */
23666
+ id: string;
23667
+ /**
23668
+ * Status
23669
+ * @enum {string}
23670
+ */
23671
+ status: "active" | "frozen" | "closed";
23672
+ /** Turn Count */
23673
+ turn_count: number;
23674
+ /** Updated At */
23675
+ updated_at: string;
23676
+ };
23496
23677
  /**
23497
23678
  * TurnPolicy
23498
23679
  * @description Voice pipeline parameters declared per HSM state.
@@ -23547,6 +23728,20 @@ export interface components {
23547
23728
  /** Stt Eot Timeout Ms */
23548
23729
  stt_eot_timeout_ms?: number | null;
23549
23730
  };
23731
+ /** TurnRequest */
23732
+ TurnRequest: {
23733
+ /** Message */
23734
+ message: string;
23735
+ };
23736
+ /** TurnResponse */
23737
+ TurnResponse: {
23738
+ conversation: components["schemas"]["TurnConversationSnapshot"];
23739
+ input: components["schemas"]["ConversationTurn"];
23740
+ /** Output */
23741
+ output: components["schemas"]["ConversationTurn"][];
23742
+ /** Turn Id */
23743
+ turn_id: string;
23744
+ };
23550
23745
  /** TurnTimeline */
23551
23746
  TurnTimeline: {
23552
23747
  /** Active End */
@@ -25134,6 +25329,58 @@ export interface components {
25134
25329
  */
25135
25330
  workspace_id: string;
25136
25331
  };
25332
+ /**
25333
+ * ConversationSummary
25334
+ * @description Conversation flow metrics.
25335
+ */
25336
+ src__routes__calls__ConversationSummary: {
25337
+ /**
25338
+ * Avg Turn Duration Seconds
25339
+ * @description Average turn duration
25340
+ */
25341
+ avg_turn_duration_seconds?: number | null;
25342
+ /**
25343
+ * Barge In Count
25344
+ * @description Number of caller interruptions
25345
+ * @default 0
25346
+ */
25347
+ barge_in_count?: number;
25348
+ /**
25349
+ * Loop Count
25350
+ * @description Number of detected conversation loops
25351
+ * @default 0
25352
+ */
25353
+ loop_count?: number;
25354
+ /**
25355
+ * Topic Changes
25356
+ * @description Number of topic transitions
25357
+ * @default 0
25358
+ */
25359
+ topic_changes?: number;
25360
+ };
25361
+ /** ConversationSummary */
25362
+ src__routes__conversations__ConversationSummary: {
25363
+ /** Channel Kind */
25364
+ channel_kind: string;
25365
+ /** Created At */
25366
+ created_at: string;
25367
+ /** Entity Id */
25368
+ entity_id?: string | null;
25369
+ /** Id */
25370
+ id: string;
25371
+ /**
25372
+ * Status
25373
+ * @enum {string}
25374
+ */
25375
+ status: "active" | "frozen" | "closed";
25376
+ /**
25377
+ * Turn Count
25378
+ * @default 0
25379
+ */
25380
+ turn_count?: number;
25381
+ /** Updated At */
25382
+ updated_at: string;
25383
+ };
25137
25384
  /** CreateSessionRequest */
25138
25385
  src__routes__desktop_sessions__CreateSessionRequest: {
25139
25386
  integration_name: components["schemas"]["NameString"];
@@ -30017,18 +30264,151 @@ export interface operations {
30017
30264
  };
30018
30265
  };
30019
30266
  };
30020
- send_message_v1__workspace_id__conversations_messages_post: {
30267
+ list_conversations_v1__workspace_id__conversations_get: {
30268
+ parameters: {
30269
+ query?: {
30270
+ status?: ("active" | "frozen" | "closed") | null;
30271
+ limit?: number;
30272
+ offset?: number;
30273
+ };
30274
+ header?: never;
30275
+ path: {
30276
+ workspace_id: string;
30277
+ };
30278
+ cookie?: never;
30279
+ };
30280
+ requestBody?: never;
30281
+ responses: {
30282
+ /** @description Successful Response */
30283
+ 200: {
30284
+ headers: {
30285
+ [name: string]: unknown;
30286
+ };
30287
+ content: {
30288
+ "application/json": components["schemas"]["ConversationListResponse"];
30289
+ };
30290
+ };
30291
+ /** @description Validation Error */
30292
+ 422: {
30293
+ headers: {
30294
+ [name: string]: unknown;
30295
+ };
30296
+ content: {
30297
+ "application/json": components["schemas"]["HTTPValidationError"];
30298
+ };
30299
+ };
30300
+ };
30301
+ };
30302
+ create_conversation_v1__workspace_id__conversations_post: {
30303
+ parameters: {
30304
+ query?: never;
30305
+ header?: never;
30306
+ path: {
30307
+ workspace_id: string;
30308
+ };
30309
+ cookie?: never;
30310
+ };
30311
+ requestBody: {
30312
+ content: {
30313
+ "application/json": components["schemas"]["CreateConversationRequest"];
30314
+ };
30315
+ };
30316
+ responses: {
30317
+ /** @description Successful Response */
30318
+ 201: {
30319
+ headers: {
30320
+ [name: string]: unknown;
30321
+ };
30322
+ content: {
30323
+ "application/json": components["schemas"]["ConversationDetail"];
30324
+ };
30325
+ };
30326
+ /** @description Validation Error */
30327
+ 422: {
30328
+ headers: {
30329
+ [name: string]: unknown;
30330
+ };
30331
+ content: {
30332
+ "application/json": components["schemas"]["HTTPValidationError"];
30333
+ };
30334
+ };
30335
+ };
30336
+ };
30337
+ get_conversation_v1__workspace_id__conversations__conversation_id__get: {
30338
+ parameters: {
30339
+ query?: never;
30340
+ header?: never;
30341
+ path: {
30342
+ conversation_id: string;
30343
+ workspace_id: string;
30344
+ };
30345
+ cookie?: never;
30346
+ };
30347
+ requestBody?: never;
30348
+ responses: {
30349
+ /** @description Successful Response */
30350
+ 200: {
30351
+ headers: {
30352
+ [name: string]: unknown;
30353
+ };
30354
+ content: {
30355
+ "application/json": components["schemas"]["ConversationDetail"];
30356
+ };
30357
+ };
30358
+ /** @description Validation Error */
30359
+ 422: {
30360
+ headers: {
30361
+ [name: string]: unknown;
30362
+ };
30363
+ content: {
30364
+ "application/json": components["schemas"]["HTTPValidationError"];
30365
+ };
30366
+ };
30367
+ };
30368
+ };
30369
+ close_conversation_v1__workspace_id__conversations__conversation_id__delete: {
30370
+ parameters: {
30371
+ query?: never;
30372
+ header?: never;
30373
+ path: {
30374
+ conversation_id: string;
30375
+ workspace_id: string;
30376
+ };
30377
+ cookie?: never;
30378
+ };
30379
+ requestBody?: never;
30380
+ responses: {
30381
+ /** @description Successful Response */
30382
+ 204: {
30383
+ headers: {
30384
+ [name: string]: unknown;
30385
+ };
30386
+ content?: never;
30387
+ };
30388
+ /** @description Validation Error */
30389
+ 422: {
30390
+ headers: {
30391
+ [name: string]: unknown;
30392
+ };
30393
+ content: {
30394
+ "application/json": components["schemas"]["HTTPValidationError"];
30395
+ };
30396
+ };
30397
+ };
30398
+ };
30399
+ create_turn_v1__workspace_id__conversations__conversation_id__turns_post: {
30021
30400
  parameters: {
30022
30401
  query?: never;
30023
30402
  header?: never;
30024
30403
  path: {
30404
+ conversation_id: string;
30025
30405
  workspace_id: string;
30026
30406
  };
30027
30407
  cookie?: never;
30028
30408
  };
30029
30409
  requestBody: {
30030
30410
  content: {
30031
- "application/json": components["schemas"]["SendMessageRequest"];
30411
+ "application/json": components["schemas"]["TurnRequest"];
30032
30412
  };
30033
30413
  };
30034
30414
  responses: {
@@ -30038,7 +30418,7 @@ export interface operations {
30038
30418
  [name: string]: unknown;
30039
30419
  };
30040
30420
  content: {
30041
- "application/json": components["schemas"]["SendMessageResponse"];
30421
+ "application/json": components["schemas"]["TurnResponse"];
30042
30422
  };
30043
30423
  };
30044
30424
  /** @description Validation Error */