@epilot/sdk 2.20.67 → 2.20.68

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.
Files changed (136) hide show
  1. package/definitions/message-runtime.json +1 -1
  2. package/definitions/message.json +1312 -14
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/chat.cjs +6 -6
  24. package/dist/apis/chat.js +1 -1
  25. package/dist/apis/configuration-hub.cjs +6 -6
  26. package/dist/apis/configuration-hub.js +1 -1
  27. package/dist/apis/consent.cjs +6 -6
  28. package/dist/apis/consent.js +1 -1
  29. package/dist/apis/customer-portal.cjs +6 -6
  30. package/dist/apis/customer-portal.js +1 -1
  31. package/dist/apis/dashboard.cjs +6 -6
  32. package/dist/apis/dashboard.js +1 -1
  33. package/dist/apis/data-governance.cjs +6 -6
  34. package/dist/apis/data-governance.js +1 -1
  35. package/dist/apis/deduplication.cjs +6 -6
  36. package/dist/apis/deduplication.js +1 -1
  37. package/dist/apis/design.cjs +6 -6
  38. package/dist/apis/design.js +1 -1
  39. package/dist/apis/document.cjs +6 -6
  40. package/dist/apis/document.js +1 -1
  41. package/dist/apis/email-settings.cjs +6 -6
  42. package/dist/apis/email-settings.js +1 -1
  43. package/dist/apis/email-template.cjs +6 -6
  44. package/dist/apis/email-template.js +1 -1
  45. package/dist/apis/entity-mapping.cjs +6 -6
  46. package/dist/apis/entity-mapping.js +1 -1
  47. package/dist/apis/entity.cjs +6 -6
  48. package/dist/apis/entity.js +1 -1
  49. package/dist/apis/environments.cjs +6 -6
  50. package/dist/apis/environments.js +1 -1
  51. package/dist/apis/event-catalog.cjs +6 -6
  52. package/dist/apis/event-catalog.js +1 -1
  53. package/dist/apis/external-values.cjs +6 -6
  54. package/dist/apis/external-values.js +1 -1
  55. package/dist/apis/file.cjs +6 -6
  56. package/dist/apis/file.js +1 -1
  57. package/dist/apis/iban.cjs +6 -6
  58. package/dist/apis/iban.js +1 -1
  59. package/dist/apis/identity.cjs +6 -6
  60. package/dist/apis/identity.js +1 -1
  61. package/dist/apis/integration-toolkit.cjs +6 -6
  62. package/dist/apis/integration-toolkit.js +1 -1
  63. package/dist/apis/journey.cjs +6 -6
  64. package/dist/apis/journey.js +1 -1
  65. package/dist/apis/kanban.cjs +6 -6
  66. package/dist/apis/kanban.js +1 -1
  67. package/dist/apis/message.cjs +8 -8
  68. package/dist/apis/message.d.cts +2 -2
  69. package/dist/apis/message.d.ts +2 -2
  70. package/dist/apis/message.js +2 -2
  71. package/dist/apis/metering.cjs +6 -6
  72. package/dist/apis/metering.js +1 -1
  73. package/dist/apis/notes.cjs +6 -6
  74. package/dist/apis/notes.js +1 -1
  75. package/dist/apis/notification.cjs +6 -6
  76. package/dist/apis/notification.js +1 -1
  77. package/dist/apis/organization.cjs +6 -6
  78. package/dist/apis/organization.js +1 -1
  79. package/dist/apis/partner-directory.cjs +6 -6
  80. package/dist/apis/partner-directory.js +1 -1
  81. package/dist/apis/permissions.cjs +6 -6
  82. package/dist/apis/permissions.js +1 -1
  83. package/dist/apis/phone-integration.cjs +6 -6
  84. package/dist/apis/phone-integration.js +1 -1
  85. package/dist/apis/pricing-tier.cjs +6 -6
  86. package/dist/apis/pricing-tier.js +1 -1
  87. package/dist/apis/pricing.cjs +6 -6
  88. package/dist/apis/pricing.js +1 -1
  89. package/dist/apis/purpose.cjs +6 -6
  90. package/dist/apis/purpose.js +1 -1
  91. package/dist/apis/query.cjs +6 -6
  92. package/dist/apis/query.js +1 -1
  93. package/dist/apis/sandbox.cjs +6 -6
  94. package/dist/apis/sandbox.js +1 -1
  95. package/dist/apis/sharing.cjs +6 -6
  96. package/dist/apis/sharing.js +1 -1
  97. package/dist/apis/snapshot.cjs +6 -6
  98. package/dist/apis/snapshot.js +1 -1
  99. package/dist/apis/submission.cjs +6 -6
  100. package/dist/apis/submission.js +1 -1
  101. package/dist/apis/target.cjs +6 -6
  102. package/dist/apis/target.js +1 -1
  103. package/dist/apis/targeting.cjs +6 -6
  104. package/dist/apis/targeting.js +1 -1
  105. package/dist/apis/template-variables.cjs +6 -6
  106. package/dist/apis/template-variables.js +1 -1
  107. package/dist/apis/user.cjs +6 -6
  108. package/dist/apis/user.js +1 -1
  109. package/dist/apis/validation-rules.cjs +6 -6
  110. package/dist/apis/validation-rules.js +1 -1
  111. package/dist/apis/webhooks.cjs +6 -6
  112. package/dist/apis/webhooks.js +1 -1
  113. package/dist/apis/workflow-definition.cjs +6 -6
  114. package/dist/apis/workflow-definition.js +1 -1
  115. package/dist/apis/workflow.cjs +6 -6
  116. package/dist/apis/workflow.js +1 -1
  117. package/dist/{chunk-OOBSXWVB.js → chunk-6WXFXQKB.js} +2 -2
  118. package/dist/chunk-AWYQVLER.cjs +14 -0
  119. package/dist/chunk-HQ3YHL5H.js +14 -0
  120. package/dist/{chunk-JJDDKFBB.cjs → chunk-LGNMQHO5.cjs} +2 -2
  121. package/dist/index.cjs +10 -10
  122. package/dist/index.d.cts +1 -1
  123. package/dist/index.d.ts +1 -1
  124. package/dist/index.js +2 -2
  125. package/dist/message-AJJJK44K.js +7 -0
  126. package/dist/message-XIJPEF22.cjs +7 -0
  127. package/dist/{message-runtime-4JSNBEVL.cjs → message-runtime-ERSSQCHN.cjs} +2 -2
  128. package/dist/{message-runtime-7UM7U4VL.js → message-runtime-I7WFL4J3.js} +1 -1
  129. package/dist/{message.d-DwnqO-Us.d.cts → message.d-CRg7bM_m.d.cts} +384 -11
  130. package/dist/{message.d-DwnqO-Us.d.ts → message.d-CRg7bM_m.d.ts} +384 -11
  131. package/docs/message.md +403 -12
  132. package/package.json +1 -1
  133. package/dist/chunk-EHLNSFCU.cjs +0 -14
  134. package/dist/chunk-OT6AETWN.js +0 -14
  135. package/dist/message-LJ32JH6Z.cjs +0 -7
  136. package/dist/message-SSTVRGEF.js +0 -7
@@ -239,6 +239,57 @@ declare namespace Components {
239
239
  */
240
240
  save_to_entity?: boolean;
241
241
  }
242
+ export interface LinkSuggestion {
243
+ /**
244
+ * Stable id of the suggestion (identifier + candidate set), shared across a thread's messages
245
+ */
246
+ id: string;
247
+ /**
248
+ * The identifier found in the message, as written there
249
+ */
250
+ identifier: string;
251
+ /**
252
+ * Where the identifier was found, e.g. "subject" or "text"
253
+ */
254
+ found_in?: string;
255
+ /**
256
+ * pending while any candidate is pending; once all are resolved, accepted if any candidate was linked, otherwise dismissed
257
+ */
258
+ status: "pending" | "accepted" | "dismissed";
259
+ candidates: LinkSuggestionCandidate[];
260
+ /**
261
+ * Candidates that were linked from this suggestion
262
+ */
263
+ accepted_entity_ids?: string[];
264
+ resolved_by?: TimelineActor;
265
+ resolved_at?: string; // date-time
266
+ created_at?: string; // date-time
267
+ }
268
+ export interface LinkSuggestionCandidate {
269
+ entity_id: string;
270
+ /**
271
+ * Entity schema slug, e.g. "contract"
272
+ */
273
+ schema: string;
274
+ /**
275
+ * The identifier attribute that matched, e.g. "contract_number"
276
+ */
277
+ attribute?: string;
278
+ /**
279
+ * The stored value that matched
280
+ */
281
+ attribute_value?: string;
282
+ /**
283
+ * Entity title when the suggestion was recorded
284
+ */
285
+ title?: string;
286
+ /**
287
+ * Resolution of this candidate. Absent on suggestions recorded before candidates were resolved individually.
288
+ */
289
+ status?: "pending" | "linked" | "dismissed";
290
+ resolved_by?: TimelineActor;
291
+ resolved_at?: string; // date-time
292
+ }
242
293
  export interface Message {
243
294
  /**
244
295
  * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
@@ -350,10 +401,22 @@ declare namespace Components {
350
401
  */
351
402
  parent_message_id?: string;
352
403
  }
404
+ export interface MessageEntityLinkSuggestedEvent {
405
+ type: "MESSAGE_ENTITY_LINK_SUGGESTED";
406
+ suggestions?: TimelineLinkSuggestion[];
407
+ }
408
+ export interface MessageEntityLinkSuggestionDismissedEvent {
409
+ type: "MESSAGE_ENTITY_LINK_SUGGESTION_DISMISSED";
410
+ suggestions?: TimelineLinkSuggestion[];
411
+ }
353
412
  export interface MessageEntityLinkedEvent {
354
413
  type: "MESSAGE_ENTITY_LINKED";
355
414
  entities?: TimelineLinkedEntity[];
356
415
  link_kind?: "manual" | "auto";
416
+ /**
417
+ * The link accepted a pending entity-link suggestion
418
+ */
419
+ from_suggestion?: boolean;
357
420
  }
358
421
  export interface MessageEntityUnlinkedEvent {
359
422
  type: "MESSAGE_ENTITY_UNLINKED";
@@ -389,10 +452,12 @@ declare namespace Components {
389
452
  */
390
453
  complete_thread?: boolean;
391
454
  /**
392
- * Whether to mark the thread as read by the sender's org/user after sending a reply.
393
- * Only applies when `parent_id` is set. When false, the thread's `org_read_message` and
394
- * `user_read_message` arrays are left unchanged, so the thread remains unread for anyone
395
- * who had it unread before. Defaults to true for backward compatibility.
455
+ * When true (default), replying marks the whole thread read for the sender: every message on the
456
+ * thread is marked read, so the thread is read without leaving any message unread under it. When
457
+ * false, no message is marked and the thread's read-state reflects its messages — a message still
458
+ * unread keeps the thread unread (e.g. an automated reply-in-thread stays unread for a human to
459
+ * pick up). Only applies to replies (`parent_id` set); a new thread always reflects its single
460
+ * message. Defaults to true.
396
461
  *
397
462
  */
398
463
  mark_thread_as_read?: boolean;
@@ -619,6 +684,10 @@ declare namespace Components {
619
684
  * 3f34ce73-089c-4d45-a5ee-c161234e41c3
620
685
  */
621
686
  template_id?: string;
687
+ /**
688
+ * Entity-link suggestions recorded when the message arrived: identifiers that matched entities of different customers, so none was linked automatically.
689
+ */
690
+ link_suggestions?: LinkSuggestion[];
622
691
  /**
623
692
  * If true then html is not provided and must be downloaded using the html_download_url
624
693
  */
@@ -653,6 +722,28 @@ declare namespace Components {
653
722
  * Who is marking an item as read or unread.
654
723
  */
655
724
  export type ReadingScope = "organization" | "user";
725
+ export interface ReplyContextEntityRef {
726
+ _id: string;
727
+ _schema: string;
728
+ }
729
+ export interface ReplyContextMessage {
730
+ id: string;
731
+ created_at?: string; // date-time
732
+ type: "RECEIVED" | "SENT";
733
+ /**
734
+ * Who wrote the message from the organization's point of view
735
+ */
736
+ role: "customer" | "agent" | "partner";
737
+ subject?: string;
738
+ from?: {
739
+ address?: string;
740
+ name?: string;
741
+ };
742
+ /**
743
+ * Plain text body with quotes, forwarded content, reply headers and links removed
744
+ */
745
+ text: string;
746
+ }
656
747
  export interface SearchIDParams {
657
748
  /**
658
749
  * The view to compile, with the same meaning as on `threads:search`. Present here because
@@ -918,6 +1009,43 @@ declare namespace Components {
918
1009
  sort?: string;
919
1010
  highlight?: any;
920
1011
  }
1012
+ export interface SimilarSentMessage {
1013
+ message_id: string;
1014
+ thread_id?: string;
1015
+ subject?: string;
1016
+ /**
1017
+ * Anonymized plain text of the sent message
1018
+ */
1019
+ text: string;
1020
+ created_at?: string;
1021
+ /**
1022
+ * Similarity in 0-1, higher is more similar
1023
+ */
1024
+ score: number;
1025
+ }
1026
+ export interface SimilarSentMessagesRequest {
1027
+ /**
1028
+ * Texts to search with. Results are merged across queries, best score per message wins.
1029
+ */
1030
+ queries: [
1031
+ string,
1032
+ string?,
1033
+ string?,
1034
+ string?,
1035
+ string?
1036
+ ];
1037
+ /**
1038
+ * Maximum number of messages to return
1039
+ */
1040
+ limit?: number;
1041
+ /**
1042
+ * Minimum similarity (0-1, cosine certainty) a message must reach to be returned
1043
+ */
1044
+ min_score?: number;
1045
+ }
1046
+ export interface SimilarSentMessagesResponse {
1047
+ results: SimilarSentMessage[];
1048
+ }
921
1049
  /**
922
1050
  * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
923
1051
  */
@@ -1002,9 +1130,100 @@ declare namespace Components {
1002
1130
  */
1003
1131
  organization_id: string;
1004
1132
  }
1133
+ export interface ThreadReplyContext {
1134
+ thread_id: string;
1135
+ topic?: string;
1136
+ /**
1137
+ * ID of the latest received message, i.e. the one a reply would answer. Absent if none.
1138
+ */
1139
+ reply_to_message_id?: string;
1140
+ /**
1141
+ * Conversation oldest first, cleaned for prompting
1142
+ */
1143
+ messages: ReplyContextMessage[];
1144
+ /**
1145
+ * Entities linked to the conversation (recipients, message relations), not hydrated
1146
+ */
1147
+ related_entities: ReplyContextEntityRef[];
1148
+ }
1005
1149
  export interface ThreadRestoredEvent {
1006
1150
  type: "THREAD_RESTORED";
1007
1151
  }
1152
+ export interface ThreadSummary {
1153
+ orgId: string;
1154
+ /**
1155
+ * Opaque ID of the summary job
1156
+ */
1157
+ jobId: string;
1158
+ /**
1159
+ * ID of the AI agent execution generating the summary. Absent until generation has started.
1160
+ */
1161
+ executionId?: string;
1162
+ jobStatus: {
1163
+ status: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
1164
+ /**
1165
+ * Error message if the job failed
1166
+ */
1167
+ error?: string;
1168
+ };
1169
+ payload?: /* Present once the summary is generated */ ThreadSummaryPayload;
1170
+ createdAt: string; // date-time
1171
+ updatedAt: string; // date-time
1172
+ }
1173
+ export interface ThreadSummaryContext {
1174
+ thread_id: string;
1175
+ /**
1176
+ * Message the summary is generated for
1177
+ */
1178
+ message_id: string;
1179
+ /**
1180
+ * Subject of the first message, "No subject" if empty
1181
+ */
1182
+ subject: string;
1183
+ /**
1184
+ * Messages formatted as <Message> blocks, ready to insert into the prompt
1185
+ */
1186
+ conversation: string;
1187
+ /**
1188
+ * Entities of the conversation formatted as <Entity> lines, ready to insert into the prompt
1189
+ */
1190
+ entity_context: string;
1191
+ }
1192
+ export interface ThreadSummaryEntityRef {
1193
+ id: string;
1194
+ /**
1195
+ * example:
1196
+ * Raven GmbH
1197
+ */
1198
+ displayText: string;
1199
+ /**
1200
+ * Entity schema, or `internal` for a user of the organization
1201
+ * example:
1202
+ * contact
1203
+ */
1204
+ schema: string;
1205
+ }
1206
+ /**
1207
+ * Present once the summary is generated
1208
+ */
1209
+ export interface ThreadSummaryPayload {
1210
+ /**
1211
+ * Bullet points summarizing the thread
1212
+ */
1213
+ summary?: string[] | null;
1214
+ /**
1215
+ * Main topics of the thread
1216
+ */
1217
+ topics?: string[] | null;
1218
+ /**
1219
+ * Recommended next steps for the agent
1220
+ */
1221
+ next_steps?: string[] | null;
1222
+ /**
1223
+ * Entities whose IDs can appear in the summary, topics and next steps
1224
+ */
1225
+ refs?: ThreadSummaryEntityRef[];
1226
+ }
1008
1227
  export interface ThreadTimeline {
1009
1228
  events: TimelineEvent[];
1010
1229
  }
@@ -1129,7 +1348,7 @@ declare namespace Components {
1129
1348
  /**
1130
1349
  * Timestamp of the event
1131
1350
  * example:
1132
- * 2024-01-01T00:00:00.000Z
1351
+ * 2024-01-01T00:00:00Z
1133
1352
  */
1134
1353
  timestamp: string;
1135
1354
  /**
@@ -1147,7 +1366,12 @@ declare namespace Components {
1147
1366
  name?: string;
1148
1367
  };
1149
1368
  }
1150
- export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent | WorkflowStartedEvent | ThreadUserAssignedEvent | MessageLabelAddedEvent | MessageLabelRemovedEvent | MessageEntityLinkedEvent | MessageEntityUnlinkedEvent | MessageAutoReplySentEvent | ThreadMovedToInboxEvent | ThreadTrashedEvent | ThreadRestoredEvent;
1369
+ export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent | WorkflowStartedEvent | ThreadUserAssignedEvent | MessageLabelAddedEvent | MessageLabelRemovedEvent | MessageEntityLinkedEvent | MessageEntityUnlinkedEvent | MessageEntityLinkSuggestedEvent | MessageEntityLinkSuggestionDismissedEvent | MessageAutoReplySentEvent | ThreadMovedToInboxEvent | ThreadTrashedEvent | ThreadRestoredEvent;
1370
+ export interface TimelineLinkSuggestion {
1371
+ id?: string;
1372
+ identifier: string;
1373
+ candidates?: TimelineLinkedEntity[];
1374
+ }
1151
1375
  export interface TimelineLinkedEntity {
1152
1376
  entity_id: string;
1153
1377
  /**
@@ -1252,12 +1476,18 @@ declare namespace Components {
1252
1476
  */
1253
1477
  actor: "organization" | "user";
1254
1478
  /**
1255
- * Restrict every scope to messages involving these addresses.
1479
+ * The addresses selected in the address filter, applied to the `organization` scope only.
1480
+ *
1481
+ * Not a request-level restriction, despite arriving at request level. A `shared_inbox`
1482
+ * scope's own list applies no address filter at all, because scoping to an inbox is what
1483
+ * switches it off, and a `saved_view` ignores the address lens entirely. Applying this to
1484
+ * either would make the badge answer a narrower question than the list beneath it.
1485
+ *
1256
1486
  */
1257
1487
  email_filter?: string[];
1258
1488
  /**
1259
1489
  * The caller's group ids, as `group_<id>`, with the same meaning and constraints as on
1260
- * `threads:search`. Read only when a scope carries a `view`. Entries not matching
1490
+ * `threads:search`. Read when a scope carries a `view` or an organization scope is present. Entries not matching
1261
1491
  * `group_<id>` are dropped. Not an authorization input.
1262
1492
  *
1263
1493
  */
@@ -1621,6 +1851,36 @@ declare namespace Paths {
1621
1851
  }
1622
1852
  }
1623
1853
  }
1854
+ namespace DismissThreadLinkSuggestions {
1855
+ namespace Parameters {
1856
+ export type Id = string;
1857
+ }
1858
+ export interface PathParameters {
1859
+ id: Parameters.Id;
1860
+ }
1861
+ export interface RequestBody {
1862
+ /**
1863
+ * Suggestions to dismiss candidates of. Omit for every pending suggestion on the thread.
1864
+ */
1865
+ suggestion_ids?: string[];
1866
+ /**
1867
+ * Candidates to dismiss. Omit to dismiss every pending candidate of the selected suggestions.
1868
+ */
1869
+ entity_ids?: string[];
1870
+ }
1871
+ namespace Responses {
1872
+ export interface $200 {
1873
+ /**
1874
+ * IDs of the suggestions that had at least one candidate dismissed
1875
+ */
1876
+ dismissed: string[];
1877
+ }
1878
+ export interface $403 {
1879
+ }
1880
+ export interface $404 {
1881
+ }
1882
+ }
1883
+ }
1624
1884
  namespace GetAssigneeWorkload {
1625
1885
  export type RequestBody = Components.Schemas.AssigneeWorkloadParams;
1626
1886
  namespace Responses {
@@ -1976,6 +2236,10 @@ declare namespace Paths {
1976
2236
  * 3f34ce73-089c-4d45-a5ee-c161234e41c3
1977
2237
  */
1978
2238
  template_id?: string;
2239
+ /**
2240
+ * Entity-link suggestions recorded when the message arrived: identifiers that matched entities of different customers, so none was linked automatically.
2241
+ */
2242
+ link_suggestions?: Components.Schemas.LinkSuggestion[];
1979
2243
  /**
1980
2244
  * If true then html is not provided and must be downloaded using the html_download_url
1981
2245
  */
@@ -1991,6 +2255,28 @@ declare namespace Paths {
1991
2255
  }
1992
2256
  }
1993
2257
  }
2258
+ namespace GetThreadSummary {
2259
+ namespace Parameters {
2260
+ export type Id = string;
2261
+ export type MessageId = string;
2262
+ }
2263
+ export interface PathParameters {
2264
+ id: Parameters.Id;
2265
+ }
2266
+ export interface QueryParameters {
2267
+ message_id?: Parameters.MessageId;
2268
+ }
2269
+ namespace Responses {
2270
+ export type $200 = Components.Schemas.ThreadSummary;
2271
+ export type $202 = Components.Schemas.ThreadSummary;
2272
+ export interface $400 {
2273
+ }
2274
+ export interface $403 {
2275
+ }
2276
+ export interface $404 {
2277
+ }
2278
+ }
2279
+ }
1994
2280
  namespace GetThreadTimeline {
1995
2281
  namespace Parameters {
1996
2282
  export type Id = string;
@@ -2773,6 +3059,8 @@ declare namespace Paths {
2773
3059
  }
2774
3060
  export interface $403 {
2775
3061
  }
3062
+ export interface $409 {
3063
+ }
2776
3064
  }
2777
3065
  }
2778
3066
  namespace SendMessage {
@@ -3458,6 +3746,11 @@ interface OperationMethods {
3458
3746
  * sendMessage - sendMessage
3459
3747
  *
3460
3748
  * Send an email message
3749
+ *
3750
+ * Requires `message:send` and `entity:create` on `message`; `entity:create` on `thread` only when the
3751
+ * request starts a new thread (a `thread` and no `parent_id`). With `do_not_create_entities=true` only
3752
+ * `message:send` is required. Checked with the caller's token before the send is queued (403).
3753
+ *
3461
3754
  */
3462
3755
  'sendMessage'(
3463
3756
  parameters?: Parameters<Paths.SendMessage.QueryParameters> | null,
@@ -3728,6 +4021,17 @@ interface OperationMethods {
3728
4021
  data?: any,
3729
4022
  config?: AxiosRequestConfig
3730
4023
  ): OperationResponse<Paths.GetThreadTimeline.Responses.$200>
4024
+ /**
4025
+ * getThreadSummary - getThreadSummary
4026
+ *
4027
+ * AI summary of a thread. Returns `202` while it is generated; poll until `jobStatus.status` is `COMPLETED` or `FAILED`.
4028
+ *
4029
+ */
4030
+ 'getThreadSummary'(
4031
+ parameters?: Parameters<Paths.GetThreadSummary.QueryParameters & Paths.GetThreadSummary.PathParameters> | null,
4032
+ data?: any,
4033
+ config?: AxiosRequestConfig
4034
+ ): OperationResponse<Paths.GetThreadSummary.Responses.$200 | Paths.GetThreadSummary.Responses.$202>
3731
4035
  /**
3732
4036
  * trashThread - trashThread
3733
4037
  *
@@ -3948,6 +4252,16 @@ interface OperationMethods {
3948
4252
  data?: Paths.AssignThread.RequestBody,
3949
4253
  config?: AxiosRequestConfig
3950
4254
  ): OperationResponse<Paths.AssignThread.Responses.$204>
4255
+ /**
4256
+ * dismissThreadLinkSuggestions - dismissThreadLinkSuggestions
4257
+ *
4258
+ * Dismiss pending candidates of entity-link suggestions on a thread. A suggestion is recorded on a message when an identifier in it matched entities of different customers, so nothing was linked automatically. Each candidate is resolved on its own: linking one (assignThread) leaves the others suggested until they are linked or dismissed. A suggestion whose candidates are all resolved is not suggested again for the thread.
4259
+ */
4260
+ 'dismissThreadLinkSuggestions'(
4261
+ parameters?: Parameters<Paths.DismissThreadLinkSuggestions.PathParameters> | null,
4262
+ data?: Paths.DismissThreadLinkSuggestions.RequestBody,
4263
+ config?: AxiosRequestConfig
4264
+ ): OperationResponse<Paths.DismissThreadLinkSuggestions.Responses.$200>
3951
4265
  /**
3952
4266
  * unassignThread - unassignThread
3953
4267
  *
@@ -4005,6 +4319,9 @@ interface OperationMethods {
4005
4319
  * createDraft - createDraft
4006
4320
  *
4007
4321
  * Create a new draft
4322
+ *
4323
+ * Requires `entity:create` on `message`, checked with the caller's token before anything is created (403).
4324
+ *
4008
4325
  */
4009
4326
  'createDraft'(
4010
4327
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -4014,7 +4331,11 @@ interface OperationMethods {
4014
4331
  /**
4015
4332
  * sendDraft - sendDraft
4016
4333
  *
4017
- * Send the existing draft to the recipients
4334
+ * Send the existing draft to the recipients.
4335
+ *
4336
+ * Requires `message:send`, `entity:create` on `message` and `entity:edit` on the draft, checked with the
4337
+ * caller's token (403). The id must be a DRAFT of the given thread (409).
4338
+ *
4018
4339
  */
4019
4340
  'sendDraft'(
4020
4341
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -4049,6 +4370,11 @@ interface PathsDictionary {
4049
4370
  * sendMessage - sendMessage
4050
4371
  *
4051
4372
  * Send an email message
4373
+ *
4374
+ * Requires `message:send` and `entity:create` on `message`; `entity:create` on `thread` only when the
4375
+ * request starts a new thread (a `thread` and no `parent_id`). With `do_not_create_entities=true` only
4376
+ * `message:send` is required. Checked with the caller's token before the send is queued (403).
4377
+ *
4052
4378
  */
4053
4379
  'post'(
4054
4380
  parameters?: Parameters<Paths.SendMessage.QueryParameters> | null,
@@ -4372,6 +4698,19 @@ interface PathsDictionary {
4372
4698
  config?: AxiosRequestConfig
4373
4699
  ): OperationResponse<Paths.GetThreadTimeline.Responses.$200>
4374
4700
  }
4701
+ ['/v1/message/threads/{id}/summary']: {
4702
+ /**
4703
+ * getThreadSummary - getThreadSummary
4704
+ *
4705
+ * AI summary of a thread. Returns `202` while it is generated; poll until `jobStatus.status` is `COMPLETED` or `FAILED`.
4706
+ *
4707
+ */
4708
+ 'get'(
4709
+ parameters?: Parameters<Paths.GetThreadSummary.QueryParameters & Paths.GetThreadSummary.PathParameters> | null,
4710
+ data?: any,
4711
+ config?: AxiosRequestConfig
4712
+ ): OperationResponse<Paths.GetThreadSummary.Responses.$200 | Paths.GetThreadSummary.Responses.$202>
4713
+ }
4375
4714
  ['/v1/message/threads/{id}/trash']: {
4376
4715
  /**
4377
4716
  * trashThread - trashThread
@@ -4636,6 +4975,18 @@ interface PathsDictionary {
4636
4975
  config?: AxiosRequestConfig
4637
4976
  ): OperationResponse<Paths.AssignThread.Responses.$204>
4638
4977
  }
4978
+ ['/v1/message/threads/{id}/link-suggestions/dismiss']: {
4979
+ /**
4980
+ * dismissThreadLinkSuggestions - dismissThreadLinkSuggestions
4981
+ *
4982
+ * Dismiss pending candidates of entity-link suggestions on a thread. A suggestion is recorded on a message when an identifier in it matched entities of different customers, so nothing was linked automatically. Each candidate is resolved on its own: linking one (assignThread) leaves the others suggested until they are linked or dismissed. A suggestion whose candidates are all resolved is not suggested again for the thread.
4983
+ */
4984
+ 'post'(
4985
+ parameters?: Parameters<Paths.DismissThreadLinkSuggestions.PathParameters> | null,
4986
+ data?: Paths.DismissThreadLinkSuggestions.RequestBody,
4987
+ config?: AxiosRequestConfig
4988
+ ): OperationResponse<Paths.DismissThreadLinkSuggestions.Responses.$200>
4989
+ }
4639
4990
  ['/v1/message/threads/{id}/unassign']: {
4640
4991
  /**
4641
4992
  * unassignThread - unassignThread
@@ -4702,6 +5053,9 @@ interface PathsDictionary {
4702
5053
  * createDraft - createDraft
4703
5054
  *
4704
5055
  * Create a new draft
5056
+ *
5057
+ * Requires `entity:create` on `message`, checked with the caller's token before anything is created (403).
5058
+ *
4705
5059
  */
4706
5060
  'post'(
4707
5061
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -4713,7 +5067,11 @@ interface PathsDictionary {
4713
5067
  /**
4714
5068
  * sendDraft - sendDraft
4715
5069
  *
4716
- * Send the existing draft to the recipients
5070
+ * Send the existing draft to the recipients.
5071
+ *
5072
+ * Requires `message:send`, `entity:create` on `message` and `entity:edit` on the draft, checked with the
5073
+ * caller's token (403). The id must be a DRAFT of the given thread (409).
5074
+ *
4717
5075
  */
4718
5076
  'post'(
4719
5077
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -4759,8 +5117,12 @@ type BulkActionsPayloadWithScopes = Components.Schemas.BulkActionsPayloadWithSco
4759
5117
  type ErrorResponse = Components.Schemas.ErrorResponse;
4760
5118
  type FieldsParam = Components.Schemas.FieldsParam;
4761
5119
  type File = Components.Schemas.File;
5120
+ type LinkSuggestion = Components.Schemas.LinkSuggestion;
5121
+ type LinkSuggestionCandidate = Components.Schemas.LinkSuggestionCandidate;
4762
5122
  type Message = Components.Schemas.Message;
4763
5123
  type MessageAutoReplySentEvent = Components.Schemas.MessageAutoReplySentEvent;
5124
+ type MessageEntityLinkSuggestedEvent = Components.Schemas.MessageEntityLinkSuggestedEvent;
5125
+ type MessageEntityLinkSuggestionDismissedEvent = Components.Schemas.MessageEntityLinkSuggestionDismissedEvent;
4764
5126
  type MessageEntityLinkedEvent = Components.Schemas.MessageEntityLinkedEvent;
4765
5127
  type MessageEntityUnlinkedEvent = Components.Schemas.MessageEntityUnlinkedEvent;
4766
5128
  type MessageLabelAddedEvent = Components.Schemas.MessageLabelAddedEvent;
@@ -4770,14 +5132,24 @@ type MessageV2 = Components.Schemas.MessageV2;
4770
5132
  type MoveThreadPayload = Components.Schemas.MoveThreadPayload;
4771
5133
  type ReadMessagePayload = Components.Schemas.ReadMessagePayload;
4772
5134
  type ReadingScope = Components.Schemas.ReadingScope;
5135
+ type ReplyContextEntityRef = Components.Schemas.ReplyContextEntityRef;
5136
+ type ReplyContextMessage = Components.Schemas.ReplyContextMessage;
4773
5137
  type SearchIDParams = Components.Schemas.SearchIDParams;
4774
5138
  type SearchParams = Components.Schemas.SearchParams;
4775
5139
  type SearchParamsV2 = Components.Schemas.SearchParamsV2;
5140
+ type SimilarSentMessage = Components.Schemas.SimilarSentMessage;
5141
+ type SimilarSentMessagesRequest = Components.Schemas.SimilarSentMessagesRequest;
5142
+ type SimilarSentMessagesResponse = Components.Schemas.SimilarSentMessagesResponse;
4776
5143
  type Thread = Components.Schemas.Thread;
4777
5144
  type ThreadDoneEvent = Components.Schemas.ThreadDoneEvent;
4778
5145
  type ThreadMovedToInboxEvent = Components.Schemas.ThreadMovedToInboxEvent;
4779
5146
  type ThreadOpenEvent = Components.Schemas.ThreadOpenEvent;
5147
+ type ThreadReplyContext = Components.Schemas.ThreadReplyContext;
4780
5148
  type ThreadRestoredEvent = Components.Schemas.ThreadRestoredEvent;
5149
+ type ThreadSummary = Components.Schemas.ThreadSummary;
5150
+ type ThreadSummaryContext = Components.Schemas.ThreadSummaryContext;
5151
+ type ThreadSummaryEntityRef = Components.Schemas.ThreadSummaryEntityRef;
5152
+ type ThreadSummaryPayload = Components.Schemas.ThreadSummaryPayload;
4781
5153
  type ThreadTimeline = Components.Schemas.ThreadTimeline;
4782
5154
  type ThreadTrashedEvent = Components.Schemas.ThreadTrashedEvent;
4783
5155
  type ThreadUserAssignedEvent = Components.Schemas.ThreadUserAssignedEvent;
@@ -4785,6 +5157,7 @@ type ThreadView = Components.Schemas.ThreadView;
4785
5157
  type TimelineActor = Components.Schemas.TimelineActor;
4786
5158
  type TimelineEvent = Components.Schemas.TimelineEvent;
4787
5159
  type TimelineEventData = Components.Schemas.TimelineEventData;
5160
+ type TimelineLinkSuggestion = Components.Schemas.TimelineLinkSuggestion;
4788
5161
  type TimelineLinkedEntity = Components.Schemas.TimelineLinkedEntity;
4789
5162
  type UnreadCountBuckets = Components.Schemas.UnreadCountBuckets;
4790
5163
  type UnreadCountScope = Components.Schemas.UnreadCountScope;
@@ -4792,4 +5165,4 @@ type UnreadCountsPayload = Components.Schemas.UnreadCountsPayload;
4792
5165
  type UnreadCountsResult = Components.Schemas.UnreadCountsResult;
4793
5166
  type WorkflowStartedEvent = Components.Schemas.WorkflowStartedEvent;
4794
5167
 
4795
- export { type Address as A, type BaseEntity as B, type Client as C, type ThreadUserAssignedEvent as D, type ErrorResponse as E, type FieldsParam as F, type ThreadView as G, type TimelineActor as H, type TimelineEvent as I, type TimelineEventData as J, type TimelineLinkedEntity as K, type UnreadCountScope as L, type Message as M, type UnreadCountsPayload as N, type OperationMethods as O, Paths as P, type UnreadCountsResult as Q, type ReadMessagePayload as R, type SearchIDParams as S, type Thread as T, type UnreadCountBuckets as U, type WorkflowStartedEvent as W, Components as a, type PathsDictionary as b, type AssigneeWorkload as c, type AssigneeWorkloadParams as d, type AssigneeWorkloadResults as e, type AttachmentsRelation as f, type BulkActionsPayload as g, type BulkActionsPayloadWithScopes as h, type File as i, type MessageAutoReplySentEvent as j, type MessageEntityLinkedEvent as k, type MessageEntityUnlinkedEvent as l, type MessageLabelAddedEvent as m, type MessageLabelRemovedEvent as n, type MessageRequestParams as o, type MessageV2 as p, type MoveThreadPayload as q, type ReadingScope as r, type SearchParams as s, type SearchParamsV2 as t, type ThreadDoneEvent as u, type ThreadMovedToInboxEvent as v, type ThreadOpenEvent as w, type ThreadRestoredEvent as x, type ThreadTimeline as y, type ThreadTrashedEvent as z };
5168
+ export { type TimelineActor as $, type Address as A, type BaseEntity as B, type Client as C, type SimilarSentMessagesRequest as D, type ErrorResponse as E, type FieldsParam as F, type SimilarSentMessagesResponse as G, type ThreadDoneEvent as H, type ThreadMovedToInboxEvent as I, type ThreadOpenEvent as J, type ThreadReplyContext as K, type LinkSuggestion as L, type Message as M, type ThreadRestoredEvent as N, type OperationMethods as O, Paths as P, type ThreadSummary as Q, type ReadMessagePayload as R, type SearchIDParams as S, type Thread as T, type ThreadSummaryContext as U, type ThreadSummaryEntityRef as V, type ThreadSummaryPayload as W, type ThreadTimeline as X, type ThreadTrashedEvent as Y, type ThreadUserAssignedEvent as Z, type ThreadView as _, Components as a, type TimelineEvent as a0, type TimelineEventData as a1, type TimelineLinkSuggestion as a2, type TimelineLinkedEntity as a3, type UnreadCountBuckets as a4, type UnreadCountScope as a5, type UnreadCountsPayload as a6, type UnreadCountsResult as a7, type WorkflowStartedEvent as a8, type PathsDictionary as b, type AssigneeWorkload as c, type AssigneeWorkloadParams as d, type AssigneeWorkloadResults as e, type AttachmentsRelation as f, type BulkActionsPayload as g, type BulkActionsPayloadWithScopes as h, type File as i, type LinkSuggestionCandidate as j, type MessageAutoReplySentEvent as k, type MessageEntityLinkSuggestedEvent as l, type MessageEntityLinkSuggestionDismissedEvent as m, type MessageEntityLinkedEvent as n, type MessageEntityUnlinkedEvent as o, type MessageLabelAddedEvent as p, type MessageLabelRemovedEvent as q, type MessageRequestParams as r, type MessageV2 as s, type MoveThreadPayload as t, type ReadingScope as u, type ReplyContextEntityRef as v, type ReplyContextMessage as w, type SearchParams as x, type SearchParamsV2 as y, type SimilarSentMessage as z };