@epilot/sdk 2.18.15 → 2.18.16

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 (145) hide show
  1. package/definitions/integration-toolkit-runtime.json +1 -1
  2. package/definitions/integration-toolkit.json +379 -1
  3. package/definitions/message-runtime.json +1 -1
  4. package/definitions/message.json +481 -1
  5. package/dist/apis/access-token.cjs +6 -6
  6. package/dist/apis/access-token.js +1 -1
  7. package/dist/apis/address-suggestions.cjs +6 -6
  8. package/dist/apis/address-suggestions.js +1 -1
  9. package/dist/apis/address.cjs +6 -6
  10. package/dist/apis/address.js +1 -1
  11. package/dist/apis/ai-agents.cjs +6 -6
  12. package/dist/apis/ai-agents.js +1 -1
  13. package/dist/apis/app.cjs +6 -6
  14. package/dist/apis/app.js +1 -1
  15. package/dist/apis/audit-logs.cjs +6 -6
  16. package/dist/apis/audit-logs.js +1 -1
  17. package/dist/apis/automation.cjs +6 -6
  18. package/dist/apis/automation.js +1 -1
  19. package/dist/apis/billing.cjs +6 -6
  20. package/dist/apis/billing.js +1 -1
  21. package/dist/apis/blueprint-manifest.cjs +6 -6
  22. package/dist/apis/blueprint-manifest.js +1 -1
  23. package/dist/apis/calendar.cjs +6 -6
  24. package/dist/apis/calendar.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/file.cjs +6 -6
  54. package/dist/apis/file.js +1 -1
  55. package/dist/apis/iban.cjs +6 -6
  56. package/dist/apis/iban.js +1 -1
  57. package/dist/apis/integration-toolkit.cjs +8 -8
  58. package/dist/apis/integration-toolkit.d.cts +2 -2
  59. package/dist/apis/integration-toolkit.d.ts +2 -2
  60. package/dist/apis/integration-toolkit.js +2 -2
  61. package/dist/apis/journey.cjs +6 -6
  62. package/dist/apis/journey.js +1 -1
  63. package/dist/apis/kanban.cjs +6 -6
  64. package/dist/apis/kanban.js +1 -1
  65. package/dist/apis/message.cjs +8 -8
  66. package/dist/apis/message.d.cts +2 -2
  67. package/dist/apis/message.d.ts +2 -2
  68. package/dist/apis/message.js +2 -2
  69. package/dist/apis/metering.cjs +6 -6
  70. package/dist/apis/metering.js +1 -1
  71. package/dist/apis/notes.cjs +6 -6
  72. package/dist/apis/notes.js +1 -1
  73. package/dist/apis/notification.cjs +6 -6
  74. package/dist/apis/notification.js +1 -1
  75. package/dist/apis/organization.cjs +6 -6
  76. package/dist/apis/organization.js +1 -1
  77. package/dist/apis/partner-directory.cjs +6 -6
  78. package/dist/apis/partner-directory.js +1 -1
  79. package/dist/apis/permissions.cjs +6 -6
  80. package/dist/apis/permissions.js +1 -1
  81. package/dist/apis/pricing-tier.cjs +6 -6
  82. package/dist/apis/pricing-tier.js +1 -1
  83. package/dist/apis/pricing.cjs +6 -6
  84. package/dist/apis/pricing.js +1 -1
  85. package/dist/apis/purpose.cjs +6 -6
  86. package/dist/apis/purpose.js +1 -1
  87. package/dist/apis/query.cjs +6 -6
  88. package/dist/apis/query.js +1 -1
  89. package/dist/apis/sandbox.cjs +6 -6
  90. package/dist/apis/sandbox.js +1 -1
  91. package/dist/apis/sharing.cjs +6 -6
  92. package/dist/apis/sharing.js +1 -1
  93. package/dist/apis/snapshot.cjs +6 -6
  94. package/dist/apis/snapshot.js +1 -1
  95. package/dist/apis/submission.cjs +6 -6
  96. package/dist/apis/submission.js +1 -1
  97. package/dist/apis/target.cjs +6 -6
  98. package/dist/apis/target.js +1 -1
  99. package/dist/apis/targeting.cjs +6 -6
  100. package/dist/apis/targeting.js +1 -1
  101. package/dist/apis/template-variables.cjs +6 -6
  102. package/dist/apis/template-variables.js +1 -1
  103. package/dist/apis/user.cjs +6 -6
  104. package/dist/apis/user.js +1 -1
  105. package/dist/apis/validation-rules.cjs +6 -6
  106. package/dist/apis/validation-rules.js +1 -1
  107. package/dist/apis/webhooks.cjs +6 -6
  108. package/dist/apis/webhooks.js +1 -1
  109. package/dist/apis/workflow-definition.cjs +6 -6
  110. package/dist/apis/workflow-definition.js +1 -1
  111. package/dist/apis/workflow.cjs +6 -6
  112. package/dist/apis/workflow.js +1 -1
  113. package/dist/chunk-EHLNSFCU.cjs +14 -0
  114. package/dist/chunk-ILRZHW2E.cjs +14 -0
  115. package/dist/chunk-OT6AETWN.js +14 -0
  116. package/dist/{chunk-GSQI3C2W.js → chunk-S7LXTIGZ.js} +4 -4
  117. package/dist/chunk-VA34RFFR.js +14 -0
  118. package/dist/{chunk-22LE7Q52.cjs → chunk-WCFT56OJ.cjs} +4 -4
  119. package/dist/index.cjs +12 -12
  120. package/dist/index.d.cts +2 -2
  121. package/dist/index.d.ts +2 -2
  122. package/dist/index.js +3 -3
  123. package/dist/integration-toolkit-GR4ZQAY5.cjs +7 -0
  124. package/dist/integration-toolkit-XGQNDLIZ.js +7 -0
  125. package/dist/{integration-toolkit-runtime-6J2KUTFL.js → integration-toolkit-runtime-3RZRSZCW.js} +1 -1
  126. package/dist/{integration-toolkit-runtime-REEOXZO6.cjs → integration-toolkit-runtime-ZWS4WRKI.cjs} +2 -2
  127. package/dist/{integration-toolkit.d-pP-3dBPT.d.cts → integration-toolkit.d-CoMi10QU.d.cts} +292 -1
  128. package/dist/{integration-toolkit.d-pP-3dBPT.d.ts → integration-toolkit.d-CoMi10QU.d.ts} +292 -1
  129. package/dist/message-BZN67NTB.js +7 -0
  130. package/dist/message-DBHA4PHI.cjs +7 -0
  131. package/dist/{message-runtime-5Z3POFZV.cjs → message-runtime-4JSNBEVL.cjs} +2 -2
  132. package/dist/{message-runtime-5AUGENW3.js → message-runtime-7UM7U4VL.js} +1 -1
  133. package/dist/{message.d-b-UwZUNb.d.cts → message.d-BHWCGH3q.d.cts} +330 -3
  134. package/dist/{message.d-b-UwZUNb.d.ts → message.d-BHWCGH3q.d.ts} +330 -3
  135. package/docs/integration-toolkit.md +224 -0
  136. package/docs/message.md +385 -1
  137. package/package.json +1 -1
  138. package/dist/chunk-2ESIGECW.js +0 -14
  139. package/dist/chunk-JM63KEFZ.cjs +0 -14
  140. package/dist/chunk-TIH5X7Q4.cjs +0 -14
  141. package/dist/chunk-YWZCVCG2.js +0 -14
  142. package/dist/integration-toolkit-RIBZBI2Y.js +0 -7
  143. package/dist/integration-toolkit-RPWD4MAN.cjs +0 -7
  144. package/dist/message-F4HJQBF5.cjs +0 -7
  145. package/dist/message-TLEET26B.js +0 -7
@@ -339,6 +339,49 @@ declare namespace Components {
339
339
  */
340
340
  template_id?: string;
341
341
  }
342
+ export interface MessageAutoReplySentEvent {
343
+ type: "MESSAGE_AUTO_REPLY_SENT";
344
+ /**
345
+ * ID of the message that was sent as the automatic reply
346
+ */
347
+ reply_message_id?: string;
348
+ /**
349
+ * ID of the message the automatic reply responded to
350
+ */
351
+ parent_message_id?: string;
352
+ }
353
+ export interface MessageEntityLinkedEvent {
354
+ type: "MESSAGE_ENTITY_LINKED";
355
+ entities?: TimelineLinkedEntity[];
356
+ link_kind?: "manual" | "auto";
357
+ }
358
+ export interface MessageEntityUnlinkedEvent {
359
+ type: "MESSAGE_ENTITY_UNLINKED";
360
+ entities?: TimelineLinkedEntity[];
361
+ link_kind?: "manual" | "auto";
362
+ }
363
+ export interface MessageLabelAddedEvent {
364
+ type: "MESSAGE_LABEL_ADDED";
365
+ /**
366
+ * The label that was added (raw tag slug, e.g. `sentiments:angry`)
367
+ */
368
+ label: string;
369
+ /**
370
+ * Resolved taxonomy classification display name (e.g. `Verärgert`), when the label is a classification. Absent for free-form tags.
371
+ */
372
+ label_name?: string;
373
+ }
374
+ export interface MessageLabelRemovedEvent {
375
+ type: "MESSAGE_LABEL_REMOVED";
376
+ /**
377
+ * The label that was removed (raw tag slug, e.g. `sentiments:angry`)
378
+ */
379
+ label: string;
380
+ /**
381
+ * Resolved taxonomy classification display name (e.g. `Verärgert`), when the label is a classification. Absent for free-form tags.
382
+ */
383
+ label_name?: string;
384
+ }
342
385
  export interface MessageRequestParams {
343
386
  [name: string]: any;
344
387
  /**
@@ -721,6 +764,17 @@ declare namespace Components {
721
764
  */
722
765
  organization_id: string;
723
766
  }
767
+ export interface ThreadMovedToInboxEvent {
768
+ type: "THREAD_MOVED_TO_INBOX";
769
+ /**
770
+ * ID of the shared inbox the thread was moved to
771
+ */
772
+ target_inbox_id?: string;
773
+ /**
774
+ * Name of the shared inbox the thread was moved to
775
+ */
776
+ target_inbox_name?: string;
777
+ }
724
778
  export interface ThreadOpenEvent {
725
779
  type: "THREAD_OPEN";
726
780
  /**
@@ -736,19 +790,206 @@ declare namespace Components {
736
790
  */
737
791
  organization_id: string;
738
792
  }
793
+ export interface ThreadRestoredEvent {
794
+ type: "THREAD_RESTORED";
795
+ }
739
796
  export interface ThreadTimeline {
740
797
  events: TimelineEvent[];
741
798
  }
799
+ export interface ThreadTrashedEvent {
800
+ type: "THREAD_TRASHED";
801
+ }
802
+ export interface ThreadUserAssignedEvent {
803
+ type: "THREAD_USER_ASSIGNED";
804
+ /**
805
+ * User IDs assigned to the thread
806
+ */
807
+ added?: string[];
808
+ /**
809
+ * User IDs unassigned from the thread
810
+ */
811
+ removed?: string[];
812
+ }
813
+ export interface TimelineActor {
814
+ user_id?: string;
815
+ email?: string;
816
+ }
742
817
  export interface TimelineEvent {
818
+ /**
819
+ * Activity id (ActivityItem._id), for deep-linking to the item in the activity feed
820
+ */
821
+ id?: string;
743
822
  data: TimelineEventData;
744
823
  /**
745
824
  * Timestamp of the event
746
825
  * example:
747
- * 2024-01-01T00:00:00.000Z
826
+ * 2024-01-01T00:00:00Z
748
827
  */
749
828
  timestamp: string;
829
+ /**
830
+ * For message-level events, the message the activity is anchored to
831
+ */
832
+ message_id?: string;
833
+ source?: "user" | "automation" | "system";
834
+ /**
835
+ * Whether the activity was performed automatically (automation/system)
836
+ */
837
+ automated?: boolean;
838
+ actor?: TimelineActor;
839
+ automation?: {
840
+ id?: string;
841
+ name?: string;
842
+ };
843
+ }
844
+ export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent | WorkflowStartedEvent | ThreadUserAssignedEvent | MessageLabelAddedEvent | MessageLabelRemovedEvent | MessageEntityLinkedEvent | MessageEntityUnlinkedEvent | MessageAutoReplySentEvent | ThreadMovedToInboxEvent | ThreadTrashedEvent | ThreadRestoredEvent;
845
+ export interface TimelineLinkedEntity {
846
+ entity_id: string;
847
+ /**
848
+ * Entity schema slug, e.g. "opportunity"
849
+ */
850
+ schema?: string;
851
+ }
852
+ export interface UnreadCountBuckets {
853
+ /**
854
+ * example:
855
+ * 14
856
+ */
857
+ unread: number;
858
+ /**
859
+ * Organization scope only.
860
+ * example:
861
+ * 12
862
+ */
863
+ drafts?: number;
864
+ /**
865
+ * Organization scope only.
866
+ * example:
867
+ * 1
868
+ */
869
+ unassigned?: number;
870
+ /**
871
+ * Organization scope only.
872
+ * example:
873
+ * 3
874
+ */
875
+ spam?: number;
876
+ }
877
+ export interface UnreadCountScope {
878
+ /**
879
+ * Caller-chosen key for this scope. Echoed back as the key in `counts`, so it is how the
880
+ * caller matches a number to the sidebar row it belongs to. Must be unique within the
881
+ * request; duplicates are refused rather than silently collapsed.
882
+ *
883
+ * example:
884
+ * inbox-support
885
+ */
886
+ name: string;
887
+ /**
888
+ * Decides which buckets come back, and whether `q` is required. `organization` returns all
889
+ * four buckets from the canonical central-inbox queries and takes no `q`. `shared_inbox`
890
+ * and `saved_view` return `unread` alone and require the `q` their list uses.
891
+ *
892
+ * A `shared_inbox` scope additionally requires `actor: organization` and is refused with a
893
+ * 400 otherwise. A shared inbox is an organization-level construct — selecting one always
894
+ * switches the mailbox to the organization — so it has no per-user read state and the
895
+ * combination would compute a number no surface renders. `saved_view` accepts either actor,
896
+ * because a view's own configuration names its mailbox.
897
+ *
898
+ */
899
+ type: "organization" | "shared_inbox" | "saved_view";
900
+ /**
901
+ * The scope's own list predicate, in Lucene syntax, exactly as the caller passes it to
902
+ * `threads:search`. Required for `shared_inbox` and `saved_view`, rejected for
903
+ * `organization`. The server ANDs the read-state condition onto it and nothing else, which
904
+ * is what makes the count and the list agree. Until the predicate definition moves
905
+ * server-side, this is the caller's authored copy.
906
+ *
907
+ * example:
908
+ * _tags.keyword:inbox AND !_tags.keyword:trash
909
+ */
910
+ q?: string;
911
+ /**
912
+ * Shared inbox ids, resolved to bucket ids the same way `threads:search` resolves them.
913
+ */
914
+ inbox_id?: /* Shared inbox ids, resolved to bucket ids the same way `threads:search` resolves them. */ string | string[];
915
+ }
916
+ export interface UnreadCountsPayload {
917
+ /**
918
+ * Which read state to count against — the org's or the calling user's. Same meaning as
919
+ * `getUnread`'s path parameter, and unrelated to a scope's `type`.
920
+ *
921
+ */
922
+ actor: "organization" | "user";
923
+ /**
924
+ * Restrict every scope to messages involving these addresses.
925
+ */
926
+ email_filter?: string[];
927
+ scopes: [
928
+ UnreadCountScope,
929
+ UnreadCountScope?,
930
+ UnreadCountScope?,
931
+ UnreadCountScope?,
932
+ UnreadCountScope?,
933
+ UnreadCountScope?,
934
+ UnreadCountScope?,
935
+ UnreadCountScope?,
936
+ UnreadCountScope?,
937
+ UnreadCountScope?,
938
+ UnreadCountScope?,
939
+ UnreadCountScope?,
940
+ UnreadCountScope?,
941
+ UnreadCountScope?,
942
+ UnreadCountScope?,
943
+ UnreadCountScope?,
944
+ UnreadCountScope?,
945
+ UnreadCountScope?,
946
+ UnreadCountScope?,
947
+ UnreadCountScope?,
948
+ UnreadCountScope?,
949
+ UnreadCountScope?,
950
+ UnreadCountScope?,
951
+ UnreadCountScope?,
952
+ UnreadCountScope?
953
+ ];
954
+ }
955
+ export interface UnreadCountsResult {
956
+ /**
957
+ * False when the `message-unread-counts` flag is off for the calling org, in which case
958
+ * `counts` is empty and no Elasticsearch work was done. Callers render no badges rather
959
+ * than rendering zeroes.
960
+ *
961
+ * example:
962
+ * true
963
+ */
964
+ enabled: boolean;
965
+ /**
966
+ * One entry per scope, keyed by the scope's `name`. A scope whose predicate could not be
967
+ * built is **absent** rather than zero, because a zero badge is a claim about the mailbox
968
+ * and an absent one is a claim about the request.
969
+ *
970
+ */
971
+ counts: {
972
+ [name: string]: UnreadCountBuckets;
973
+ };
974
+ /**
975
+ * Names of scopes that were accepted but could not be counted — today, a shared inbox whose
976
+ * ids matched no bucket in this org. Listed explicitly so a caller can tell an omission apart
977
+ * from a mis-spelled scope name, both of which are otherwise just a missing key in `counts`.
978
+ *
979
+ */
980
+ omitted?: string[];
981
+ }
982
+ export interface WorkflowStartedEvent {
983
+ type: "WORKFLOW_STARTED";
984
+ /**
985
+ * ID of the workflow/flow execution that was started
986
+ */
987
+ workflow_id?: string;
988
+ /**
989
+ * Name of the workflow that was started
990
+ */
991
+ workflow_name?: string;
750
992
  }
751
- export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent;
752
993
  }
753
994
  }
754
995
  declare namespace Paths {
@@ -1469,6 +1710,16 @@ declare namespace Paths {
1469
1710
  }
1470
1711
  }
1471
1712
  }
1713
+ namespace GetUnreadCounts {
1714
+ export type RequestBody = Components.Schemas.UnreadCountsPayload;
1715
+ namespace Responses {
1716
+ export type $200 = Components.Schemas.UnreadCountsResult;
1717
+ export interface $400 {
1718
+ }
1719
+ export interface $403 {
1720
+ }
1721
+ }
1722
+ }
1472
1723
  namespace MarkReadMessage {
1473
1724
  namespace Parameters {
1474
1725
  export type Id = string;
@@ -2973,6 +3224,35 @@ interface OperationMethods {
2973
3224
  data?: any,
2974
3225
  config?: AxiosRequestConfig
2975
3226
  ): OperationResponse<Paths.GetUnread.Responses.$200>
3227
+ /**
3228
+ * getUnreadCounts - getUnreadCounts
3229
+ *
3230
+ * Unread counts for several named scopes in one request.
3231
+ *
3232
+ * A scope is a name plus the same parameters the thread list already takes (`q`, `inbox_id`),
3233
+ * so a scope's count and the list beneath it are the same predicate and agree by construction.
3234
+ * The server adds only the read-state condition; it does not re-author the caller's view.
3235
+ *
3236
+ * The `organization` scope is the exception and takes no `q`: it reuses the four canonical
3237
+ * central-inbox queries, so its numbers match `getUnread` exactly.
3238
+ *
3239
+ * Buckets are not symmetric, across scope types or across actors. Every scope other than
3240
+ * `organization` returns `unread` alone. The `organization` scope returns all four
3241
+ * (`unread`, `drafts`, `unassigned`, `spam`) for `actor: organization`, and only `unread` and
3242
+ * `drafts` for `actor: user` — the agent sidebar has no Spam or Unlinked folder, so those two
3243
+ * numbers have nowhere to render and each one costs a cardinality aggregation. This is a
3244
+ * deliberate divergence from `getUnread`, which computes all four for both actors.
3245
+ *
3246
+ * Gated on the `message-unread-counts` flag, evaluated once per request against the calling
3247
+ * org. With the flag off the response is `{ "enabled": false, "counts": {} }` and no
3248
+ * Elasticsearch query is issued.
3249
+ *
3250
+ */
3251
+ 'getUnreadCounts'(
3252
+ parameters?: Parameters<UnknownParamsObject> | null,
3253
+ data?: Paths.GetUnreadCounts.RequestBody,
3254
+ config?: AxiosRequestConfig
3255
+ ): OperationResponse<Paths.GetUnreadCounts.Responses.$200>
2976
3256
  /**
2977
3257
  * markUnreadMessageV2 - markUnreadMessageV2
2978
3258
  *
@@ -3565,6 +3845,37 @@ interface PathsDictionary {
3565
3845
  config?: AxiosRequestConfig
3566
3846
  ): OperationResponse<Paths.GetUnread.Responses.$200>
3567
3847
  }
3848
+ ['/v1/message/unread:counts']: {
3849
+ /**
3850
+ * getUnreadCounts - getUnreadCounts
3851
+ *
3852
+ * Unread counts for several named scopes in one request.
3853
+ *
3854
+ * A scope is a name plus the same parameters the thread list already takes (`q`, `inbox_id`),
3855
+ * so a scope's count and the list beneath it are the same predicate and agree by construction.
3856
+ * The server adds only the read-state condition; it does not re-author the caller's view.
3857
+ *
3858
+ * The `organization` scope is the exception and takes no `q`: it reuses the four canonical
3859
+ * central-inbox queries, so its numbers match `getUnread` exactly.
3860
+ *
3861
+ * Buckets are not symmetric, across scope types or across actors. Every scope other than
3862
+ * `organization` returns `unread` alone. The `organization` scope returns all four
3863
+ * (`unread`, `drafts`, `unassigned`, `spam`) for `actor: organization`, and only `unread` and
3864
+ * `drafts` for `actor: user` — the agent sidebar has no Spam or Unlinked folder, so those two
3865
+ * numbers have nowhere to render and each one costs a cardinality aggregation. This is a
3866
+ * deliberate divergence from `getUnread`, which computes all four for both actors.
3867
+ *
3868
+ * Gated on the `message-unread-counts` flag, evaluated once per request against the calling
3869
+ * org. With the flag off the response is `{ "enabled": false, "counts": {} }` and no
3870
+ * Elasticsearch query is issued.
3871
+ *
3872
+ */
3873
+ 'post'(
3874
+ parameters?: Parameters<UnknownParamsObject> | null,
3875
+ data?: Paths.GetUnreadCounts.RequestBody,
3876
+ config?: AxiosRequestConfig
3877
+ ): OperationResponse<Paths.GetUnreadCounts.Responses.$200>
3878
+ }
3568
3879
  ['/v2/message/messages/{id}/unread']: {
3569
3880
  /**
3570
3881
  * markUnreadMessageV2 - markUnreadMessageV2
@@ -4109,6 +4420,11 @@ type ErrorResponse = Components.Schemas.ErrorResponse;
4109
4420
  type FieldsParam = Components.Schemas.FieldsParam;
4110
4421
  type File = Components.Schemas.File;
4111
4422
  type Message = Components.Schemas.Message;
4423
+ type MessageAutoReplySentEvent = Components.Schemas.MessageAutoReplySentEvent;
4424
+ type MessageEntityLinkedEvent = Components.Schemas.MessageEntityLinkedEvent;
4425
+ type MessageEntityUnlinkedEvent = Components.Schemas.MessageEntityUnlinkedEvent;
4426
+ type MessageLabelAddedEvent = Components.Schemas.MessageLabelAddedEvent;
4427
+ type MessageLabelRemovedEvent = Components.Schemas.MessageLabelRemovedEvent;
4112
4428
  type MessageRequestParams = Components.Schemas.MessageRequestParams;
4113
4429
  type MessageV2 = Components.Schemas.MessageV2;
4114
4430
  type MoveThreadPayload = Components.Schemas.MoveThreadPayload;
@@ -4119,9 +4435,20 @@ type SearchParams = Components.Schemas.SearchParams;
4119
4435
  type SearchParamsV2 = Components.Schemas.SearchParamsV2;
4120
4436
  type Thread = Components.Schemas.Thread;
4121
4437
  type ThreadDoneEvent = Components.Schemas.ThreadDoneEvent;
4438
+ type ThreadMovedToInboxEvent = Components.Schemas.ThreadMovedToInboxEvent;
4122
4439
  type ThreadOpenEvent = Components.Schemas.ThreadOpenEvent;
4440
+ type ThreadRestoredEvent = Components.Schemas.ThreadRestoredEvent;
4123
4441
  type ThreadTimeline = Components.Schemas.ThreadTimeline;
4442
+ type ThreadTrashedEvent = Components.Schemas.ThreadTrashedEvent;
4443
+ type ThreadUserAssignedEvent = Components.Schemas.ThreadUserAssignedEvent;
4444
+ type TimelineActor = Components.Schemas.TimelineActor;
4124
4445
  type TimelineEvent = Components.Schemas.TimelineEvent;
4125
4446
  type TimelineEventData = Components.Schemas.TimelineEventData;
4447
+ type TimelineLinkedEntity = Components.Schemas.TimelineLinkedEntity;
4448
+ type UnreadCountBuckets = Components.Schemas.UnreadCountBuckets;
4449
+ type UnreadCountScope = Components.Schemas.UnreadCountScope;
4450
+ type UnreadCountsPayload = Components.Schemas.UnreadCountsPayload;
4451
+ type UnreadCountsResult = Components.Schemas.UnreadCountsResult;
4452
+ type WorkflowStartedEvent = Components.Schemas.WorkflowStartedEvent;
4126
4453
 
4127
- export { type Address as A, type BaseEntity as B, type Client as C, type ErrorResponse as E, type FieldsParam as F, type Message as M, type OperationMethods as O, Paths as P, type ReadMessagePayload as R, type SearchIDParams as S, type Thread as T, 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 MessageRequestParams as j, type MessageV2 as k, type MoveThreadPayload as l, type ReadingScope as m, type SearchParams as n, type SearchParamsV2 as o, type ThreadDoneEvent as p, type ThreadOpenEvent as q, type ThreadTimeline as r, type TimelineEvent as s, type TimelineEventData as t };
4454
+ 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 TimelineActor as G, type TimelineEvent as H, type TimelineEventData as I, type TimelineLinkedEntity as J, type UnreadCountScope as K, type UnreadCountsPayload as L, type Message as M, type UnreadCountsResult as N, type OperationMethods as O, Paths as P, 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 };
@@ -45,6 +45,10 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
45
45
  - [`updateUseCase`](#updateusecase)
46
46
  - [`deleteUseCase`](#deleteusecase)
47
47
  - [`listUseCaseHistory`](#listusecasehistory)
48
+ - [`listDocumentationPages`](#listdocumentationpages)
49
+ - [`getDocumentationPage`](#getdocumentationpage)
50
+ - [`upsertDocumentationPage`](#upsertdocumentationpage)
51
+ - [`deleteDocumentationPage`](#deletedocumentationpage)
48
52
  - [`listIntegrationsV2`](#listintegrationsv2)
49
53
  - [`createIntegrationV2`](#createintegrationv2)
50
54
  - [`getIntegrationV2`](#getintegrationv2)
@@ -92,6 +96,7 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
92
96
  - [`createErpImport`](#createerpimport)
93
97
  - [`listErpImports`](#listerpimports)
94
98
  - [`getErpImport`](#geterpimport)
99
+ - [`deleteErpImport`](#deleteerpimport)
95
100
  - [`validateErpImport`](#validateerpimport)
96
101
  - [`suggestErpImportUseCases`](#suggesterpimportusecases)
97
102
  - [`executeErpImport`](#executeerpimport)
@@ -291,6 +296,9 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
291
296
  - [`GetMonitoringTimeSeriesV2Request`](#getmonitoringtimeseriesv2request)
292
297
  - [`TimeSeriesBreakdownItemV2`](#timeseriesbreakdownitemv2)
293
298
  - [`TimeSeriesBucketV2`](#timeseriesbucketv2)
299
+ - [`DocumentationPageSummary`](#documentationpagesummary)
300
+ - [`DocumentationPage`](#documentationpage)
301
+ - [`UpsertDocumentationPageRequest`](#upsertdocumentationpagerequest)
294
302
 
295
303
  ### `acknowledgeTracking`
296
304
 
@@ -1342,6 +1350,150 @@ const { data } = await client.listUseCaseHistory({
1342
1350
 
1343
1351
  ---
1344
1352
 
1353
+ ### `listDocumentationPages`
1354
+
1355
+ Retrieve all documentation pages of an integration, without their markdown content.
1356
+ An integration has at most one general page plus at most one page per use case.
1357
+ The page id is 'general' for the int
1358
+
1359
+ `GET /v1/integrations/{integrationId}/documentation`
1360
+
1361
+ ```ts
1362
+ const { data } = await client.listDocumentationPages({
1363
+ integrationId: 'example',
1364
+ })
1365
+ ```
1366
+
1367
+ <details>
1368
+ <summary>Response</summary>
1369
+
1370
+ ```json
1371
+ {
1372
+ "pages": [
1373
+ {
1374
+ "id": "general",
1375
+ "integration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1376
+ "scope": "integration",
1377
+ "use_case_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1378
+ "title": "string",
1379
+ "created_at": "1970-01-01T00:00:00.000Z",
1380
+ "created_by": "string",
1381
+ "updated_at": "1970-01-01T00:00:00.000Z",
1382
+ "updated_by": "string"
1383
+ }
1384
+ ]
1385
+ }
1386
+ ```
1387
+
1388
+ </details>
1389
+
1390
+ ---
1391
+
1392
+ ### `getDocumentationPage`
1393
+
1394
+ Retrieve a single documentation page including its markdown content
1395
+
1396
+ `GET /v1/integrations/{integrationId}/documentation/{docId}`
1397
+
1398
+ ```ts
1399
+ const { data } = await client.getDocumentationPage({
1400
+ integrationId: 'example',
1401
+ docId: 'example',
1402
+ })
1403
+ ```
1404
+
1405
+ <details>
1406
+ <summary>Response</summary>
1407
+
1408
+ ```json
1409
+ {
1410
+ "id": "general",
1411
+ "integration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1412
+ "scope": "integration",
1413
+ "use_case_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1414
+ "title": "string",
1415
+ "created_at": "1970-01-01T00:00:00.000Z",
1416
+ "created_by": "string",
1417
+ "updated_at": "1970-01-01T00:00:00.000Z",
1418
+ "updated_by": "string",
1419
+ "content": "string"
1420
+ }
1421
+ ```
1422
+
1423
+ </details>
1424
+
1425
+ ---
1426
+
1427
+ ### `upsertDocumentationPage`
1428
+
1429
+ Create or update the documentation page identified by docId.
1430
+ Upsert semantics enforce the invariant of one general page per
1431
+ integration and one page per use case. For use case pages the
1432
+ use case must
1433
+
1434
+ `PUT /v1/integrations/{integrationId}/documentation/{docId}`
1435
+
1436
+ ```ts
1437
+ const { data } = await client.upsertDocumentationPage(
1438
+ {
1439
+ integrationId: 'example',
1440
+ docId: 'example',
1441
+ },
1442
+ {
1443
+ title: 'string',
1444
+ content: 'string'
1445
+ },
1446
+ )
1447
+ ```
1448
+
1449
+ <details>
1450
+ <summary>Response</summary>
1451
+
1452
+ ```json
1453
+ {
1454
+ "id": "general",
1455
+ "integration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1456
+ "scope": "integration",
1457
+ "use_case_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1458
+ "title": "string",
1459
+ "created_at": "1970-01-01T00:00:00.000Z",
1460
+ "created_by": "string",
1461
+ "updated_at": "1970-01-01T00:00:00.000Z",
1462
+ "updated_by": "string",
1463
+ "content": "string"
1464
+ }
1465
+ ```
1466
+
1467
+ </details>
1468
+
1469
+ ---
1470
+
1471
+ ### `deleteDocumentationPage`
1472
+
1473
+ Delete a documentation page
1474
+
1475
+ `DELETE /v1/integrations/{integrationId}/documentation/{docId}`
1476
+
1477
+ ```ts
1478
+ const { data } = await client.deleteDocumentationPage({
1479
+ integrationId: 'example',
1480
+ docId: 'example',
1481
+ })
1482
+ ```
1483
+
1484
+ <details>
1485
+ <summary>Response</summary>
1486
+
1487
+ ```json
1488
+ {
1489
+ "message": "string"
1490
+ }
1491
+ ```
1492
+
1493
+ </details>
1494
+
1495
+ ---
1496
+
1345
1497
  ### `listIntegrationsV2`
1346
1498
 
1347
1499
  Retrieve all integrations with embedded use cases for the authenticated organization
@@ -3248,6 +3400,8 @@ const { data } = await client.createErpImport(
3248
3400
  "bucket": "string",
3249
3401
  "key": "string"
3250
3402
  },
3403
+ "size_bytes": 0,
3404
+ "column_count": 0,
3251
3405
  "validation": {
3252
3406
  "total_rows": 0,
3253
3407
  "blocking": 0,
@@ -3324,6 +3478,8 @@ const { data } = await client.listErpImports({
3324
3478
  "bucket": "string",
3325
3479
  "key": "string"
3326
3480
  },
3481
+ "size_bytes": 0,
3482
+ "column_count": 0,
3327
3483
  "validation": {
3328
3484
  "total_rows": 0,
3329
3485
  "blocking": 0,
@@ -3393,6 +3549,8 @@ const { data } = await client.getErpImport({
3393
3549
  "bucket": "string",
3394
3550
  "key": "string"
3395
3551
  },
3552
+ "size_bytes": 0,
3553
+ "column_count": 0,
3396
3554
  "validation": {
3397
3555
  "total_rows": 0,
3398
3556
  "blocking": 0,
@@ -3431,6 +3589,20 @@ const { data } = await client.getErpImport({
3431
3589
 
3432
3590
  ---
3433
3591
 
3592
+ ### `deleteErpImport`
3593
+
3594
+ Remove an import and the file it owns. Allowed from any status: an import whose run is still in flight is stopped by the deletion, and rows it already wrote stay written.
3595
+
3596
+ `DELETE /v2/erp/imports/{importId}`
3597
+
3598
+ ```ts
3599
+ const { data } = await client.deleteErpImport({
3600
+ importId: 'example',
3601
+ })
3602
+ ```
3603
+
3604
+ ---
3605
+
3434
3606
  ### `validateErpImport`
3435
3607
 
3436
3608
  Choose the use case to read this file with, and start the validate phase.
@@ -3683,6 +3855,8 @@ type CreateErpImportResponse = {
3683
3855
  bucket: { ... }
3684
3856
  key: { ... }
3685
3857
  }
3858
+ size_bytes?: number
3859
+ column_count?: number
3686
3860
  validation?: {
3687
3861
  total_rows: { ... }
3688
3862
  blocking: { ... }
@@ -3725,6 +3899,8 @@ type ErpImportJob = {
3725
3899
  bucket: string
3726
3900
  key: string
3727
3901
  }
3902
+ size_bytes?: number
3903
+ column_count?: number
3728
3904
  validation?: {
3729
3905
  total_rows: number
3730
3906
  blocking: number
@@ -3768,6 +3944,8 @@ type ErpImportList = {
3768
3944
  bucket: { ... }
3769
3945
  key: { ... }
3770
3946
  }
3947
+ size_bytes?: number
3948
+ column_count?: number
3771
3949
  validation?: {
3772
3950
  total_rows: { ... }
3773
3951
  blocking: { ... }
@@ -8559,3 +8737,49 @@ type TimeSeriesBucketV2 = {
8559
8737
  }>
8560
8738
  }
8561
8739
  ```
8740
+
8741
+ ### `DocumentationPageSummary`
8742
+
8743
+ Documentation page metadata without the markdown content
8744
+
8745
+ ```ts
8746
+ type DocumentationPageSummary = {
8747
+ id: string
8748
+ integration_id: string // uuid
8749
+ scope: "integration" | "use_case"
8750
+ use_case_id?: string // uuid
8751
+ title: string
8752
+ created_at: string // date-time
8753
+ created_by?: string
8754
+ updated_at: string // date-time
8755
+ updated_by?: string
8756
+ }
8757
+ ```
8758
+
8759
+ ### `DocumentationPage`
8760
+
8761
+ A markdown documentation page of an integration
8762
+
8763
+ ```ts
8764
+ type DocumentationPage = {
8765
+ id: string
8766
+ integration_id: string // uuid
8767
+ scope: "integration" | "use_case"
8768
+ use_case_id?: string // uuid
8769
+ title: string
8770
+ created_at: string // date-time
8771
+ created_by?: string
8772
+ updated_at: string // date-time
8773
+ updated_by?: string
8774
+ content: string
8775
+ }
8776
+ ```
8777
+
8778
+ ### `UpsertDocumentationPageRequest`
8779
+
8780
+ ```ts
8781
+ type UpsertDocumentationPageRequest = {
8782
+ title: string
8783
+ content: string
8784
+ }
8785
+ ```