@macro-inc/sdk 0.0.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +628 -21
- package/dist/{chunk-5HAKQN23.js → chunk-7LVVPVNT.js} +70 -57
- package/dist/{chunk-JXIQT5TH.js → chunk-7YJ6Y7HJ.js} +234 -16
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/{chunk-SGAHIERJ.js → chunk-OGE7WXJE.js} +16 -0
- package/dist/chunk-PRUFPW3B.js +943 -0
- package/dist/{chunk-CTKR64MY.js → chunk-QVBNNMQS.js} +242 -367
- package/dist/{chunk-QNUS5BC5.js → chunk-SUINKDXF.js} +30 -84
- package/dist/{chunk-77EI4LSQ.js → chunk-ZQXOHNDB.js} +1518 -386
- package/dist/generated/agent-harness/index.d.ts +1 -1
- package/dist/generated/agent-harness/index.js +1 -1
- package/dist/generated/agent-harness/sdk.gen.d.ts +174 -4
- package/dist/generated/agent-harness/types.gen.d.ts +2511 -189
- package/dist/generated/auth/index.d.ts +1 -1
- package/dist/generated/auth/index.js +1 -1
- package/dist/generated/auth/sdk.gen.d.ts +106 -8
- package/dist/generated/auth/types.gen.d.ts +1473 -116
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +95 -0
- package/dist/generated/calendar/types.gen.d.ts +1091 -0
- package/dist/generated/cognition/index.d.ts +1 -1
- package/dist/generated/cognition/index.js +1 -1
- package/dist/generated/cognition/sdk.gen.d.ts +6 -1
- package/dist/generated/cognition/types.gen.d.ts +304 -36
- package/dist/generated/connection/types.gen.d.ts +1 -1
- package/dist/generated/email/index.d.ts +1 -1
- package/dist/generated/email/index.js +1 -1
- package/dist/generated/email/sdk.gen.d.ts +32 -27
- package/dist/generated/email/types.gen.d.ts +586 -409
- package/dist/generated/notification/index.d.ts +1 -1
- package/dist/generated/notification/types.gen.d.ts +384 -19
- package/dist/generated/properties/types.gen.d.ts +8 -5
- package/dist/generated/scheduled-action/index.d.ts +1 -1
- package/dist/generated/scheduled-action/index.js +3 -842
- package/dist/generated/scheduled-action/sdk.gen.d.ts +3 -1
- package/dist/generated/scheduled-action/types.gen.d.ts +277 -41
- package/dist/generated/search/index.d.ts +1 -1
- package/dist/generated/search/types.gen.d.ts +262 -43
- package/dist/generated/storage/index.d.ts +1 -1
- package/dist/generated/storage/index.js +1 -1
- package/dist/generated/storage/sdk.gen.d.ts +678 -107
- package/dist/generated/storage/types.gen.d.ts +14827 -5995
- package/dist/generated/unfurl/index.d.ts +1 -1
- package/dist/generated/unfurl/index.js +3 -832
- package/dist/generated/unfurl/types.gen.d.ts +20 -0
- package/dist/src/config.d.ts +33 -13
- package/dist/src/entities/agent-sessions/agent-session.d.ts +150 -6
- package/dist/src/entities/agent-sessions/code-execution.d.ts +43 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +54 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +23 -5
- package/dist/src/entities/agent-sessions/queued-action.d.ts +46 -0
- package/dist/src/entities/agent-sessions/review.d.ts +107 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +21 -0
- package/dist/src/entities/agents/agent.d.ts +47 -0
- package/dist/src/entities/agents/namespace.d.ts +13 -0
- package/dist/src/entities/ai/namespace.d.ts +24 -0
- package/dist/src/entities/api-keys/api-key.d.ts +17 -0
- package/dist/src/entities/api-keys/namespace.d.ts +18 -0
- package/dist/src/entities/calendar/calendar.d.ts +35 -0
- package/dist/src/entities/calendar/event.d.ts +123 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +111 -0
- package/dist/src/entities/calendar/replacement.d.ts +15 -0
- package/dist/src/entities/calls/call-record.d.ts +62 -6
- package/dist/src/entities/calls/message.d.ts +33 -0
- package/dist/src/entities/channels/activity.d.ts +24 -0
- package/dist/src/entities/channels/channel.d.ts +44 -3
- package/dist/src/entities/channels/labels.d.ts +39 -0
- package/dist/src/entities/channels/message.d.ts +9 -17
- package/dist/src/entities/channels/namespace.d.ts +6 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +1 -1
- package/dist/src/entities/channels/thread.d.ts +5 -0
- package/dist/src/entities/chats/chat.d.ts +11 -1
- package/dist/src/entities/chats/generation.d.ts +46 -0
- package/dist/src/entities/crm/comment.d.ts +55 -34
- package/dist/src/entities/crm/company.d.ts +42 -10
- package/dist/src/entities/crm/contact.d.ts +42 -10
- package/dist/src/entities/crm/namespace.d.ts +18 -1
- package/dist/src/entities/crm/pipeline.d.ts +122 -0
- package/dist/src/entities/crm/pipelines.d.ts +14 -0
- package/dist/src/entities/databases/column.d.ts +75 -0
- package/dist/src/entities/databases/database.d.ts +272 -0
- package/dist/src/entities/databases/namespace.d.ts +21 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +27 -0
- package/dist/src/entities/databases/table.d.ts +61 -0
- package/dist/src/entities/databases/view.d.ts +40 -0
- package/dist/src/entities/databases/webhook.d.ts +32 -0
- package/dist/src/entities/documents/anchor.d.ts +29 -0
- package/dist/src/entities/documents/comment.d.ts +25 -22
- package/dist/src/entities/documents/document.d.ts +60 -12
- package/dist/src/entities/documents/namespace.d.ts +30 -0
- package/dist/src/entities/documents/version.d.ts +22 -0
- package/dist/src/entities/email/draft.d.ts +79 -0
- package/dist/src/entities/email/filter.d.ts +34 -0
- package/dist/src/entities/email/link.d.ts +6 -4
- package/dist/src/entities/email/message.d.ts +12 -1
- package/dist/src/entities/email/namespace.d.ts +34 -1
- package/dist/src/entities/email/thread.d.ts +23 -1
- package/dist/src/entities/entity-mentions/mention.d.ts +16 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +12 -0
- package/dist/src/entities/entity.d.ts +7 -0
- package/dist/src/entities/favorites/namespace.d.ts +14 -2
- package/dist/src/entities/foreign/foreign-entity.d.ts +2 -0
- package/dist/src/entities/foreign/namespace.d.ts +40 -0
- package/dist/src/entities/forms/form.d.ts +227 -0
- package/dist/src/entities/forms/namespace.d.ts +18 -0
- package/dist/src/entities/forms/question.d.ts +37 -0
- package/dist/src/entities/forms/response.d.ts +32 -0
- package/dist/src/entities/forms/section.d.ts +19 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +12 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +52 -0
- package/dist/src/entities/harnesses/harness.d.ts +19 -0
- package/dist/src/entities/harnesses/namespace.d.ts +33 -0
- package/dist/src/entities/harnesses/pairing.d.ts +39 -0
- package/dist/src/entities/initiatives/initiative.d.ts +50 -0
- package/dist/src/entities/initiatives/namespace.d.ts +13 -0
- package/dist/src/entities/meetings/meeting.d.ts +38 -0
- package/dist/src/entities/meetings/namespace.d.ts +18 -0
- package/dist/src/entities/messages/thread.d.ts +101 -0
- package/dist/src/entities/notifications/notification.d.ts +6 -3
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/projects/project.d.ts +7 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/routines/namespace.d.ts +15 -0
- package/dist/src/entities/routines/routine.d.ts +115 -0
- package/dist/src/entities/sharing/access.d.ts +65 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/tasks/namespace.d.ts +4 -0
- package/dist/src/entities/tasks/task.d.ts +6 -0
- package/dist/src/entities/unfurls/namespace.d.ts +10 -0
- package/dist/src/entities/webhooks/webhook.d.ts +3 -1
- package/dist/src/entities/workspace/items.d.ts +7 -0
- package/dist/src/entities/workspace/namespace.d.ts +83 -0
- package/dist/src/entities/workspace/query.d.ts +12 -0
- package/dist/src/entities/workspace/types.d.ts +96 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/channel.d.ts +2 -39
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/receiver.d.ts +57 -19
- package/dist/src/events/types.d.ts +3 -1
- package/dist/src/macro.d.ts +80 -3
- package/dist/src/macro.js +8832 -2784
- package/dist/src/utils/activity.d.ts +11 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +10 -1
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +1 -0
- package/dist/src/utils/pagination.d.ts +9 -4
- package/package.json +11 -3
|
@@ -805,25 +805,17 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
805
805
|
_Sdk.__registry.set(this, args?.key);
|
|
806
806
|
}
|
|
807
807
|
/**
|
|
808
|
-
*
|
|
809
|
-
* If you need to delete a threaded anchor, see the delete comment handler
|
|
808
|
+
* Handler for `GET /agents`.
|
|
810
809
|
*/
|
|
811
|
-
|
|
812
|
-
return (options
|
|
813
|
-
url: "/annotations/anchors",
|
|
814
|
-
...options,
|
|
815
|
-
headers: {
|
|
816
|
-
"Content-Type": "application/json",
|
|
817
|
-
...options.headers
|
|
818
|
-
}
|
|
819
|
-
});
|
|
810
|
+
listAgents(options) {
|
|
811
|
+
return (options?.client ?? this.client).get({ url: "/agents", ...options });
|
|
820
812
|
}
|
|
821
813
|
/**
|
|
822
|
-
*
|
|
814
|
+
* Handler for `POST /agents`.
|
|
823
815
|
*/
|
|
824
|
-
|
|
825
|
-
return (options.client ?? this.client).
|
|
826
|
-
url: "/
|
|
816
|
+
createAgent(options) {
|
|
817
|
+
return (options.client ?? this.client).post({
|
|
818
|
+
url: "/agents",
|
|
827
819
|
...options,
|
|
828
820
|
headers: {
|
|
829
821
|
"Content-Type": "application/json",
|
|
@@ -832,18 +824,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
832
824
|
});
|
|
833
825
|
}
|
|
834
826
|
/**
|
|
835
|
-
*
|
|
836
|
-
*/
|
|
837
|
-
getDocumentAnchors(options) {
|
|
838
|
-
return (options.client ?? this.client).get({ url: "/annotations/anchors/document/{document_id}", ...options });
|
|
839
|
-
}
|
|
840
|
-
/**
|
|
841
|
-
* Creates an unthreaded anchor for a document
|
|
842
|
-
* If you need to create a threaded anchor, see the create comment handler
|
|
827
|
+
* Handler for `PUT /agents/{agent_id}`.
|
|
843
828
|
*/
|
|
844
|
-
|
|
845
|
-
return (options.client ?? this.client).
|
|
846
|
-
url: "/
|
|
829
|
+
updateAgent(options) {
|
|
830
|
+
return (options.client ?? this.client).put({
|
|
831
|
+
url: "/agents/{agent_id}",
|
|
847
832
|
...options,
|
|
848
833
|
headers: {
|
|
849
834
|
"Content-Type": "application/json",
|
|
@@ -852,11 +837,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
852
837
|
});
|
|
853
838
|
}
|
|
854
839
|
/**
|
|
855
|
-
* Deletes a
|
|
840
|
+
* Deletes a highlight and any attached discussion under the annotation policy.
|
|
856
841
|
*/
|
|
857
|
-
|
|
842
|
+
deleteAnchor(options) {
|
|
858
843
|
return (options.client ?? this.client).delete({
|
|
859
|
-
url: "/annotations/
|
|
844
|
+
url: "/annotations/anchors",
|
|
860
845
|
...options,
|
|
861
846
|
headers: {
|
|
862
847
|
"Content-Type": "application/json",
|
|
@@ -865,11 +850,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
865
850
|
});
|
|
866
851
|
}
|
|
867
852
|
/**
|
|
868
|
-
* Edits a single
|
|
853
|
+
* Edits a single anchor for a document
|
|
869
854
|
*/
|
|
870
|
-
|
|
855
|
+
editAnchor(options) {
|
|
871
856
|
return (options.client ?? this.client).patch({
|
|
872
|
-
url: "/annotations/
|
|
857
|
+
url: "/annotations/anchors",
|
|
873
858
|
...options,
|
|
874
859
|
headers: {
|
|
875
860
|
"Content-Type": "application/json",
|
|
@@ -878,18 +863,18 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
878
863
|
});
|
|
879
864
|
}
|
|
880
865
|
/**
|
|
881
|
-
* Gets a set of comment
|
|
866
|
+
* Gets a set of comment anchors for a document
|
|
882
867
|
*/
|
|
883
|
-
|
|
884
|
-
return (options.client ?? this.client).get({ url: "/annotations/
|
|
868
|
+
getDocumentAnchors(options) {
|
|
869
|
+
return (options.client ?? this.client).get({ url: "/annotations/anchors/document/{document_id}", ...options });
|
|
885
870
|
}
|
|
886
871
|
/**
|
|
887
|
-
* Creates
|
|
888
|
-
*
|
|
872
|
+
* Creates an unthreaded anchor for a document
|
|
873
|
+
* Attach a discussion through the shared message API.
|
|
889
874
|
*/
|
|
890
|
-
|
|
875
|
+
createAnchor(options) {
|
|
891
876
|
return (options.client ?? this.client).post({
|
|
892
|
-
url: "/annotations/
|
|
877
|
+
url: "/annotations/anchors/document/{document_id}",
|
|
893
878
|
...options,
|
|
894
879
|
headers: {
|
|
895
880
|
"Content-Type": "application/json",
|
|
@@ -903,6 +888,16 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
903
888
|
getSelfBot(options) {
|
|
904
889
|
return (options?.client ?? this.client).get({ url: "/bots/me", ...options });
|
|
905
890
|
}
|
|
891
|
+
/**
|
|
892
|
+
* Handler for `GET /bots/profiles`.
|
|
893
|
+
*
|
|
894
|
+
* Returns display fields and the sponsor for each requested bot. Not a
|
|
895
|
+
* manageability check: any authenticated user or internal caller may look up
|
|
896
|
+
* ids they already have.
|
|
897
|
+
*/
|
|
898
|
+
getBotOwnerProfiles(options) {
|
|
899
|
+
return (options?.client ?? this.client).get({ url: "/bots/profiles", ...options });
|
|
900
|
+
}
|
|
906
901
|
/**
|
|
907
902
|
* Handler for `GET /bots/{bot_id}/channels`.
|
|
908
903
|
*/
|
|
@@ -934,6 +929,18 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
934
929
|
}
|
|
935
930
|
});
|
|
936
931
|
}
|
|
932
|
+
/**
|
|
933
|
+
* Query authorized projections in a bounded viewport.
|
|
934
|
+
*/
|
|
935
|
+
listTeamCalendar(options) {
|
|
936
|
+
return (options.client ?? this.client).get({ url: "/calendar-events/team", ...options });
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* Return teammates' out-of-office occurrences in the requested viewport.
|
|
940
|
+
*/
|
|
941
|
+
listTeamOutOfOffice(options) {
|
|
942
|
+
return (options.client ?? this.client).get({ url: "/calendar-events/team-out-of-office", ...options });
|
|
943
|
+
}
|
|
937
944
|
/**
|
|
938
945
|
* Handler for `GET /call/active`.
|
|
939
946
|
*
|
|
@@ -944,6 +951,156 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
944
951
|
getActiveCalls(options) {
|
|
945
952
|
return (options?.client ?? this.client).get({ url: "/call/active", ...options });
|
|
946
953
|
}
|
|
954
|
+
/**
|
|
955
|
+
* Read the live call discussion as a verified guest.
|
|
956
|
+
*/
|
|
957
|
+
guestCallChatRead(options) {
|
|
958
|
+
return (options.client ?? this.client).get({ url: "/call/guest-chat/{call_id}", ...options });
|
|
959
|
+
}
|
|
960
|
+
/**
|
|
961
|
+
* Append text to the same saved discussion used by account participants.
|
|
962
|
+
*/
|
|
963
|
+
guestCallChatPost(options) {
|
|
964
|
+
return (options.client ?? this.client).post({
|
|
965
|
+
url: "/call/guest-chat/{call_id}",
|
|
966
|
+
...options,
|
|
967
|
+
headers: {
|
|
968
|
+
"Content-Type": "application/json",
|
|
969
|
+
...options.headers
|
|
970
|
+
}
|
|
971
|
+
});
|
|
972
|
+
}
|
|
973
|
+
/**
|
|
974
|
+
* Handle `GET /call/join/{token}` through the call domain service.
|
|
975
|
+
*/
|
|
976
|
+
meetingLookup(options) {
|
|
977
|
+
return (options.client ?? this.client).get({ url: "/call/join/{token}", ...options });
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* Handle `POST /call/join/{token}` through the call domain service.
|
|
981
|
+
*/
|
|
982
|
+
meetingGuestJoin(options) {
|
|
983
|
+
return (options.client ?? this.client).post({
|
|
984
|
+
url: "/call/join/{token}",
|
|
985
|
+
...options,
|
|
986
|
+
headers: {
|
|
987
|
+
"Content-Type": "application/json",
|
|
988
|
+
...options.headers
|
|
989
|
+
}
|
|
990
|
+
});
|
|
991
|
+
}
|
|
992
|
+
/**
|
|
993
|
+
* Handle `POST /call/join/{token}/leave` through the call domain service.
|
|
994
|
+
*/
|
|
995
|
+
meetingLeave(options) {
|
|
996
|
+
return (options.client ?? this.client).post({ url: "/call/join/{token}/leave", ...options });
|
|
997
|
+
}
|
|
998
|
+
/**
|
|
999
|
+
* Read a standalone meeting preview without admitting a guest to the room.
|
|
1000
|
+
*/
|
|
1001
|
+
meetingGuestParticipants(options) {
|
|
1002
|
+
return (options.client ?? this.client).get({ url: "/call/join/{token}/participants", ...options });
|
|
1003
|
+
}
|
|
1004
|
+
/**
|
|
1005
|
+
* Handle `GET /call/meetings` through the call domain service.
|
|
1006
|
+
*/
|
|
1007
|
+
meetingList(options) {
|
|
1008
|
+
return (options?.client ?? this.client).get({ url: "/call/meetings", ...options });
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* Handle `POST /call/meetings` through the call domain service.
|
|
1012
|
+
*/
|
|
1013
|
+
meetingCreate(options) {
|
|
1014
|
+
return (options.client ?? this.client).post({
|
|
1015
|
+
url: "/call/meetings",
|
|
1016
|
+
...options,
|
|
1017
|
+
headers: {
|
|
1018
|
+
"Content-Type": "application/json",
|
|
1019
|
+
...options.headers
|
|
1020
|
+
}
|
|
1021
|
+
});
|
|
1022
|
+
}
|
|
1023
|
+
/**
|
|
1024
|
+
* List the authenticated actor's active quick calls.
|
|
1025
|
+
*/
|
|
1026
|
+
meetingListActive(options) {
|
|
1027
|
+
return (options?.client ?? this.client).get({ url: "/call/meetings/active", ...options });
|
|
1028
|
+
}
|
|
1029
|
+
/**
|
|
1030
|
+
* Read the authenticated caller's invitation capability without exposing the creator.
|
|
1031
|
+
*/
|
|
1032
|
+
meetingInvitePermissions(options) {
|
|
1033
|
+
return (options.client ?? this.client).get({ url: "/call/meetings/invite/{token}", ...options });
|
|
1034
|
+
}
|
|
1035
|
+
/**
|
|
1036
|
+
* Queue an owner-authorized guest invitation email.
|
|
1037
|
+
*/
|
|
1038
|
+
meetingInvite(options) {
|
|
1039
|
+
return (options.client ?? this.client).post({
|
|
1040
|
+
url: "/call/meetings/invite/{token}",
|
|
1041
|
+
...options,
|
|
1042
|
+
headers: {
|
|
1043
|
+
"Content-Type": "application/json",
|
|
1044
|
+
...options.headers
|
|
1045
|
+
}
|
|
1046
|
+
});
|
|
1047
|
+
}
|
|
1048
|
+
/**
|
|
1049
|
+
* Ring registered teammates selected by the standalone meeting owner.
|
|
1050
|
+
*/
|
|
1051
|
+
meetingInviteUsers(options) {
|
|
1052
|
+
return (options.client ?? this.client).post({
|
|
1053
|
+
url: "/call/meetings/invite/{token}/users",
|
|
1054
|
+
...options,
|
|
1055
|
+
headers: {
|
|
1056
|
+
"Content-Type": "application/json",
|
|
1057
|
+
...options.headers
|
|
1058
|
+
}
|
|
1059
|
+
});
|
|
1060
|
+
}
|
|
1061
|
+
/**
|
|
1062
|
+
* Handle `POST /call/meetings/join/{token}` through the call domain service.
|
|
1063
|
+
*/
|
|
1064
|
+
meetingJoin(options) {
|
|
1065
|
+
return (options.client ?? this.client).post({ url: "/call/meetings/join/{token}", ...options });
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Read the participant preview for an authenticated invitation holder.
|
|
1069
|
+
*/
|
|
1070
|
+
meetingParticipants(options) {
|
|
1071
|
+
return (options.client ?? this.client).get({ url: "/call/meetings/join/{token}/participants", ...options });
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Reserve a room while the authenticated caller configures a new call.
|
|
1075
|
+
*/
|
|
1076
|
+
meetingPrepare(options) {
|
|
1077
|
+
return (options?.client ?? this.client).post({ url: "/call/meetings/prepare", ...options });
|
|
1078
|
+
}
|
|
1079
|
+
/**
|
|
1080
|
+
* Cancel an unused room; the domain owns ownership and activation checks.
|
|
1081
|
+
*/
|
|
1082
|
+
meetingCancelPreparation(options) {
|
|
1083
|
+
return (options.client ?? this.client).delete({ url: "/call/meetings/prepare/{preparation_id}", ...options });
|
|
1084
|
+
}
|
|
1085
|
+
/**
|
|
1086
|
+
* Handle `DELETE /call/meetings/{meeting_id}` through the call domain service.
|
|
1087
|
+
*/
|
|
1088
|
+
meetingCancel(options) {
|
|
1089
|
+
return (options.client ?? this.client).delete({ url: "/call/meetings/{meeting_id}", ...options });
|
|
1090
|
+
}
|
|
1091
|
+
/**
|
|
1092
|
+
* Handle owner-authorized meeting title and schedule edits.
|
|
1093
|
+
*/
|
|
1094
|
+
meetingUpdate(options) {
|
|
1095
|
+
return (options.client ?? this.client).patch({
|
|
1096
|
+
url: "/call/meetings/{meeting_id}",
|
|
1097
|
+
...options,
|
|
1098
|
+
headers: {
|
|
1099
|
+
"Content-Type": "application/json",
|
|
1100
|
+
...options.headers
|
|
1101
|
+
}
|
|
1102
|
+
});
|
|
1103
|
+
}
|
|
947
1104
|
/**
|
|
948
1105
|
* Handler for `POST /call/record/preview`.
|
|
949
1106
|
*
|
|
@@ -984,8 +1141,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
984
1141
|
/**
|
|
985
1142
|
* Handler for `PATCH /call/record/{call_id}`.
|
|
986
1143
|
*
|
|
987
|
-
* Edits a call record
|
|
988
|
-
*
|
|
1144
|
+
* Edits a call record: link/channel share permissions, display name, and
|
|
1145
|
+
* team sharing. Edit access (channel membership) is required for the request.
|
|
1146
|
+
* `sharePermission.teamShareAccessLevel` only accepts `view` or `null`; while
|
|
1147
|
+
* the call is live it sets the pending share-with-team toggle, and once the
|
|
1148
|
+
* call is archived it is additionally authorized against the call's creator.
|
|
989
1149
|
*/
|
|
990
1150
|
editCallRecord(options) {
|
|
991
1151
|
return (options.client ?? this.client).patch({
|
|
@@ -997,11 +1157,30 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
997
1157
|
}
|
|
998
1158
|
});
|
|
999
1159
|
}
|
|
1160
|
+
/**
|
|
1161
|
+
* Handler for `POST /call/record/{call_id}/decline`.
|
|
1162
|
+
*
|
|
1163
|
+
* Declines the identified active call for the caller without joining it.
|
|
1164
|
+
* Bound to `call_id` so a stale incoming-call UI cannot decline a newer call
|
|
1165
|
+
* that replaced it in the same channel. The caller's other devices are told
|
|
1166
|
+
* to stop ringing (`call_declined`); the call continues for everyone else.
|
|
1167
|
+
*/
|
|
1168
|
+
declineCall(options) {
|
|
1169
|
+
return (options.client ?? this.client).post({ url: "/call/record/{call_id}/decline", ...options });
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* Handle `POST /call/record/{call_id}/link` through the call domain service.
|
|
1173
|
+
*/
|
|
1174
|
+
meetingShare(options) {
|
|
1175
|
+
return (options.client ?? this.client).post({ url: "/call/record/{call_id}/link", ...options });
|
|
1176
|
+
}
|
|
1000
1177
|
/**
|
|
1001
1178
|
* Handler for `POST /call/record/{call_id}/share-with-team/toggle`.
|
|
1002
1179
|
*
|
|
1003
|
-
*
|
|
1004
|
-
*
|
|
1180
|
+
* Flips the live call's share-with-team toggle and returns the new value as
|
|
1181
|
+
* the JSON body. The toggle is applied as canonical team sharing (View for
|
|
1182
|
+
* the creator's team) when the call is archived; archived calls answer 409
|
|
1183
|
+
* and are edited through `PATCH /call/record/{call_id}` instead.
|
|
1005
1184
|
*/
|
|
1006
1185
|
toggleShareWithTeam(options) {
|
|
1007
1186
|
return (options.client ?? this.client).post({ url: "/call/record/{call_id}/share-with-team/toggle", ...options });
|
|
@@ -1037,6 +1216,18 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1037
1216
|
getRingStatus(options) {
|
|
1038
1217
|
return (options.client ?? this.client).get({ url: "/call/ring-status/{call_id}", ...options });
|
|
1039
1218
|
}
|
|
1219
|
+
/**
|
|
1220
|
+
* Handler for `POST /call/ring-status/{call_id}/decline`.
|
|
1221
|
+
*
|
|
1222
|
+
* Declines a ringing call from a native client, e.g. the iPhone lock-screen
|
|
1223
|
+
* decline button, so the user's other devices stop ringing. Authorized like
|
|
1224
|
+
* [`ring_status_handler`]: the bearer credential is the recipient's LiveKit
|
|
1225
|
+
* JWT from the VoIP push payload, which identifies both the room and the
|
|
1226
|
+
* declining user.
|
|
1227
|
+
*/
|
|
1228
|
+
declineRing(options) {
|
|
1229
|
+
return (options.client ?? this.client).post({ url: "/call/ring-status/{call_id}/decline", ...options });
|
|
1230
|
+
}
|
|
1040
1231
|
/**
|
|
1041
1232
|
* Handler for `POST /call/webhook`.
|
|
1042
1233
|
*
|
|
@@ -1079,7 +1270,71 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1079
1270
|
*/
|
|
1080
1271
|
ingestTranscript(options) {
|
|
1081
1272
|
return (options.client ?? this.client).post({
|
|
1082
|
-
url: "/call/{
|
|
1273
|
+
url: "/call/{room_name}/transcript",
|
|
1274
|
+
...options,
|
|
1275
|
+
headers: {
|
|
1276
|
+
"Content-Type": "application/json",
|
|
1277
|
+
...options.headers
|
|
1278
|
+
}
|
|
1279
|
+
});
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* List the caller's shared or private labels.
|
|
1283
|
+
*/
|
|
1284
|
+
listChannelLabels(options) {
|
|
1285
|
+
return (options?.client ?? this.client).get({ url: "/channel-labels", ...options });
|
|
1286
|
+
}
|
|
1287
|
+
/**
|
|
1288
|
+
* Create a label for the caller's authorized scope.
|
|
1289
|
+
*/
|
|
1290
|
+
createChannelLabel(options) {
|
|
1291
|
+
return (options.client ?? this.client).post({
|
|
1292
|
+
url: "/channel-labels",
|
|
1293
|
+
...options,
|
|
1294
|
+
headers: {
|
|
1295
|
+
"Content-Type": "application/json",
|
|
1296
|
+
...options.headers
|
|
1297
|
+
}
|
|
1298
|
+
});
|
|
1299
|
+
}
|
|
1300
|
+
/**
|
|
1301
|
+
* Move a channel into a label of the caller's authorized scope, or out of any label.
|
|
1302
|
+
*/
|
|
1303
|
+
setChannelLabel(options) {
|
|
1304
|
+
return (options.client ?? this.client).put({
|
|
1305
|
+
url: "/channel-labels/channels/{channel_id}",
|
|
1306
|
+
...options,
|
|
1307
|
+
headers: {
|
|
1308
|
+
"Content-Type": "application/json",
|
|
1309
|
+
...options.headers
|
|
1310
|
+
}
|
|
1311
|
+
});
|
|
1312
|
+
}
|
|
1313
|
+
/**
|
|
1314
|
+
* Preview visible channels matched by a smart tag, without creating it.
|
|
1315
|
+
*/
|
|
1316
|
+
previewSmartTag(options) {
|
|
1317
|
+
return (options.client ?? this.client).post({
|
|
1318
|
+
url: "/channel-labels/preview",
|
|
1319
|
+
...options,
|
|
1320
|
+
headers: {
|
|
1321
|
+
"Content-Type": "application/json",
|
|
1322
|
+
...options.headers
|
|
1323
|
+
}
|
|
1324
|
+
});
|
|
1325
|
+
}
|
|
1326
|
+
/**
|
|
1327
|
+
* Delete a label of the caller's authorized scope. Its channels return to the plain list.
|
|
1328
|
+
*/
|
|
1329
|
+
deleteChannelLabel(options) {
|
|
1330
|
+
return (options.client ?? this.client).delete({ url: "/channel-labels/{label_id}", ...options });
|
|
1331
|
+
}
|
|
1332
|
+
/**
|
|
1333
|
+
* Rename a label of the caller's authorized scope.
|
|
1334
|
+
*/
|
|
1335
|
+
renameChannelLabel(options) {
|
|
1336
|
+
return (options.client ?? this.client).patch({
|
|
1337
|
+
url: "/channel-labels/{label_id}",
|
|
1083
1338
|
...options,
|
|
1084
1339
|
headers: {
|
|
1085
1340
|
"Content-Type": "application/json",
|
|
@@ -1251,75 +1506,6 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1251
1506
|
leaveChannel(options) {
|
|
1252
1507
|
return (options.client ?? this.client).post({ url: "/channels/{channel_id}/leave", ...options });
|
|
1253
1508
|
}
|
|
1254
|
-
/**
|
|
1255
|
-
* Handler for `POST /channels/{channel_id}/message`.
|
|
1256
|
-
*/
|
|
1257
|
-
postMessage(options) {
|
|
1258
|
-
return (options.client ?? this.client).post({
|
|
1259
|
-
url: "/channels/{channel_id}/message",
|
|
1260
|
-
...options,
|
|
1261
|
-
headers: {
|
|
1262
|
-
"Content-Type": "application/json",
|
|
1263
|
-
...options.headers
|
|
1264
|
-
}
|
|
1265
|
-
});
|
|
1266
|
-
}
|
|
1267
|
-
/**
|
|
1268
|
-
* Handler for `DELETE /channels/{channel_id}/message/{message_id}`.
|
|
1269
|
-
*/
|
|
1270
|
-
deleteMessage(options) {
|
|
1271
|
-
return (options.client ?? this.client).delete({ url: "/channels/{channel_id}/message/{message_id}", ...options });
|
|
1272
|
-
}
|
|
1273
|
-
/**
|
|
1274
|
-
* Handler for `PATCH /channels/{channel_id}/message/{message_id}`.
|
|
1275
|
-
*/
|
|
1276
|
-
patchMessage(options) {
|
|
1277
|
-
return (options.client ?? this.client).patch({
|
|
1278
|
-
url: "/channels/{channel_id}/message/{message_id}",
|
|
1279
|
-
...options,
|
|
1280
|
-
headers: {
|
|
1281
|
-
"Content-Type": "application/json",
|
|
1282
|
-
...options.headers
|
|
1283
|
-
}
|
|
1284
|
-
});
|
|
1285
|
-
}
|
|
1286
|
-
/**
|
|
1287
|
-
* Handler for `GET /channels/{channel_id}/messages`.
|
|
1288
|
-
*/
|
|
1289
|
-
getChannelMessages(options) {
|
|
1290
|
-
return (options.client ?? this.client).get({ url: "/channels/{channel_id}/messages", ...options });
|
|
1291
|
-
}
|
|
1292
|
-
/**
|
|
1293
|
-
* Handler for `POST /channels/{channel_id}/messages`.
|
|
1294
|
-
*/
|
|
1295
|
-
postChannelMessages(options) {
|
|
1296
|
-
return (options.client ?? this.client).post({
|
|
1297
|
-
url: "/channels/{channel_id}/messages",
|
|
1298
|
-
...options,
|
|
1299
|
-
headers: {
|
|
1300
|
-
"Content-Type": "application/json",
|
|
1301
|
-
...options.headers
|
|
1302
|
-
}
|
|
1303
|
-
});
|
|
1304
|
-
}
|
|
1305
|
-
/**
|
|
1306
|
-
* Handler for `GET /channels/{channel_id}/messages/{message_id}/context`.
|
|
1307
|
-
*/
|
|
1308
|
-
getMessageWithContext(options) {
|
|
1309
|
-
return (options.client ?? this.client).get({ url: "/channels/{channel_id}/messages/{message_id}/context", ...options });
|
|
1310
|
-
}
|
|
1311
|
-
/**
|
|
1312
|
-
* Handler for `GET /channels/{channel_id}/messages/{message_id}/replies`.
|
|
1313
|
-
*/
|
|
1314
|
-
getThreadReplies(options) {
|
|
1315
|
-
return (options.client ?? this.client).get({ url: "/channels/{channel_id}/messages/{message_id}/replies", ...options });
|
|
1316
|
-
}
|
|
1317
|
-
/**
|
|
1318
|
-
* Handler for `GET /channels/{channel_id}/messages/{message_id}/resolve`.
|
|
1319
|
-
*/
|
|
1320
|
-
resolveChannelMessage(options) {
|
|
1321
|
-
return (options.client ?? this.client).get({ url: "/channels/{channel_id}/messages/{message_id}/resolve", ...options });
|
|
1322
|
-
}
|
|
1323
1509
|
/**
|
|
1324
1510
|
* Handler for `DELETE /channels/{channel_id}/participants`.
|
|
1325
1511
|
*/
|
|
@@ -1353,24 +1539,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1353
1539
|
});
|
|
1354
1540
|
}
|
|
1355
1541
|
/**
|
|
1356
|
-
*
|
|
1357
|
-
*/
|
|
1358
|
-
postReaction(options) {
|
|
1359
|
-
return (options.client ?? this.client).post({
|
|
1360
|
-
url: "/channels/{channel_id}/reaction",
|
|
1361
|
-
...options,
|
|
1362
|
-
headers: {
|
|
1363
|
-
"Content-Type": "application/json",
|
|
1364
|
-
...options.headers
|
|
1365
|
-
}
|
|
1366
|
-
});
|
|
1367
|
-
}
|
|
1368
|
-
/**
|
|
1369
|
-
* Handler for `POST /channels/{channel_id}/typing`.
|
|
1542
|
+
* Set a channel or group chat profile picture. Requires channel participation.
|
|
1370
1543
|
*/
|
|
1371
|
-
|
|
1372
|
-
return (options.client ?? this.client).
|
|
1373
|
-
url: "/channels/{channel_id}/
|
|
1544
|
+
setChannelPicture(options) {
|
|
1545
|
+
return (options.client ?? this.client).put({
|
|
1546
|
+
url: "/channels/{channel_id}/profile_picture",
|
|
1374
1547
|
...options,
|
|
1375
1548
|
headers: {
|
|
1376
1549
|
"Content-Type": "application/json",
|
|
@@ -1433,54 +1606,6 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1433
1606
|
getChannels(options) {
|
|
1434
1607
|
return (options?.client ?? this.client).get({ url: "/comms/channels", ...options });
|
|
1435
1608
|
}
|
|
1436
|
-
/**
|
|
1437
|
-
* Soft-delete a CRM comment, scoped to the requesting user's team. When it
|
|
1438
|
-
* was the thread's last live comment, the thread is soft-deleted too
|
|
1439
|
-
* (reported via `threadDeleted`).
|
|
1440
|
-
*/
|
|
1441
|
-
deleteCrmComment(options) {
|
|
1442
|
-
return (options.client ?? this.client).delete({ url: "/crm/comment/{comment_id}", ...options });
|
|
1443
|
-
}
|
|
1444
|
-
/**
|
|
1445
|
-
* Edit a CRM comment's text, scoped to the requesting user's team via the
|
|
1446
|
-
* comment's thread → entity → company. Returns the updated comment.
|
|
1447
|
-
*/
|
|
1448
|
-
editCrmComment(options) {
|
|
1449
|
-
return (options.client ?? this.client).patch({
|
|
1450
|
-
url: "/crm/comment/{comment_id}",
|
|
1451
|
-
...options,
|
|
1452
|
-
headers: {
|
|
1453
|
-
"Content-Type": "application/json",
|
|
1454
|
-
...options.headers
|
|
1455
|
-
}
|
|
1456
|
-
});
|
|
1457
|
-
}
|
|
1458
|
-
/**
|
|
1459
|
-
* List the comment threads on a CRM company or contact. Access is
|
|
1460
|
-
* enforced by [`EntityPermissionExtractor`] against the path's
|
|
1461
|
-
* `crm_company`/`crm_contact` entity type — hidden parents are
|
|
1462
|
-
* invisible to plain members. An accessible entity with no threads
|
|
1463
|
-
* returns `200 []`.
|
|
1464
|
-
*/
|
|
1465
|
-
listCrmComments(options) {
|
|
1466
|
-
return (options.client ?? this.client).get({ url: "/crm/comments/{entity_type}/{entity_id}", ...options });
|
|
1467
|
-
}
|
|
1468
|
-
/**
|
|
1469
|
-
* Create a comment on a CRM company or contact — a new thread, or a reply
|
|
1470
|
-
* when `threadId` is supplied. Returns the full thread (with all comments)
|
|
1471
|
-
* after the insert. Team-scoped; 404 when the entity isn't owned by the
|
|
1472
|
-
* team or `threadId` doesn't belong to it.
|
|
1473
|
-
*/
|
|
1474
|
-
createCrmComment(options) {
|
|
1475
|
-
return (options.client ?? this.client).post({
|
|
1476
|
-
url: "/crm/comments/{entity_type}/{entity_id}",
|
|
1477
|
-
...options,
|
|
1478
|
-
headers: {
|
|
1479
|
-
"Content-Type": "application/json",
|
|
1480
|
-
...options.headers
|
|
1481
|
-
}
|
|
1482
|
-
});
|
|
1483
|
-
}
|
|
1484
1609
|
/**
|
|
1485
1610
|
* Manually create a CRM company for the caller's team. Any team member
|
|
1486
1611
|
* may create one. The domain must not already be tracked by the team
|
|
@@ -1588,6 +1713,14 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1588
1713
|
}
|
|
1589
1714
|
});
|
|
1590
1715
|
}
|
|
1716
|
+
/**
|
|
1717
|
+
* Search the caller's team's CRM contacts by email or name. Any team member
|
|
1718
|
+
* may search visible contacts; admin/owner callers also match hidden
|
|
1719
|
+
* contacts and contacts under hidden companies.
|
|
1720
|
+
*/
|
|
1721
|
+
searchContacts(options) {
|
|
1722
|
+
return (options?.client ?? this.client).get({ url: "/crm/contacts", ...options });
|
|
1723
|
+
}
|
|
1591
1724
|
/**
|
|
1592
1725
|
* Look up a CRM contact by email in the caller's team. Returns a null
|
|
1593
1726
|
* `contact` when no visible contact exists. Any team member may resolve a
|
|
@@ -1638,6 +1771,128 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1638
1771
|
}
|
|
1639
1772
|
});
|
|
1640
1773
|
}
|
|
1774
|
+
/**
|
|
1775
|
+
* List the caller's live pipelines in their CRM.
|
|
1776
|
+
*/
|
|
1777
|
+
listCrmPipelines(options) {
|
|
1778
|
+
return (options?.client ?? this.client).get({ url: "/crm/pipelines", ...options });
|
|
1779
|
+
}
|
|
1780
|
+
/**
|
|
1781
|
+
* Create a private or team-shared pipeline.
|
|
1782
|
+
*/
|
|
1783
|
+
createCrmPipeline(options) {
|
|
1784
|
+
return (options.client ?? this.client).post({
|
|
1785
|
+
url: "/crm/pipelines",
|
|
1786
|
+
...options,
|
|
1787
|
+
headers: {
|
|
1788
|
+
"Content-Type": "application/json",
|
|
1789
|
+
...options.headers
|
|
1790
|
+
}
|
|
1791
|
+
});
|
|
1792
|
+
}
|
|
1793
|
+
/**
|
|
1794
|
+
* Read one pipeline by its entity identity.
|
|
1795
|
+
*/
|
|
1796
|
+
getCrmPipeline(options) {
|
|
1797
|
+
return (options.client ?? this.client).get({ url: "/crm/pipelines/{id}", ...options });
|
|
1798
|
+
}
|
|
1799
|
+
/**
|
|
1800
|
+
* Rename a pipeline.
|
|
1801
|
+
*/
|
|
1802
|
+
renameCrmPipeline(options) {
|
|
1803
|
+
return (options.client ?? this.client).put({
|
|
1804
|
+
url: "/crm/pipelines/{id}/name",
|
|
1805
|
+
...options,
|
|
1806
|
+
headers: {
|
|
1807
|
+
"Content-Type": "application/json",
|
|
1808
|
+
...options.headers
|
|
1809
|
+
}
|
|
1810
|
+
});
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* Edit pipeline schema or records with the common typed operations.
|
|
1814
|
+
*/
|
|
1815
|
+
applyCrmPipelineOps(options) {
|
|
1816
|
+
return (options.client ?? this.client).post({
|
|
1817
|
+
url: "/crm/pipelines/{id}/ops",
|
|
1818
|
+
...options,
|
|
1819
|
+
headers: {
|
|
1820
|
+
"Content-Type": "application/json",
|
|
1821
|
+
...options.headers
|
|
1822
|
+
}
|
|
1823
|
+
});
|
|
1824
|
+
}
|
|
1825
|
+
/**
|
|
1826
|
+
* Read the owner, team grant and channel recipients of a pipeline the caller can edit.
|
|
1827
|
+
*/
|
|
1828
|
+
getCrmPipelinePermissions(options) {
|
|
1829
|
+
return (options.client ?? this.client).get({ url: "/crm/pipelines/{id}/permissions", ...options });
|
|
1830
|
+
}
|
|
1831
|
+
/**
|
|
1832
|
+
* Share a pipeline the caller can edit with channels, or change or remove
|
|
1833
|
+
* their access. Team access changes through `/sharing`; there is no share link.
|
|
1834
|
+
*/
|
|
1835
|
+
updateCrmPipelinePermissions(options) {
|
|
1836
|
+
return (options.client ?? this.client).patch({
|
|
1837
|
+
url: "/crm/pipelines/{id}/permissions",
|
|
1838
|
+
...options,
|
|
1839
|
+
headers: {
|
|
1840
|
+
"Content-Type": "application/json",
|
|
1841
|
+
...options.headers
|
|
1842
|
+
}
|
|
1843
|
+
});
|
|
1844
|
+
}
|
|
1845
|
+
/**
|
|
1846
|
+
* Read pipeline records through pipeline access.
|
|
1847
|
+
*/
|
|
1848
|
+
getCrmPipelineRows(options) {
|
|
1849
|
+
return (options.client ?? this.client).get({ url: "/crm/pipelines/{id}/rows", ...options });
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* Query rows through pipeline access using the shared view protocol.
|
|
1853
|
+
*/
|
|
1854
|
+
queryCrmPipelineRows(options) {
|
|
1855
|
+
return (options.client ?? this.client).post({
|
|
1856
|
+
url: "/crm/pipelines/{id}/rows",
|
|
1857
|
+
...options,
|
|
1858
|
+
headers: {
|
|
1859
|
+
"Content-Type": "application/json",
|
|
1860
|
+
...options.headers
|
|
1861
|
+
}
|
|
1862
|
+
});
|
|
1863
|
+
}
|
|
1864
|
+
/**
|
|
1865
|
+
* Update sharing.
|
|
1866
|
+
*/
|
|
1867
|
+
shareCrmPipeline(options) {
|
|
1868
|
+
return (options.client ?? this.client).put({
|
|
1869
|
+
url: "/crm/pipelines/{id}/sharing",
|
|
1870
|
+
...options,
|
|
1871
|
+
headers: {
|
|
1872
|
+
"Content-Type": "application/json",
|
|
1873
|
+
...options.headers
|
|
1874
|
+
}
|
|
1875
|
+
});
|
|
1876
|
+
}
|
|
1877
|
+
/**
|
|
1878
|
+
* Read the host-owned table schema.
|
|
1879
|
+
*/
|
|
1880
|
+
getCrmPipelineTable(options) {
|
|
1881
|
+
return (options.client ?? this.client).get({ url: "/crm/pipelines/{id}/table", ...options });
|
|
1882
|
+
}
|
|
1883
|
+
/**
|
|
1884
|
+
* Trash or restore a pipeline.
|
|
1885
|
+
*/
|
|
1886
|
+
trashCrmPipeline(options) {
|
|
1887
|
+
return (options.client ?? this.client).put({
|
|
1888
|
+
url: "/crm/pipelines/{id}/trash",
|
|
1889
|
+
...options,
|
|
1890
|
+
headers: {
|
|
1891
|
+
"Content-Type": "application/json",
|
|
1892
|
+
...options.headers
|
|
1893
|
+
}
|
|
1894
|
+
});
|
|
1895
|
+
}
|
|
1641
1896
|
/**
|
|
1642
1897
|
* Read the caller's team CRM configuration. Any team member may read;
|
|
1643
1898
|
* teams without a settings row get the defaults.
|
|
@@ -1664,20 +1919,17 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1664
1919
|
});
|
|
1665
1920
|
}
|
|
1666
1921
|
/**
|
|
1667
|
-
*
|
|
1922
|
+
* Reset the team's deal stages to the defaults; gated like `PUT /crm/stages`.
|
|
1668
1923
|
*/
|
|
1669
|
-
|
|
1670
|
-
return (options
|
|
1924
|
+
resetCrmTeamStages(options) {
|
|
1925
|
+
return (options?.client ?? this.client).delete({ url: "/crm/stages", ...options });
|
|
1671
1926
|
}
|
|
1672
1927
|
/**
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1675
|
-
* Creates a new document, generates an S3 presigned upload URL, and returns
|
|
1676
|
-
* the document metadata with the URL for the client to upload to.
|
|
1928
|
+
* Replace the team's deal stages; requires `edit_stages_role` (403 otherwise).
|
|
1677
1929
|
*/
|
|
1678
|
-
|
|
1679
|
-
return (options.client ?? this.client).
|
|
1680
|
-
url: "/
|
|
1930
|
+
putCrmTeamStages(options) {
|
|
1931
|
+
return (options.client ?? this.client).put({
|
|
1932
|
+
url: "/crm/stages",
|
|
1681
1933
|
...options,
|
|
1682
1934
|
headers: {
|
|
1683
1935
|
"Content-Type": "application/json",
|
|
@@ -1686,11 +1938,18 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1686
1938
|
});
|
|
1687
1939
|
}
|
|
1688
1940
|
/**
|
|
1689
|
-
*
|
|
1941
|
+
* List the caller's databases.
|
|
1690
1942
|
*/
|
|
1691
|
-
|
|
1943
|
+
listDatabases(options) {
|
|
1944
|
+
return (options?.client ?? this.client).get({ url: "/databases", ...options });
|
|
1945
|
+
}
|
|
1946
|
+
/**
|
|
1947
|
+
* Create a database owned by the caller; its first table, "Table 1", holds a
|
|
1948
|
+
* "Name" text column.
|
|
1949
|
+
*/
|
|
1950
|
+
createDatabase(options) {
|
|
1692
1951
|
return (options.client ?? this.client).post({
|
|
1693
|
-
url: "/
|
|
1952
|
+
url: "/databases",
|
|
1694
1953
|
...options,
|
|
1695
1954
|
headers: {
|
|
1696
1955
|
"Content-Type": "application/json",
|
|
@@ -1699,14 +1958,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1699
1958
|
});
|
|
1700
1959
|
}
|
|
1701
1960
|
/**
|
|
1702
|
-
*
|
|
1703
|
-
* backend-owned lifecycle. Skills are markdown documents containing
|
|
1704
|
-
* instructions that AI reads and follows when the skill is referenced in an
|
|
1705
|
-
* AI input.
|
|
1961
|
+
* Save an immutable query. Editing a question saves a new one.
|
|
1706
1962
|
*/
|
|
1707
|
-
|
|
1963
|
+
saveDatabaseQuery(options) {
|
|
1708
1964
|
return (options.client ?? this.client).post({
|
|
1709
|
-
url: "/
|
|
1965
|
+
url: "/databases/queries",
|
|
1710
1966
|
...options,
|
|
1711
1967
|
headers: {
|
|
1712
1968
|
"Content-Type": "application/json",
|
|
@@ -1715,13 +1971,18 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1715
1971
|
});
|
|
1716
1972
|
}
|
|
1717
1973
|
/**
|
|
1718
|
-
*
|
|
1719
|
-
* backend-owned lifecycle. Snippets are created personal; team sharing is
|
|
1720
|
-
* toggled separately via `PUT /documents/{document_id}/team_share`.
|
|
1974
|
+
* A saved query's definition, for its creator or a viewer of its database.
|
|
1721
1975
|
*/
|
|
1722
|
-
|
|
1976
|
+
getDatabaseQuery(options) {
|
|
1977
|
+
return (options.client ?? this.client).get({ url: "/databases/queries/{query_id}", ...options });
|
|
1978
|
+
}
|
|
1979
|
+
/**
|
|
1980
|
+
* Run one statement as the authenticated user. The viewer's catalog authorizes reads;
|
|
1981
|
+
* the SQL domain service obtains an edit receipt for every written database.
|
|
1982
|
+
*/
|
|
1983
|
+
queryDatabases(options) {
|
|
1723
1984
|
return (options.client ?? this.client).post({
|
|
1724
|
-
url: "/
|
|
1985
|
+
url: "/databases/query",
|
|
1725
1986
|
...options,
|
|
1726
1987
|
headers: {
|
|
1727
1988
|
"Content-Type": "application/json",
|
|
@@ -1730,12 +1991,21 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1730
1991
|
});
|
|
1731
1992
|
}
|
|
1732
1993
|
/**
|
|
1733
|
-
*
|
|
1734
|
-
* one backend-owned lifecycle.
|
|
1994
|
+
* Create a small example once for the authenticated user, if they have no databases.
|
|
1735
1995
|
*/
|
|
1736
|
-
|
|
1996
|
+
ensureStarterHandler(options) {
|
|
1997
|
+
return (options?.client ?? this.client).post({ url: "/databases/starter", ...options });
|
|
1998
|
+
}
|
|
1999
|
+
/**
|
|
2000
|
+
* Insert rows through a webhook. The body is a JSON object, one row, or
|
|
2001
|
+
* an array of up to 100 objects, one row each. Keys name columns by name
|
|
2002
|
+
* (ignoring case) or id; `null` leaves a cell empty. Values may be loose:
|
|
2003
|
+
* `"45"` for a number, `"true"` for a checkbox, a label or labels for a
|
|
2004
|
+
* select, `2026-10-09` for a date. Nothing is written unless every row fits.
|
|
2005
|
+
*/
|
|
2006
|
+
deliverDatabaseWebhook(options) {
|
|
1737
2007
|
return (options.client ?? this.client).post({
|
|
1738
|
-
url: "/
|
|
2008
|
+
url: "/databases/webhooks/{token}",
|
|
1739
2009
|
...options,
|
|
1740
2010
|
headers: {
|
|
1741
2011
|
"Content-Type": "application/json",
|
|
@@ -1743,21 +2013,18 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1743
2013
|
}
|
|
1744
2014
|
});
|
|
1745
2015
|
}
|
|
1746
|
-
initializeUserDocuments(options) {
|
|
1747
|
-
return (options?.client ?? this.client).post({ url: "/documents/initialize_user_documents", ...options });
|
|
1748
|
-
}
|
|
1749
2016
|
/**
|
|
1750
|
-
*
|
|
2017
|
+
* Schema detail of one database.
|
|
1751
2018
|
*/
|
|
1752
|
-
|
|
1753
|
-
return (options
|
|
2019
|
+
getDatabase(options) {
|
|
2020
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}", ...options });
|
|
1754
2021
|
}
|
|
1755
2022
|
/**
|
|
1756
|
-
*
|
|
2023
|
+
* Tell a database's other viewers where the caller is.
|
|
1757
2024
|
*/
|
|
1758
|
-
|
|
1759
|
-
return (options.client ?? this.client).
|
|
1760
|
-
url: "/
|
|
2025
|
+
shareDatabaseAwareness(options) {
|
|
2026
|
+
return (options.client ?? this.client).put({
|
|
2027
|
+
url: "/databases/{id}/awareness",
|
|
1761
2028
|
...options,
|
|
1762
2029
|
headers: {
|
|
1763
2030
|
"Content-Type": "application/json",
|
|
@@ -1766,20 +2033,22 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1766
2033
|
});
|
|
1767
2034
|
}
|
|
1768
2035
|
/**
|
|
1769
|
-
*
|
|
2036
|
+
* Undo one of your own committed changes: its inverse applies as a new,
|
|
2037
|
+
* journaled batch, under the table's lock, guarded against what others
|
|
2038
|
+
* changed since. A cell someone changed since is left alone and listed; a
|
|
2039
|
+
* row or column you added that someone else wrote since, or a name, option,
|
|
2040
|
+
* order, view or card place changed since, refuses the undo. Others'
|
|
2041
|
+
* changes always stay. Redo by undoing the undo's change.
|
|
1770
2042
|
*/
|
|
1771
|
-
|
|
1772
|
-
return (options.client ?? this.client).post({ url: "/
|
|
2043
|
+
undoDatabaseChange(options) {
|
|
2044
|
+
return (options.client ?? this.client).post({ url: "/databases/{id}/changes/{change}/undo", ...options });
|
|
1773
2045
|
}
|
|
1774
2046
|
/**
|
|
1775
|
-
*
|
|
1776
|
-
* any new content
|
|
1777
|
-
*
|
|
1778
|
-
* @deprecated
|
|
2047
|
+
* Import a new table and every row atomically; retries carry the same request ID.
|
|
1779
2048
|
*/
|
|
1780
|
-
|
|
1781
|
-
return (options.client ?? this.client).
|
|
1782
|
-
url: "/
|
|
2049
|
+
importDatabaseTable(options) {
|
|
2050
|
+
return (options.client ?? this.client).post({
|
|
2051
|
+
url: "/databases/{id}/import",
|
|
1783
2052
|
...options,
|
|
1784
2053
|
headers: {
|
|
1785
2054
|
"Content-Type": "application/json",
|
|
@@ -1787,9 +2056,19 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1787
2056
|
}
|
|
1788
2057
|
});
|
|
1789
2058
|
}
|
|
1790
|
-
|
|
2059
|
+
/**
|
|
2060
|
+
* Apply a batch of typed ops, the one write surface of a database: add,
|
|
2061
|
+
* rename, remove and order tables and columns, change a column's type, add
|
|
2062
|
+
* and change options, insert, update and delete rows, and write views and a
|
|
2063
|
+
* board's card places. The ops apply in order in one transaction, so a
|
|
2064
|
+
* later op may name a table, column, option or view an earlier one created
|
|
2065
|
+
* under the id its client minted. Ops are last-write-wins unless the batch names
|
|
2066
|
+
* base versions. A refused op, named by its index (and row and column where
|
|
2067
|
+
* relevant), leaves the whole batch unwritten.
|
|
2068
|
+
*/
|
|
2069
|
+
applyDatabaseOps(options) {
|
|
1791
2070
|
return (options.client ?? this.client).post({
|
|
1792
|
-
url: "/
|
|
2071
|
+
url: "/databases/{id}/ops",
|
|
1793
2072
|
...options,
|
|
1794
2073
|
headers: {
|
|
1795
2074
|
"Content-Type": "application/json",
|
|
@@ -1798,54 +2077,54 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1798
2077
|
});
|
|
1799
2078
|
}
|
|
1800
2079
|
/**
|
|
1801
|
-
*
|
|
1802
|
-
*
|
|
1803
|
-
* Returns document metadata, user access level, and view location.
|
|
1804
|
-
*/
|
|
1805
|
-
getDocumentByTeamSlug(options) {
|
|
1806
|
-
return (options.client ?? this.client).get({ url: "/documents/slug/{slug}", ...options });
|
|
1807
|
-
}
|
|
1808
|
-
/**
|
|
1809
|
-
* Resolves the current user's starter documents.
|
|
2080
|
+
* Read recipients for a database owned by the caller. Link and team
|
|
2081
|
+
* sharing are always `null`: databases do not support them yet.
|
|
1810
2082
|
*/
|
|
1811
|
-
|
|
1812
|
-
return (options
|
|
2083
|
+
getDatabasePermissions(options) {
|
|
2084
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}/permissions", ...options });
|
|
1813
2085
|
}
|
|
1814
2086
|
/**
|
|
1815
|
-
*
|
|
1816
|
-
*
|
|
1817
|
-
* skills menu and AI skill tools like user skills, but have no document
|
|
1818
|
-
* behind them, so clients must not offer to open them.
|
|
2087
|
+
* Update channel recipients after proving database ownership. Turning on
|
|
2088
|
+
* link or team sharing is refused; ownership cannot be changed here.
|
|
1819
2089
|
*/
|
|
1820
|
-
|
|
1821
|
-
return (options
|
|
2090
|
+
updateDatabasePermissions(options) {
|
|
2091
|
+
return (options.client ?? this.client).patch({
|
|
2092
|
+
url: "/databases/{id}/permissions",
|
|
2093
|
+
...options,
|
|
2094
|
+
headers: {
|
|
2095
|
+
"Content-Type": "application/json",
|
|
2096
|
+
...options.headers
|
|
2097
|
+
}
|
|
2098
|
+
});
|
|
1822
2099
|
}
|
|
1823
2100
|
/**
|
|
1824
|
-
*
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
2101
|
+
* What changed in a table since a version, from the change journal: the
|
|
2102
|
+
* rows that changed, each once as it stands now (`insert`, `update` or
|
|
2103
|
+
* `delete`), and the columns. A reader holding the table at `since` reads
|
|
2104
|
+
* just those rows; it reads the table whole when a column changed, the
|
|
2105
|
+
* journal is not `complete`, or the rows are `truncated`.
|
|
1827
2106
|
*/
|
|
1828
|
-
|
|
1829
|
-
return (options.client ?? this.client).
|
|
2107
|
+
getDatabaseTableChanges(options) {
|
|
2108
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}/tables/{table_id}/changes", ...options });
|
|
1830
2109
|
}
|
|
1831
2110
|
/**
|
|
1832
|
-
*
|
|
1833
|
-
*
|
|
1834
|
-
*
|
|
2111
|
+
* What changing one column to each type of the type menu would do to its
|
|
2112
|
+
* values: safe, checked (with how many values would not convert and a few
|
|
2113
|
+
* of them), or never (with why). Changes nothing.
|
|
1835
2114
|
*/
|
|
1836
|
-
|
|
1837
|
-
return (options.client ?? this.client).get({ url: "/
|
|
2115
|
+
listDatabaseColumnCasts(options) {
|
|
2116
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}/tables/{table_id}/columns/{column_id}/casts", ...options });
|
|
1838
2117
|
}
|
|
1839
2118
|
/**
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
*
|
|
1843
|
-
*
|
|
1844
|
-
*
|
|
2119
|
+
* What one column's values become under another type: the values that
|
|
2120
|
+
* convert, with the options they need, for a new column of that type beside
|
|
2121
|
+
* it. The column itself is left as it is: a client writes the conversion as
|
|
2122
|
+
* one ops batch, a `create_column` then an `update_rows`, with the answered
|
|
2123
|
+
* table version as its base version. Changes nothing.
|
|
1845
2124
|
*/
|
|
1846
|
-
|
|
1847
|
-
return (options.client ?? this.client).
|
|
1848
|
-
url: "/
|
|
2125
|
+
convertDatabaseColumn(options) {
|
|
2126
|
+
return (options.client ?? this.client).post({
|
|
2127
|
+
url: "/databases/{id}/tables/{table_id}/columns/{column_id}/conversion",
|
|
1849
2128
|
...options,
|
|
1850
2129
|
headers: {
|
|
1851
2130
|
"Content-Type": "application/json",
|
|
@@ -1854,11 +2133,11 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1854
2133
|
});
|
|
1855
2134
|
}
|
|
1856
2135
|
/**
|
|
1857
|
-
*
|
|
2136
|
+
* Settle a new empty text column's type.
|
|
1858
2137
|
*/
|
|
1859
|
-
|
|
1860
|
-
return (options.client ?? this.client).
|
|
1861
|
-
url: "/
|
|
2138
|
+
inferDatabaseColumnType(options) {
|
|
2139
|
+
return (options.client ?? this.client).post({
|
|
2140
|
+
url: "/databases/{id}/tables/{table_id}/columns/{column_id}/infer-type",
|
|
1862
2141
|
...options,
|
|
1863
2142
|
headers: {
|
|
1864
2143
|
"Content-Type": "application/json",
|
|
@@ -1867,23 +2146,34 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1867
2146
|
});
|
|
1868
2147
|
}
|
|
1869
2148
|
/**
|
|
1870
|
-
*
|
|
1871
|
-
*
|
|
1872
|
-
*
|
|
1873
|
-
*
|
|
2149
|
+
* A row's history, from the change journal: every committed change that
|
|
2150
|
+
* touched it, newest first, with who made it, when, and the values of the
|
|
2151
|
+
* columns it touched before and after. It reads after the row is removed,
|
|
2152
|
+
* so a removed row's last values stay readable.
|
|
1874
2153
|
*/
|
|
1875
|
-
|
|
1876
|
-
return (options.client ?? this.client).get({ url: "/
|
|
2154
|
+
getDatabaseRowHistory(options) {
|
|
2155
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}/tables/{table_id}/rows/{row_id}/history", ...options });
|
|
1877
2156
|
}
|
|
1878
2157
|
/**
|
|
1879
|
-
*
|
|
1880
|
-
*
|
|
1881
|
-
* Copies an existing document, creating a new document with the same content.
|
|
1882
|
-
* Does not require re-uploading the document file.
|
|
2158
|
+
* Where a board's cards sit, for drawing it: the views come with the
|
|
2159
|
+
* database's detail, their cards' places from here.
|
|
1883
2160
|
*/
|
|
1884
|
-
|
|
2161
|
+
getDatabaseViewPositions(options) {
|
|
2162
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}/views/{view_id}/positions", ...options });
|
|
2163
|
+
}
|
|
2164
|
+
/**
|
|
2165
|
+
* The database's webhooks.
|
|
2166
|
+
*/
|
|
2167
|
+
listDatabaseWebhooks(options) {
|
|
2168
|
+
return (options.client ?? this.client).get({ url: "/databases/{id}/webhooks", ...options });
|
|
2169
|
+
}
|
|
2170
|
+
/**
|
|
2171
|
+
* Create a webhook: a secret URL whose calls insert rows into one of the
|
|
2172
|
+
* database's tables, writing with the creator's access.
|
|
2173
|
+
*/
|
|
2174
|
+
createDatabaseWebhook(options) {
|
|
1885
2175
|
return (options.client ?? this.client).post({
|
|
1886
|
-
url: "/
|
|
2176
|
+
url: "/databases/{id}/webhooks",
|
|
1887
2177
|
...options,
|
|
1888
2178
|
headers: {
|
|
1889
2179
|
"Content-Type": "application/json",
|
|
@@ -1892,23 +2182,290 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1892
2182
|
});
|
|
1893
2183
|
}
|
|
1894
2184
|
/**
|
|
1895
|
-
*
|
|
1896
|
-
* For files with modification layers, they will not be applied in the downloaded file.
|
|
2185
|
+
* Delete a webhook; its URL stops working.
|
|
1897
2186
|
*/
|
|
1898
|
-
|
|
1899
|
-
return (options.client ?? this.client).
|
|
2187
|
+
deleteDatabaseWebhook(options) {
|
|
2188
|
+
return (options.client ?? this.client).delete({ url: "/databases/{id}/webhooks/{webhook_id}", ...options });
|
|
1900
2189
|
}
|
|
1901
2190
|
/**
|
|
1902
|
-
*
|
|
2191
|
+
* Transcribe a transient recording with OpenAI Whisper.
|
|
1903
2192
|
*
|
|
1904
|
-
*
|
|
1905
|
-
*
|
|
2193
|
+
* Available to every signed-in user on every plan; does not consume chat
|
|
2194
|
+
* credits. Audio and transcripts are never persisted.
|
|
1906
2195
|
*/
|
|
1907
|
-
|
|
1908
|
-
return (options.client ?? this.client).
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
2196
|
+
transcribeDictation(options) {
|
|
2197
|
+
return (options.client ?? this.client).post({
|
|
2198
|
+
bodySerializer: null,
|
|
2199
|
+
url: "/dictation/transcribe",
|
|
2200
|
+
...options,
|
|
2201
|
+
headers: {
|
|
2202
|
+
"Content-Type": "audio/webm",
|
|
2203
|
+
...options.headers
|
|
2204
|
+
}
|
|
2205
|
+
});
|
|
2206
|
+
}
|
|
2207
|
+
/**
|
|
2208
|
+
* Gets the users documents to populate their recent document list
|
|
2209
|
+
*/
|
|
2210
|
+
getUserDocumentsHandler(options) {
|
|
2211
|
+
return (options.client ?? this.client).get({ url: "/documents", ...options });
|
|
2212
|
+
}
|
|
2213
|
+
/**
|
|
2214
|
+
* Handler for `POST /documents`.
|
|
2215
|
+
*
|
|
2216
|
+
* Creates a new document, generates an S3 presigned upload URL, and returns
|
|
2217
|
+
* the document metadata with the URL for the client to upload to.
|
|
2218
|
+
*/
|
|
2219
|
+
createDocument(options) {
|
|
2220
|
+
return (options.client ?? this.client).post({
|
|
2221
|
+
url: "/documents",
|
|
2222
|
+
...options,
|
|
2223
|
+
headers: {
|
|
2224
|
+
"Content-Type": "application/json",
|
|
2225
|
+
...options.headers
|
|
2226
|
+
}
|
|
2227
|
+
});
|
|
2228
|
+
}
|
|
2229
|
+
/**
|
|
2230
|
+
* Creates and initializes a markdown document in one backend-owned lifecycle.
|
|
2231
|
+
*/
|
|
2232
|
+
createMarkdownHandler(options) {
|
|
2233
|
+
return (options.client ?? this.client).post({
|
|
2234
|
+
url: "/documents/create_markdown",
|
|
2235
|
+
...options,
|
|
2236
|
+
headers: {
|
|
2237
|
+
"Content-Type": "application/json",
|
|
2238
|
+
...options.headers
|
|
2239
|
+
}
|
|
2240
|
+
});
|
|
2241
|
+
}
|
|
2242
|
+
/**
|
|
2243
|
+
* Creates a skill document with initialized markdown content in one
|
|
2244
|
+
* backend-owned lifecycle. Skills are markdown documents containing
|
|
2245
|
+
* instructions that AI reads and follows when the skill is referenced in an
|
|
2246
|
+
* AI input.
|
|
2247
|
+
*/
|
|
2248
|
+
createSkillHandler(options) {
|
|
2249
|
+
return (options.client ?? this.client).post({
|
|
2250
|
+
url: "/documents/create_skill",
|
|
2251
|
+
...options,
|
|
2252
|
+
headers: {
|
|
2253
|
+
"Content-Type": "application/json",
|
|
2254
|
+
...options.headers
|
|
2255
|
+
}
|
|
2256
|
+
});
|
|
2257
|
+
}
|
|
2258
|
+
/**
|
|
2259
|
+
* Creates a snippet document with initialized markdown content in one
|
|
2260
|
+
* backend-owned lifecycle. Snippets are created personal; team sharing is
|
|
2261
|
+
* toggled separately via `PUT /documents/{document_id}/team_share`.
|
|
2262
|
+
*/
|
|
2263
|
+
createSnippetHandler(options) {
|
|
2264
|
+
return (options.client ?? this.client).post({
|
|
2265
|
+
url: "/documents/create_snippet",
|
|
2266
|
+
...options,
|
|
2267
|
+
headers: {
|
|
2268
|
+
"Content-Type": "application/json",
|
|
2269
|
+
...options.headers
|
|
2270
|
+
}
|
|
2271
|
+
});
|
|
2272
|
+
}
|
|
2273
|
+
/**
|
|
2274
|
+
* Creates a task document with properties and initialized markdown content in
|
|
2275
|
+
* one backend-owned lifecycle.
|
|
2276
|
+
*/
|
|
2277
|
+
createTaskHandler(options) {
|
|
2278
|
+
return (options.client ?? this.client).post({
|
|
2279
|
+
url: "/documents/create_task",
|
|
2280
|
+
...options,
|
|
2281
|
+
headers: {
|
|
2282
|
+
"Content-Type": "application/json",
|
|
2283
|
+
...options.headers
|
|
2284
|
+
}
|
|
2285
|
+
});
|
|
2286
|
+
}
|
|
2287
|
+
/**
|
|
2288
|
+
* Handler for `POST /documents/github_prs/tasks`.
|
|
2289
|
+
*
|
|
2290
|
+
* Returns the task documents each of up to 100 GitHub pull requests references, for the pull
|
|
2291
|
+
* requests the caller can see.
|
|
2292
|
+
*/
|
|
2293
|
+
getGithubPullRequestTasks(options) {
|
|
2294
|
+
return (options.client ?? this.client).post({
|
|
2295
|
+
url: "/documents/github_prs/tasks",
|
|
2296
|
+
...options,
|
|
2297
|
+
headers: {
|
|
2298
|
+
"Content-Type": "application/json",
|
|
2299
|
+
...options.headers
|
|
2300
|
+
}
|
|
2301
|
+
});
|
|
2302
|
+
}
|
|
2303
|
+
initializeUserDocuments(options) {
|
|
2304
|
+
return (options?.client ?? this.client).post({ url: "/documents/initialize_user_documents", ...options });
|
|
2305
|
+
}
|
|
2306
|
+
/**
|
|
2307
|
+
* Gets a list of all the user's documents so they are able to be searched on
|
|
2308
|
+
*/
|
|
2309
|
+
getDocumentListHandler(options) {
|
|
2310
|
+
return (options?.client ?? this.client).get({ url: "/documents/list", ...options });
|
|
2311
|
+
}
|
|
2312
|
+
/**
|
|
2313
|
+
* Validates the provided document permissions token
|
|
2314
|
+
*/
|
|
2315
|
+
validateDocumentPermissionsToken(options) {
|
|
2316
|
+
return (options.client ?? this.client).post({
|
|
2317
|
+
url: "/documents/permissions_token/validate",
|
|
2318
|
+
...options,
|
|
2319
|
+
headers: {
|
|
2320
|
+
"Content-Type": "application/json",
|
|
2321
|
+
...options.headers
|
|
2322
|
+
}
|
|
2323
|
+
});
|
|
2324
|
+
}
|
|
2325
|
+
/**
|
|
2326
|
+
* Generates a document permissions token for a provided document id
|
|
2327
|
+
*/
|
|
2328
|
+
getDocumentPermissionsToken(options) {
|
|
2329
|
+
return (options.client ?? this.client).post({ url: "/documents/permissions_token/{document_id}", ...options });
|
|
2330
|
+
}
|
|
2331
|
+
/**
|
|
2332
|
+
* Takes the docx document bom parts and generates presigned urls to upload
|
|
2333
|
+
* any new content
|
|
2334
|
+
*
|
|
2335
|
+
* @deprecated
|
|
2336
|
+
*/
|
|
2337
|
+
presaveDocumentHandler(options) {
|
|
2338
|
+
return (options.client ?? this.client).put({
|
|
2339
|
+
url: "/documents/presave/{document_id}",
|
|
2340
|
+
...options,
|
|
2341
|
+
headers: {
|
|
2342
|
+
"Content-Type": "application/json",
|
|
2343
|
+
...options.headers
|
|
2344
|
+
}
|
|
2345
|
+
});
|
|
2346
|
+
}
|
|
2347
|
+
getBatchPreviewHandler(options) {
|
|
2348
|
+
return (options.client ?? this.client).post({
|
|
2349
|
+
url: "/documents/preview",
|
|
2350
|
+
...options,
|
|
2351
|
+
headers: {
|
|
2352
|
+
"Content-Type": "application/json",
|
|
2353
|
+
...options.headers
|
|
2354
|
+
}
|
|
2355
|
+
});
|
|
2356
|
+
}
|
|
2357
|
+
/**
|
|
2358
|
+
* Handler for `GET /documents/slug/{slug}`.
|
|
2359
|
+
*
|
|
2360
|
+
* Returns document metadata, user access level, and view location.
|
|
2361
|
+
*/
|
|
2362
|
+
getDocumentByTeamSlug(options) {
|
|
2363
|
+
return (options.client ?? this.client).get({ url: "/documents/slug/{slug}", ...options });
|
|
2364
|
+
}
|
|
2365
|
+
/**
|
|
2366
|
+
* Resolves the current user's starter documents.
|
|
2367
|
+
*/
|
|
2368
|
+
handler(options) {
|
|
2369
|
+
return (options?.client ?? this.client).get({ url: "/documents/starter_docs", ...options });
|
|
2370
|
+
}
|
|
2371
|
+
/**
|
|
2372
|
+
* Lists the built-in system skills. System skills are static, code-defined
|
|
2373
|
+
* AI instructions (see the `system_skills` crate); they surface in the
|
|
2374
|
+
* skills menu and AI skill tools like user skills, but have no document
|
|
2375
|
+
* behind them, so clients must not offer to open them.
|
|
2376
|
+
*/
|
|
2377
|
+
getSystemSkillsHandler(options) {
|
|
2378
|
+
return (options?.client ?? this.client).get({ url: "/documents/system_skills", ...options });
|
|
2379
|
+
}
|
|
2380
|
+
/**
|
|
2381
|
+
* Handler for `DELETE /documents/{document_id}`.
|
|
2382
|
+
*
|
|
2383
|
+
* Soft-deletes a document (only owners can delete).
|
|
2384
|
+
*/
|
|
2385
|
+
deleteDocument(options) {
|
|
2386
|
+
return (options.client ?? this.client).delete({ url: "/documents/{document_id}", ...options });
|
|
2387
|
+
}
|
|
2388
|
+
/**
|
|
2389
|
+
* Handler for `GET /documents/{document_id}`.
|
|
2390
|
+
*
|
|
2391
|
+
* Returns document metadata, user access level, and view location.
|
|
2392
|
+
*/
|
|
2393
|
+
getDocument(options) {
|
|
2394
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}", ...options });
|
|
2395
|
+
}
|
|
2396
|
+
/**
|
|
2397
|
+
* Handler for `PATCH /documents/{document_id}`.
|
|
2398
|
+
*
|
|
2399
|
+
* Edits document metadata such as name or project, and modifies
|
|
2400
|
+
* the document's share permissions. Requires edit access to the document,
|
|
2401
|
+
* and edit access to the target project if moving the document.
|
|
2402
|
+
*/
|
|
2403
|
+
editDocument(options) {
|
|
2404
|
+
return (options.client ?? this.client).patch({
|
|
2405
|
+
url: "/documents/{document_id}",
|
|
2406
|
+
...options,
|
|
2407
|
+
headers: {
|
|
2408
|
+
"Content-Type": "application/json",
|
|
2409
|
+
...options.headers
|
|
2410
|
+
}
|
|
2411
|
+
});
|
|
2412
|
+
}
|
|
2413
|
+
/**
|
|
2414
|
+
* Creates a new version of a document
|
|
2415
|
+
*/
|
|
2416
|
+
saveDocumentHandler(options) {
|
|
2417
|
+
return (options.client ?? this.client).put({
|
|
2418
|
+
url: "/documents/{document_id}",
|
|
2419
|
+
...options,
|
|
2420
|
+
headers: {
|
|
2421
|
+
"Content-Type": "application/json",
|
|
2422
|
+
...options.headers
|
|
2423
|
+
}
|
|
2424
|
+
});
|
|
2425
|
+
}
|
|
2426
|
+
/**
|
|
2427
|
+
* Handler for `GET /documents/{document_id}/branch_name`.
|
|
2428
|
+
*
|
|
2429
|
+
* Returns the short UUID and git branch name for a task document.
|
|
2430
|
+
* Returns 400 if the document is not a task.
|
|
2431
|
+
*/
|
|
2432
|
+
getDocumentBranchName(options) {
|
|
2433
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/branch_name", ...options });
|
|
2434
|
+
}
|
|
2435
|
+
/**
|
|
2436
|
+
* Handler for `POST /documents/{document_id}/copy`.
|
|
2437
|
+
*
|
|
2438
|
+
* Copies an existing document, creating a new document with the same content.
|
|
2439
|
+
* Does not require re-uploading the document file.
|
|
2440
|
+
*/
|
|
2441
|
+
copyDocument(options) {
|
|
2442
|
+
return (options.client ?? this.client).post({
|
|
2443
|
+
url: "/documents/{document_id}/copy",
|
|
2444
|
+
...options,
|
|
2445
|
+
headers: {
|
|
2446
|
+
"Content-Type": "application/json",
|
|
2447
|
+
...options.headers
|
|
2448
|
+
}
|
|
2449
|
+
});
|
|
2450
|
+
}
|
|
2451
|
+
/**
|
|
2452
|
+
* Generates a presigned url to download the raw content of the document
|
|
2453
|
+
* For files with modification layers, they will not be applied in the downloaded file.
|
|
2454
|
+
*/
|
|
2455
|
+
exportDocument(options) {
|
|
2456
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/export", ...options });
|
|
2457
|
+
}
|
|
2458
|
+
/**
|
|
2459
|
+
* Handler for `GET /documents/{document_id}/github_prs`.
|
|
2460
|
+
*
|
|
2461
|
+
* Returns GitHub pull requests associated with a task document.
|
|
2462
|
+
* Returns 400 if the document is not a task.
|
|
2463
|
+
*/
|
|
2464
|
+
getDocumentGithubPullRequests(options) {
|
|
2465
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/github_prs", ...options });
|
|
2466
|
+
}
|
|
2467
|
+
/**
|
|
2468
|
+
* Gets the presigned url(s) for the document. aka location
|
|
1912
2469
|
*/
|
|
1913
2470
|
getLocationHandler(options) {
|
|
1914
2471
|
return (options.client ?? this.client).get({ url: "/documents/{document_id}/location", ...options });
|
|
@@ -1930,53 +2487,391 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1930
2487
|
/**
|
|
1931
2488
|
* Fetches the document pdf processing result for a given document id
|
|
1932
2489
|
*/
|
|
1933
|
-
getDocumentProcessingResult(options) {
|
|
1934
|
-
return (options.client ?? this.client).get({ url: "/documents/{document_id}/processing", ...options });
|
|
2490
|
+
getDocumentProcessingResult(options) {
|
|
2491
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/processing", ...options });
|
|
2492
|
+
}
|
|
2493
|
+
/**
|
|
2494
|
+
* Fetches the document processing result for a given document id and job id
|
|
2495
|
+
*/
|
|
2496
|
+
jobProcessingResultHandler(options) {
|
|
2497
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/processing/{job_id}", ...options });
|
|
2498
|
+
}
|
|
2499
|
+
/**
|
|
2500
|
+
* Deletes a specific document
|
|
2501
|
+
*/
|
|
2502
|
+
revertDeleteDocument(options) {
|
|
2503
|
+
return (options.client ?? this.client).put({ url: "/documents/{document_id}/revert_delete", ...options });
|
|
2504
|
+
}
|
|
2505
|
+
/**
|
|
2506
|
+
* Handler for `GET /documents/{document_id}/short_id`.
|
|
2507
|
+
*
|
|
2508
|
+
* Returns the short UUID for a document.
|
|
2509
|
+
*/
|
|
2510
|
+
getDocumentShortId(options) {
|
|
2511
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/short_id", ...options });
|
|
2512
|
+
}
|
|
2513
|
+
/**
|
|
2514
|
+
* For any file that isn't PDF or DOCX, use this endpoint for saving.
|
|
2515
|
+
* This endpoint will allow you to save the document by providing the file content as part of a multipart request. Use key 'file' along with the file bytes.
|
|
2516
|
+
* simple_save is different than the save_document endpoint because it does not return a presigned URL, Instead, it simply saves the file to S3 directly (and returns the document metadata).
|
|
2517
|
+
*/
|
|
2518
|
+
simpleSave(options) {
|
|
2519
|
+
return (options.client ?? this.client).put({ url: "/documents/{document_id}/simple_save", ...options });
|
|
2520
|
+
}
|
|
2521
|
+
/**
|
|
2522
|
+
* Gets the team-share state of a document. The team is resolved from the
|
|
2523
|
+
* document owner's team membership; `teamId` is omitted when the owner does
|
|
2524
|
+
* not belong to a team.
|
|
2525
|
+
*/
|
|
2526
|
+
getDocumentTeamShare(options) {
|
|
2527
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/team_share", ...options });
|
|
2528
|
+
}
|
|
2529
|
+
/**
|
|
2530
|
+
* Sets explicit team sharing. Requires a verified acting identity matching
|
|
2531
|
+
* the persisted document owner, not merely effective Edit or Owner access.
|
|
2532
|
+
* Initial enable defaults to Edit; repeated enable preserves the chosen level.
|
|
2533
|
+
* Clear removes only the managed direct grant, not inherited team access.
|
|
2534
|
+
*/
|
|
2535
|
+
setDocumentTeamShare(options) {
|
|
2536
|
+
return (options.client ?? this.client).put({
|
|
2537
|
+
url: "/documents/{document_id}/team_share",
|
|
2538
|
+
...options,
|
|
2539
|
+
headers: {
|
|
2540
|
+
"Content-Type": "application/json",
|
|
2541
|
+
...options.headers
|
|
2542
|
+
}
|
|
2543
|
+
});
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* Read current Markdown or extracted file text with the document's view receipt.
|
|
2547
|
+
*/
|
|
2548
|
+
getDocumentTextContent(options) {
|
|
2549
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/text-content", ...options });
|
|
2550
|
+
}
|
|
2551
|
+
/**
|
|
2552
|
+
* Gets the list of users who have viewed a given document
|
|
2553
|
+
*/
|
|
2554
|
+
getDocumentViewsHandler(options) {
|
|
2555
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/views", ...options });
|
|
2556
|
+
}
|
|
2557
|
+
/**
|
|
2558
|
+
* Gets a particular document by its id
|
|
2559
|
+
*/
|
|
2560
|
+
getDocumentVersion(options) {
|
|
2561
|
+
return (options.client ?? this.client).get({ url: "/documents/{document_id}/{document_version_id}", ...options });
|
|
2562
|
+
}
|
|
2563
|
+
/**
|
|
2564
|
+
* State access request state through the domain service.
|
|
2565
|
+
*/
|
|
2566
|
+
accessRequestsState(options) {
|
|
2567
|
+
return (options.client ?? this.client).get({ url: "/entities/{entity_type}/{entity_id}/access-requests", ...options });
|
|
2568
|
+
}
|
|
2569
|
+
/**
|
|
2570
|
+
* Cancel access request state through the domain service.
|
|
2571
|
+
*/
|
|
2572
|
+
accessRequestsCancel(options) {
|
|
2573
|
+
return (options.client ?? this.client).delete({ url: "/entities/{entity_type}/{entity_id}/access-requests/mine", ...options });
|
|
2574
|
+
}
|
|
2575
|
+
/**
|
|
2576
|
+
* Submit access request state through the domain service.
|
|
2577
|
+
*/
|
|
2578
|
+
accessRequestsSubmit(options) {
|
|
2579
|
+
return (options.client ?? this.client).put({
|
|
2580
|
+
url: "/entities/{entity_type}/{entity_id}/access-requests/mine",
|
|
2581
|
+
...options,
|
|
2582
|
+
headers: {
|
|
2583
|
+
"Content-Type": "application/json",
|
|
2584
|
+
...options.headers
|
|
2585
|
+
}
|
|
2586
|
+
});
|
|
2587
|
+
}
|
|
2588
|
+
/**
|
|
2589
|
+
* Resolve access request state through the domain service.
|
|
2590
|
+
*/
|
|
2591
|
+
accessRequestsResolve(options) {
|
|
2592
|
+
return (options.client ?? this.client).post({
|
|
2593
|
+
url: "/entities/{entity_type}/{entity_id}/access-requests/{request_id}/resolve",
|
|
2594
|
+
...options,
|
|
2595
|
+
headers: {
|
|
2596
|
+
"Content-Type": "application/json",
|
|
2597
|
+
...options.headers
|
|
2598
|
+
}
|
|
2599
|
+
});
|
|
2600
|
+
}
|
|
2601
|
+
/**
|
|
2602
|
+
* Direct access request state through the domain service.
|
|
2603
|
+
*/
|
|
2604
|
+
accessRequestsDirect(options) {
|
|
2605
|
+
return (options.client ?? this.client).get({ url: "/entities/{entity_type}/{entity_id}/direct-access", ...options });
|
|
2606
|
+
}
|
|
2607
|
+
/**
|
|
2608
|
+
* Remove direct access request state through the domain service.
|
|
2609
|
+
*/
|
|
2610
|
+
accessRequestsRemoveDirect(options) {
|
|
2611
|
+
return (options.client ?? this.client).delete({ url: "/entities/{entity_type}/{entity_id}/direct-access/{user_id}", ...options });
|
|
2612
|
+
}
|
|
2613
|
+
/**
|
|
2614
|
+
* Set direct access request state through the domain service.
|
|
2615
|
+
*/
|
|
2616
|
+
accessRequestsSetDirect(options) {
|
|
2617
|
+
return (options.client ?? this.client).put({
|
|
2618
|
+
url: "/entities/{entity_type}/{entity_id}/direct-access/{user_id}",
|
|
2619
|
+
...options,
|
|
2620
|
+
headers: {
|
|
2621
|
+
"Content-Type": "application/json",
|
|
2622
|
+
...options.headers
|
|
2623
|
+
}
|
|
2624
|
+
});
|
|
2625
|
+
}
|
|
2626
|
+
/**
|
|
2627
|
+
* Get the current user's permission for a given entity.
|
|
2628
|
+
*/
|
|
2629
|
+
getEntityPermission(options) {
|
|
2630
|
+
return (options.client ?? this.client).get({ url: "/entity/{entity_type}/{entity_id}/permissions", ...options });
|
|
2631
|
+
}
|
|
2632
|
+
/**
|
|
2633
|
+
* List the caller's favorites.
|
|
2634
|
+
*/
|
|
2635
|
+
listFavorites(options) {
|
|
2636
|
+
return (options?.client ?? this.client).get({ url: "/favorites", ...options });
|
|
2637
|
+
}
|
|
2638
|
+
/**
|
|
2639
|
+
* Favorite an entity in the caller's collection.
|
|
2640
|
+
*/
|
|
2641
|
+
addFavorite(options) {
|
|
2642
|
+
return (options.client ?? this.client).post({
|
|
2643
|
+
url: "/favorites",
|
|
2644
|
+
...options,
|
|
2645
|
+
headers: {
|
|
2646
|
+
"Content-Type": "application/json",
|
|
2647
|
+
...options.headers
|
|
2648
|
+
}
|
|
2649
|
+
});
|
|
2650
|
+
}
|
|
2651
|
+
/**
|
|
2652
|
+
* Persist a manual order for the caller's favorites.
|
|
2653
|
+
*/
|
|
2654
|
+
reorderFavorites(options) {
|
|
2655
|
+
return (options.client ?? this.client).patch({
|
|
2656
|
+
url: "/favorites/reorder",
|
|
2657
|
+
...options,
|
|
2658
|
+
headers: {
|
|
2659
|
+
"Content-Type": "application/json",
|
|
2660
|
+
...options.headers
|
|
2661
|
+
}
|
|
2662
|
+
});
|
|
2663
|
+
}
|
|
2664
|
+
/**
|
|
2665
|
+
* Remove a favorite by entity.
|
|
2666
|
+
*/
|
|
2667
|
+
removeFavoriteByEntity(options) {
|
|
2668
|
+
return (options.client ?? this.client).delete({ url: "/favorites/{entity_type}/{entity_id}", ...options });
|
|
2669
|
+
}
|
|
2670
|
+
/**
|
|
2671
|
+
* Get a visible foreign entity by the identifier its source system assigned.
|
|
2672
|
+
*
|
|
2673
|
+
* `foreign_entity_id` is a wildcard path segment: sources store slashes inside
|
|
2674
|
+
* the identifier, for example `owner/repo/pull/12`.
|
|
2675
|
+
*
|
|
2676
|
+
* Authorization matches the by-id route. Internal service callers see every
|
|
2677
|
+
* record; an authenticated user sees a record only when they have view access
|
|
2678
|
+
* to it, and records they cannot view are reported as `404` so the route never
|
|
2679
|
+
* reveals that a mapping exists. Bot tokens are not accepted here — they use
|
|
2680
|
+
* the by-id route, which mints a bot-scoped receipt.
|
|
2681
|
+
*/
|
|
2682
|
+
getForeignEntityBySource(options) {
|
|
2683
|
+
return (options.client ?? this.client).get({ url: "/foreign_entity/by_source/{source}/{foreign_entity_id}", ...options });
|
|
2684
|
+
}
|
|
2685
|
+
/**
|
|
2686
|
+
* Get a visible foreign entity by its internal ID.
|
|
2687
|
+
*/
|
|
2688
|
+
getForeignEntity(options) {
|
|
2689
|
+
return (options.client ?? this.client).get({ url: "/foreign_entity/{id}", ...options });
|
|
2690
|
+
}
|
|
2691
|
+
/**
|
|
2692
|
+
* The live forms over a database the caller can see, for the grid's chip
|
|
2693
|
+
* and the delete-table confirmation.
|
|
2694
|
+
*/
|
|
2695
|
+
listForms(options) {
|
|
2696
|
+
return (options.client ?? this.client).get({ url: "/forms", ...options });
|
|
2697
|
+
}
|
|
2698
|
+
/**
|
|
2699
|
+
* Create a form owned by the caller: over a new database named like it, or
|
|
2700
|
+
* over an existing table of a database the caller owns. Database Edit is
|
|
2701
|
+
* not enough to attach a form: the form's editors gain Edit on the
|
|
2702
|
+
* database through it.
|
|
2703
|
+
*/
|
|
2704
|
+
createForm(options) {
|
|
2705
|
+
return (options.client ?? this.client).post({
|
|
2706
|
+
url: "/forms",
|
|
2707
|
+
...options,
|
|
2708
|
+
headers: {
|
|
2709
|
+
"Content-Type": "application/json",
|
|
2710
|
+
...options.headers
|
|
2711
|
+
}
|
|
2712
|
+
});
|
|
2713
|
+
}
|
|
2714
|
+
/**
|
|
2715
|
+
* Every live form the caller holds a grant on, newest first, with their
|
|
2716
|
+
* level: what Drive and Quick Access list. Public forms reached only by
|
|
2717
|
+
* their link are not listed.
|
|
2718
|
+
*/
|
|
2719
|
+
listAccessibleForms(options) {
|
|
2720
|
+
return (options?.client ?? this.client).get({ url: "/forms/accessible", ...options });
|
|
2721
|
+
}
|
|
2722
|
+
/**
|
|
2723
|
+
* A form with its layout, each question joined with its column's title,
|
|
2724
|
+
* type and options. Never rows. Readable by anyone when the form is public.
|
|
2725
|
+
*/
|
|
2726
|
+
getForm(options) {
|
|
2727
|
+
return (options.client ?? this.client).get({ url: "/forms/{id}", ...options });
|
|
2728
|
+
}
|
|
2729
|
+
/**
|
|
2730
|
+
* Change a form's facts. The description and confirmation message take
|
|
2731
|
+
* edit; who responds, open or closed, the closing time and tallies take
|
|
2732
|
+
* its owner.
|
|
2733
|
+
*/
|
|
2734
|
+
updateForm(options) {
|
|
2735
|
+
return (options.client ?? this.client).patch({
|
|
2736
|
+
url: "/forms/{id}",
|
|
2737
|
+
...options,
|
|
2738
|
+
headers: {
|
|
2739
|
+
"Content-Type": "application/json",
|
|
2740
|
+
...options.headers
|
|
2741
|
+
}
|
|
2742
|
+
});
|
|
2743
|
+
}
|
|
2744
|
+
/**
|
|
2745
|
+
* Open the editor-only collaborative layout, or publish its latest valid
|
|
2746
|
+
* revision. Content stays in the existing collaboration surface.
|
|
2747
|
+
*/
|
|
2748
|
+
collaborateForm(options) {
|
|
2749
|
+
return (options.client ?? this.client).post({ url: "/forms/{id}/collaboration", ...options });
|
|
2750
|
+
}
|
|
2751
|
+
/**
|
|
2752
|
+
* Save a validated replacement in the shared layout and report publication.
|
|
2753
|
+
* A 200 response with `publicationError` means the draft is saved, while
|
|
2754
|
+
* respondents still see `detail`. Retrying collaboration retries publication.
|
|
2755
|
+
*/
|
|
2756
|
+
putFormLayout(options) {
|
|
2757
|
+
return (options.client ?? this.client).put({
|
|
2758
|
+
url: "/forms/{id}/layout",
|
|
2759
|
+
...options,
|
|
2760
|
+
headers: {
|
|
2761
|
+
"Content-Type": "application/json",
|
|
2762
|
+
...options.headers
|
|
2763
|
+
}
|
|
2764
|
+
});
|
|
2765
|
+
}
|
|
2766
|
+
/**
|
|
2767
|
+
* A form's recipients, for its owner. Link and team sharing are always
|
|
2768
|
+
* `null`: a form's public audience is its own setting.
|
|
2769
|
+
*/
|
|
2770
|
+
getFormPermissions(options) {
|
|
2771
|
+
return (options.client ?? this.client).get({ url: "/forms/{id}/permissions", ...options });
|
|
2772
|
+
}
|
|
2773
|
+
/**
|
|
2774
|
+
* Change a form's channel recipients, for its owner. Turning on link or
|
|
2775
|
+
* team sharing is refused.
|
|
2776
|
+
*/
|
|
2777
|
+
updateFormPermissions(options) {
|
|
2778
|
+
return (options.client ?? this.client).patch({
|
|
2779
|
+
url: "/forms/{id}/permissions",
|
|
2780
|
+
...options,
|
|
2781
|
+
headers: {
|
|
2782
|
+
"Content-Type": "application/json",
|
|
2783
|
+
...options.headers
|
|
2784
|
+
}
|
|
2785
|
+
});
|
|
2786
|
+
}
|
|
2787
|
+
/**
|
|
2788
|
+
* Respond to a form. A gate that stops the response answers `stopped` and
|
|
2789
|
+
* writes nothing to the table. A public form takes anonymous responses.
|
|
2790
|
+
*/
|
|
2791
|
+
submitFormResponse(options) {
|
|
2792
|
+
return (options.client ?? this.client).post({
|
|
2793
|
+
url: "/forms/{id}/responses",
|
|
2794
|
+
...options,
|
|
2795
|
+
headers: {
|
|
2796
|
+
"Content-Type": "application/json",
|
|
2797
|
+
...options.headers
|
|
2798
|
+
}
|
|
2799
|
+
});
|
|
2800
|
+
}
|
|
2801
|
+
/**
|
|
2802
|
+
* The signed-in caller's own response, with the row's current cells.
|
|
2803
|
+
*/
|
|
2804
|
+
getMyFormResponse(options) {
|
|
2805
|
+
return (options.client ?? this.client).get({ url: "/forms/{id}/responses/mine", ...options });
|
|
2806
|
+
}
|
|
2807
|
+
/**
|
|
2808
|
+
* Replace the signed-in caller's answers while the form is open. A gate
|
|
2809
|
+
* that stops the edit leaves the saved response as it was.
|
|
2810
|
+
*/
|
|
2811
|
+
editMyFormResponse(options) {
|
|
2812
|
+
return (options.client ?? this.client).put({
|
|
2813
|
+
url: "/forms/{id}/responses/mine",
|
|
2814
|
+
...options,
|
|
2815
|
+
headers: {
|
|
2816
|
+
"Content-Type": "application/json",
|
|
2817
|
+
...options.headers
|
|
2818
|
+
}
|
|
2819
|
+
});
|
|
2820
|
+
}
|
|
2821
|
+
/**
|
|
2822
|
+
* Response counts for the form's editors.
|
|
2823
|
+
*/
|
|
2824
|
+
getFormResponseSummary(options) {
|
|
2825
|
+
return (options.client ?? this.client).get({ url: "/forms/{id}/responses/summary", ...options });
|
|
2826
|
+
}
|
|
2827
|
+
/**
|
|
2828
|
+
* Option counts of the form's choice questions: for respondents when the
|
|
2829
|
+
* owner shows them, for editors always.
|
|
2830
|
+
*/
|
|
2831
|
+
getFormTally(options) {
|
|
2832
|
+
return (options.client ?? this.client).get({ url: "/forms/{id}/tally", ...options });
|
|
1935
2833
|
}
|
|
1936
2834
|
/**
|
|
1937
|
-
*
|
|
2835
|
+
* Redirects an authenticated user to the github sync app installation page.
|
|
1938
2836
|
*/
|
|
1939
|
-
|
|
1940
|
-
return (options
|
|
2837
|
+
installSync(options) {
|
|
2838
|
+
return (options?.client ?? this.client).get({ url: "/github/install-sync", ...options });
|
|
1941
2839
|
}
|
|
1942
2840
|
/**
|
|
1943
|
-
*
|
|
2841
|
+
* List the repositories and authors among the GitHub pull requests visible to the caller.
|
|
1944
2842
|
*/
|
|
1945
|
-
|
|
1946
|
-
return (options
|
|
2843
|
+
getGithubPullRequestFacets(options) {
|
|
2844
|
+
return (options?.client ?? this.client).get({ url: "/github_pull_requests/facets", ...options });
|
|
1947
2845
|
}
|
|
1948
2846
|
/**
|
|
1949
|
-
*
|
|
1950
|
-
*
|
|
1951
|
-
* Returns the short UUID for a document.
|
|
2847
|
+
* Get the pull request behind a foreign entity record the caller can view.
|
|
1952
2848
|
*/
|
|
1953
|
-
|
|
1954
|
-
return (options.client ?? this.client).get({ url: "/
|
|
2849
|
+
getGithubPullRequest(options) {
|
|
2850
|
+
return (options.client ?? this.client).get({ url: "/github_pull_requests/{id}", ...options });
|
|
1955
2851
|
}
|
|
1956
2852
|
/**
|
|
1957
|
-
*
|
|
1958
|
-
* This endpoint will allow you to save the document by providing the file content as part of a multipart request. Use key 'file' along with the file bytes.
|
|
1959
|
-
* simple_save is different than the save_document endpoint because it does not return a presigned URL, Instead, it simply saves the file to S3 directly (and returns the document metadata).
|
|
2853
|
+
* Get the changes of the pull request behind a foreign entity record the caller can view.
|
|
1960
2854
|
*/
|
|
1961
|
-
|
|
1962
|
-
return (options.client ?? this.client).
|
|
2855
|
+
getGithubPullRequestChanges(options) {
|
|
2856
|
+
return (options.client ?? this.client).get({ url: "/github_pull_requests/{id}/changes", ...options });
|
|
1963
2857
|
}
|
|
1964
2858
|
/**
|
|
1965
|
-
*
|
|
1966
|
-
*
|
|
1967
|
-
* not belong to a team.
|
|
2859
|
+
* Get the patch of changes of the pull request behind a foreign entity record the caller can
|
|
2860
|
+
* view.
|
|
1968
2861
|
*/
|
|
1969
|
-
|
|
1970
|
-
return (options.client ?? this.client).get({ url: "/
|
|
2862
|
+
getGithubPullRequestChangesPatch(options) {
|
|
2863
|
+
return (options.client ?? this.client).get({ url: "/github_pull_requests/{id}/changes/patch", ...options });
|
|
1971
2864
|
}
|
|
1972
2865
|
/**
|
|
1973
|
-
*
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
2866
|
+
* Handler for `POST /harness-pairings`.
|
|
2867
|
+
*
|
|
2868
|
+
* Unauthenticated by design: the daemon has no credential yet - obtaining one
|
|
2869
|
+
* is the point. The pairing releases nothing until a signed-in user approves
|
|
2870
|
+
* it, and creation is throttled in the domain service.
|
|
1976
2871
|
*/
|
|
1977
|
-
|
|
1978
|
-
return (options.client ?? this.client).
|
|
1979
|
-
url: "/
|
|
2872
|
+
createHarnessPairing(options) {
|
|
2873
|
+
return (options.client ?? this.client).post({
|
|
2874
|
+
url: "/harness-pairings",
|
|
1980
2875
|
...options,
|
|
1981
2876
|
headers: {
|
|
1982
2877
|
"Content-Type": "application/json",
|
|
@@ -1985,35 +2880,17 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
1985
2880
|
});
|
|
1986
2881
|
}
|
|
1987
2882
|
/**
|
|
1988
|
-
*
|
|
1989
|
-
*/
|
|
1990
|
-
getDocumentViewsHandler(options) {
|
|
1991
|
-
return (options.client ?? this.client).get({ url: "/documents/{document_id}/views", ...options });
|
|
1992
|
-
}
|
|
1993
|
-
/**
|
|
1994
|
-
* Gets a particular document by its id
|
|
1995
|
-
*/
|
|
1996
|
-
getDocumentVersion(options) {
|
|
1997
|
-
return (options.client ?? this.client).get({ url: "/documents/{document_id}/{document_version_id}", ...options });
|
|
1998
|
-
}
|
|
1999
|
-
/**
|
|
2000
|
-
* Get the current user's permission for a given entity.
|
|
2001
|
-
*/
|
|
2002
|
-
getEntityPermission(options) {
|
|
2003
|
-
return (options.client ?? this.client).get({ url: "/entity/{entity_type}/{entity_id}/permissions", ...options });
|
|
2004
|
-
}
|
|
2005
|
-
/**
|
|
2006
|
-
* List the caller's favorites.
|
|
2883
|
+
* Handler for `GET /harness-pairings/{code}`.
|
|
2007
2884
|
*/
|
|
2008
|
-
|
|
2009
|
-
return (options
|
|
2885
|
+
getHarnessPairing(options) {
|
|
2886
|
+
return (options.client ?? this.client).get({ url: "/harness-pairings/{code}", ...options });
|
|
2010
2887
|
}
|
|
2011
2888
|
/**
|
|
2012
|
-
*
|
|
2889
|
+
* Handler for `POST /harness-pairings/{code}/approve`.
|
|
2013
2890
|
*/
|
|
2014
|
-
|
|
2891
|
+
approveHarnessPairing(options) {
|
|
2015
2892
|
return (options.client ?? this.client).post({
|
|
2016
|
-
url: "/
|
|
2893
|
+
url: "/harness-pairings/{code}/approve",
|
|
2017
2894
|
...options,
|
|
2018
2895
|
headers: {
|
|
2019
2896
|
"Content-Type": "application/json",
|
|
@@ -2022,11 +2899,15 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2022
2899
|
});
|
|
2023
2900
|
}
|
|
2024
2901
|
/**
|
|
2025
|
-
*
|
|
2902
|
+
* Handler for `POST /harness-pairings/{pairing_id}/claim`.
|
|
2903
|
+
*
|
|
2904
|
+
* Unauthenticated like pairing creation; the device secret minted alongside
|
|
2905
|
+
* the pairing is the credential, and the pairing id (not the short user
|
|
2906
|
+
* code) addresses it.
|
|
2026
2907
|
*/
|
|
2027
|
-
|
|
2028
|
-
return (options.client ?? this.client).
|
|
2029
|
-
url: "/
|
|
2908
|
+
claimHarnessPairing(options) {
|
|
2909
|
+
return (options.client ?? this.client).post({
|
|
2910
|
+
url: "/harness-pairings/{pairing_id}/claim",
|
|
2030
2911
|
...options,
|
|
2031
2912
|
headers: {
|
|
2032
2913
|
"Content-Type": "application/json",
|
|
@@ -2035,22 +2916,42 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2035
2916
|
});
|
|
2036
2917
|
}
|
|
2037
2918
|
/**
|
|
2038
|
-
*
|
|
2919
|
+
* Handler for `GET /harnesses`.
|
|
2039
2920
|
*/
|
|
2040
|
-
|
|
2041
|
-
return (options
|
|
2921
|
+
listHarnesses(options) {
|
|
2922
|
+
return (options?.client ?? this.client).get({ url: "/harnesses", ...options });
|
|
2042
2923
|
}
|
|
2043
2924
|
/**
|
|
2044
|
-
*
|
|
2925
|
+
* Handler for `DELETE /harnesses/me`.
|
|
2926
|
+
*
|
|
2927
|
+
* A daemon retiring itself: the valid credential is the authorization.
|
|
2045
2928
|
*/
|
|
2046
|
-
|
|
2047
|
-
return (options
|
|
2929
|
+
deleteSelfHarness(options) {
|
|
2930
|
+
return (options?.client ?? this.client).delete({ url: "/harnesses/me", ...options });
|
|
2048
2931
|
}
|
|
2049
2932
|
/**
|
|
2050
|
-
*
|
|
2933
|
+
* Handler for `GET /harnesses/me`.
|
|
2051
2934
|
*/
|
|
2052
|
-
|
|
2053
|
-
return (options?.client ?? this.client).get({ url: "/
|
|
2935
|
+
getSelfHarness(options) {
|
|
2936
|
+
return (options?.client ?? this.client).get({ url: "/harnesses/me", ...options });
|
|
2937
|
+
}
|
|
2938
|
+
/**
|
|
2939
|
+
* Handler for `GET /harnesses/me/agents`.
|
|
2940
|
+
*/
|
|
2941
|
+
listHarnessAgents(options) {
|
|
2942
|
+
return (options?.client ?? this.client).get({ url: "/harnesses/me/agents", ...options });
|
|
2943
|
+
}
|
|
2944
|
+
/**
|
|
2945
|
+
* Handler for `GET /harnesses/me/sessions`.
|
|
2946
|
+
*/
|
|
2947
|
+
listHarnessSessions(options) {
|
|
2948
|
+
return (options?.client ?? this.client).get({ url: "/harnesses/me/sessions", ...options });
|
|
2949
|
+
}
|
|
2950
|
+
/**
|
|
2951
|
+
* Handler for `DELETE /harnesses/{harness_id}`.
|
|
2952
|
+
*/
|
|
2953
|
+
deleteHarness(options) {
|
|
2954
|
+
return (options.client ?? this.client).delete({ url: "/harnesses/{harness_id}", ...options });
|
|
2054
2955
|
}
|
|
2055
2956
|
/**
|
|
2056
2957
|
* Health check
|
|
@@ -2076,6 +2977,50 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2076
2977
|
upsertHistoryHandler(options) {
|
|
2077
2978
|
return (options.client ?? this.client).post({ url: "/history/{item_type}/{item_id}", ...options });
|
|
2078
2979
|
}
|
|
2980
|
+
/**
|
|
2981
|
+
* List initiatives the caller can view.
|
|
2982
|
+
*/
|
|
2983
|
+
listInitiatives(options) {
|
|
2984
|
+
return (options?.client ?? this.client).get({ url: "/initiatives", ...options });
|
|
2985
|
+
}
|
|
2986
|
+
/**
|
|
2987
|
+
* Create an initiative owned by the caller.
|
|
2988
|
+
*/
|
|
2989
|
+
createInitiative(options) {
|
|
2990
|
+
return (options.client ?? this.client).post({
|
|
2991
|
+
url: "/initiatives",
|
|
2992
|
+
...options,
|
|
2993
|
+
headers: {
|
|
2994
|
+
"Content-Type": "application/json",
|
|
2995
|
+
...options.headers
|
|
2996
|
+
}
|
|
2997
|
+
});
|
|
2998
|
+
}
|
|
2999
|
+
/**
|
|
3000
|
+
* Delete the initiative the caller owns.
|
|
3001
|
+
*/
|
|
3002
|
+
deleteInitiative(options) {
|
|
3003
|
+
return (options.client ?? this.client).delete({ url: "/initiatives/{initiative_id}", ...options });
|
|
3004
|
+
}
|
|
3005
|
+
/**
|
|
3006
|
+
* Fetch one initiative the caller can view.
|
|
3007
|
+
*/
|
|
3008
|
+
getInitiative(options) {
|
|
3009
|
+
return (options.client ?? this.client).get({ url: "/initiatives/{initiative_id}", ...options });
|
|
3010
|
+
}
|
|
3011
|
+
/**
|
|
3012
|
+
* Update fields the caller can edit.
|
|
3013
|
+
*/
|
|
3014
|
+
updateInitiative(options) {
|
|
3015
|
+
return (options.client ?? this.client).patch({
|
|
3016
|
+
url: "/initiatives/{initiative_id}",
|
|
3017
|
+
...options,
|
|
3018
|
+
headers: {
|
|
3019
|
+
"Content-Type": "application/json",
|
|
3020
|
+
...options.headers
|
|
3021
|
+
}
|
|
3022
|
+
});
|
|
3023
|
+
}
|
|
2079
3024
|
/**
|
|
2080
3025
|
* Gets the instructions document for the current user
|
|
2081
3026
|
*/
|
|
@@ -2133,6 +3078,113 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2133
3078
|
}
|
|
2134
3079
|
});
|
|
2135
3080
|
}
|
|
3081
|
+
/**
|
|
3082
|
+
* Read a bounded timeline with lazy thread previews.
|
|
3083
|
+
*/
|
|
3084
|
+
messageTimeline(options) {
|
|
3085
|
+
return (options.client ?? this.client).get({ url: "/messages/{parent_type}/{parent_id}", ...options });
|
|
3086
|
+
}
|
|
3087
|
+
/**
|
|
3088
|
+
* Create a root message or reply.
|
|
3089
|
+
*/
|
|
3090
|
+
entityMessageCreate(options) {
|
|
3091
|
+
return (options.client ?? this.client).post({
|
|
3092
|
+
url: "/messages/{parent_type}/{parent_id}",
|
|
3093
|
+
...options,
|
|
3094
|
+
headers: {
|
|
3095
|
+
"Content-Type": "application/json",
|
|
3096
|
+
...options.headers
|
|
3097
|
+
}
|
|
3098
|
+
});
|
|
3099
|
+
}
|
|
3100
|
+
/**
|
|
3101
|
+
* Tombstone one message; deleting a discussion's root deletes the discussion.
|
|
3102
|
+
*/
|
|
3103
|
+
entityMessageDeleteMessage(options) {
|
|
3104
|
+
return (options.client ?? this.client).delete({ url: "/messages/{parent_type}/{parent_id}/items/{id}", ...options });
|
|
3105
|
+
}
|
|
3106
|
+
/**
|
|
3107
|
+
* Resolve a message within its parent.
|
|
3108
|
+
*/
|
|
3109
|
+
entityMessageGetMessage(options) {
|
|
3110
|
+
return (options.client ?? this.client).get({ url: "/messages/{parent_type}/{parent_id}/items/{id}", ...options });
|
|
3111
|
+
}
|
|
3112
|
+
/**
|
|
3113
|
+
* Edit an owned message.
|
|
3114
|
+
*/
|
|
3115
|
+
entityMessageEdit(options) {
|
|
3116
|
+
return (options.client ?? this.client).patch({
|
|
3117
|
+
url: "/messages/{parent_type}/{parent_id}/items/{id}",
|
|
3118
|
+
...options,
|
|
3119
|
+
headers: {
|
|
3120
|
+
"Content-Type": "application/json",
|
|
3121
|
+
...options.headers
|
|
3122
|
+
}
|
|
3123
|
+
});
|
|
3124
|
+
}
|
|
3125
|
+
/**
|
|
3126
|
+
* Change the caller's reaction.
|
|
3127
|
+
*/
|
|
3128
|
+
entityMessageReact(options) {
|
|
3129
|
+
return (options.client ?? this.client).post({
|
|
3130
|
+
url: "/messages/{parent_type}/{parent_id}/items/{id}/reactions",
|
|
3131
|
+
...options,
|
|
3132
|
+
headers: {
|
|
3133
|
+
"Content-Type": "application/json",
|
|
3134
|
+
...options.headers
|
|
3135
|
+
}
|
|
3136
|
+
});
|
|
3137
|
+
}
|
|
3138
|
+
/**
|
|
3139
|
+
* Resolve an old link under current parent permissions.
|
|
3140
|
+
*/
|
|
3141
|
+
entityMessageLegacy(options) {
|
|
3142
|
+
return (options.client ?? this.client).get({ url: "/messages/{parent_type}/{parent_id}/legacy/{legacy_id}", ...options });
|
|
3143
|
+
}
|
|
3144
|
+
/**
|
|
3145
|
+
* Explicitly remove a discussion.
|
|
3146
|
+
*/
|
|
3147
|
+
entityMessageDeleteThread(options) {
|
|
3148
|
+
return (options.client ?? this.client).delete({ url: "/messages/{parent_type}/{parent_id}/threads/{id}", ...options });
|
|
3149
|
+
}
|
|
3150
|
+
/**
|
|
3151
|
+
* Open a specific discussion from a link or annotation.
|
|
3152
|
+
*/
|
|
3153
|
+
entityMessageGetThread(options) {
|
|
3154
|
+
return (options.client ?? this.client).get({ url: "/messages/{parent_type}/{parent_id}/threads/{id}", ...options });
|
|
3155
|
+
}
|
|
3156
|
+
/**
|
|
3157
|
+
* Update a discussion's lifecycle and placement.
|
|
3158
|
+
*/
|
|
3159
|
+
entityMessagePatchThread(options) {
|
|
3160
|
+
return (options.client ?? this.client).patch({
|
|
3161
|
+
url: "/messages/{parent_type}/{parent_id}/threads/{id}",
|
|
3162
|
+
...options,
|
|
3163
|
+
headers: {
|
|
3164
|
+
"Content-Type": "application/json",
|
|
3165
|
+
...options.headers
|
|
3166
|
+
}
|
|
3167
|
+
});
|
|
3168
|
+
}
|
|
3169
|
+
/**
|
|
3170
|
+
* Read a bounded window of messages and the parent's activity, ordered by the server.
|
|
3171
|
+
*/
|
|
3172
|
+
messageTimelineEntries(options) {
|
|
3173
|
+
return (options.client ?? this.client).get({ url: "/messages/{parent_type}/{parent_id}/timeline", ...options });
|
|
3174
|
+
}
|
|
3175
|
+
/**
|
|
3176
|
+
* Broadcast typing within an authorized discussion.
|
|
3177
|
+
*/
|
|
3178
|
+
entityMessageTyping(options) {
|
|
3179
|
+
return (options.client ?? this.client).post({
|
|
3180
|
+
url: "/messages/{parent_type}/{parent_id}/typing",
|
|
3181
|
+
...options,
|
|
3182
|
+
headers: {
|
|
3183
|
+
"Content-Type": "application/json",
|
|
3184
|
+
...options.headers
|
|
3185
|
+
}
|
|
3186
|
+
});
|
|
3187
|
+
}
|
|
2136
3188
|
/**
|
|
2137
3189
|
* Gets the users pinned items
|
|
2138
3190
|
*/
|
|
@@ -2291,42 +3343,23 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2291
3343
|
return (options?.client ?? this.client).get({ url: "/recents/deleted", ...options });
|
|
2292
3344
|
}
|
|
2293
3345
|
/**
|
|
2294
|
-
* List
|
|
2295
|
-
*/
|
|
2296
|
-
listReminders(options) {
|
|
2297
|
-
return (options?.client ?? this.client).get({ url: "/reminders", ...options });
|
|
2298
|
-
}
|
|
2299
|
-
/**
|
|
2300
|
-
* Create a reminder, optionally attached to an entity the caller can view.
|
|
2301
|
-
*/
|
|
2302
|
-
createReminder(options) {
|
|
2303
|
-
return (options.client ?? this.client).post({
|
|
2304
|
-
url: "/reminders",
|
|
2305
|
-
...options,
|
|
2306
|
-
headers: {
|
|
2307
|
-
"Content-Type": "application/json",
|
|
2308
|
-
...options.headers
|
|
2309
|
-
}
|
|
2310
|
-
});
|
|
2311
|
-
}
|
|
2312
|
-
/**
|
|
2313
|
-
* Delete one of the caller's reminders.
|
|
3346
|
+
* List original email threads with caller-private reminder work.
|
|
2314
3347
|
*/
|
|
2315
|
-
|
|
2316
|
-
return (options
|
|
3348
|
+
listEmailReminders(options) {
|
|
3349
|
+
return (options?.client ?? this.client).get({ url: "/reminders/email/collection", ...options });
|
|
2317
3350
|
}
|
|
2318
3351
|
/**
|
|
2319
|
-
*
|
|
3352
|
+
* Read an email follow-up and reconcile inbound reply cancellation.
|
|
2320
3353
|
*/
|
|
2321
|
-
|
|
2322
|
-
return (options.client ?? this.client).get({ url: "/reminders/{
|
|
3354
|
+
getEmailFollowup(options) {
|
|
3355
|
+
return (options.client ?? this.client).get({ url: "/reminders/email/{thread_id}", ...options });
|
|
2323
3356
|
}
|
|
2324
3357
|
/**
|
|
2325
|
-
*
|
|
3358
|
+
* Schedule, edit or remove one email follow-up as an idempotent operation.
|
|
2326
3359
|
*/
|
|
2327
|
-
|
|
2328
|
-
return (options.client ?? this.client).
|
|
2329
|
-
url: "/reminders/{
|
|
3360
|
+
setEmailFollowup(options) {
|
|
3361
|
+
return (options.client ?? this.client).put({
|
|
3362
|
+
url: "/reminders/email/{thread_id}",
|
|
2330
3363
|
...options,
|
|
2331
3364
|
headers: {
|
|
2332
3365
|
"Content-Type": "application/json",
|
|
@@ -2370,6 +3403,74 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2370
3403
|
}
|
|
2371
3404
|
});
|
|
2372
3405
|
}
|
|
3406
|
+
/**
|
|
3407
|
+
* List this administrator's team receipts, effective server limits and source binding.
|
|
3408
|
+
*/
|
|
3409
|
+
listSlackImports(options) {
|
|
3410
|
+
return (options?.client ?? this.client).get({ url: "/slack/imports", ...options });
|
|
3411
|
+
}
|
|
3412
|
+
/**
|
|
3413
|
+
* Create or replay a job using a scoped idempotency token and full selected metadata.
|
|
3414
|
+
* Missing creation timestamps and unknown message counts are represented as null.
|
|
3415
|
+
*/
|
|
3416
|
+
createSlackImport(options) {
|
|
3417
|
+
return (options.client ?? this.client).post({
|
|
3418
|
+
url: "/slack/imports",
|
|
3419
|
+
...options,
|
|
3420
|
+
headers: {
|
|
3421
|
+
"Content-Type": "application/json",
|
|
3422
|
+
...options.headers
|
|
3423
|
+
}
|
|
3424
|
+
});
|
|
3425
|
+
}
|
|
3426
|
+
/**
|
|
3427
|
+
* Read sanitized progress; foreign jobs are indistinguishable from missing jobs.
|
|
3428
|
+
*/
|
|
3429
|
+
getSlackImport(options) {
|
|
3430
|
+
return (options.client ?? this.client).get({ url: "/slack/imports/{job_id}", ...options });
|
|
3431
|
+
}
|
|
3432
|
+
/**
|
|
3433
|
+
* Stop unclaimed work. Active leases may settle; cancellation does not roll back history.
|
|
3434
|
+
*/
|
|
3435
|
+
cancelSlackImport(options) {
|
|
3436
|
+
return (options.client ?? this.client).post({ url: "/slack/imports/{job_id}/cancel", ...options });
|
|
3437
|
+
}
|
|
3438
|
+
/**
|
|
3439
|
+
* Close registration idempotently; never-ready conversations are skipped, not queued work.
|
|
3440
|
+
*/
|
|
3441
|
+
finalizeSlackImport(options) {
|
|
3442
|
+
return (options.client ?? this.client).post({ url: "/slack/imports/{job_id}/finalize", ...options });
|
|
3443
|
+
}
|
|
3444
|
+
/**
|
|
3445
|
+
* Issue short-lived, checksum/length-bound, create-only PUT grants. Do not log or persist URLs.
|
|
3446
|
+
* Retry a PUT returning 412 by completing/verifying the existing object, not overwriting it.
|
|
3447
|
+
*/
|
|
3448
|
+
registerSlackImportUploads(options) {
|
|
3449
|
+
return (options.client ?? this.client).post({
|
|
3450
|
+
url: "/slack/imports/{job_id}/uploads",
|
|
3451
|
+
...options,
|
|
3452
|
+
headers: {
|
|
3453
|
+
"Content-Type": "application/json",
|
|
3454
|
+
...options.headers
|
|
3455
|
+
}
|
|
3456
|
+
});
|
|
3457
|
+
}
|
|
3458
|
+
/**
|
|
3459
|
+
* Verify storage checksums and lengths for registered objects. A seal fixes the ENTIRE
|
|
3460
|
+
* descriptor set (contiguous indices, sizes and hashes), not just this completion batch.
|
|
3461
|
+
* Empty uploads with a zero-part seal support shape-only or empty-history imports.
|
|
3462
|
+
* Work becomes ready only after verified users metadata, a seal and every required part.
|
|
3463
|
+
*/
|
|
3464
|
+
completeSlackImportUploads(options) {
|
|
3465
|
+
return (options.client ?? this.client).post({
|
|
3466
|
+
url: "/slack/imports/{job_id}/uploads/complete",
|
|
3467
|
+
...options,
|
|
3468
|
+
headers: {
|
|
3469
|
+
"Content-Type": "application/json",
|
|
3470
|
+
...options.headers
|
|
3471
|
+
}
|
|
3472
|
+
});
|
|
3473
|
+
}
|
|
2373
3474
|
bulkWakeupSyncServiceDocuments(options) {
|
|
2374
3475
|
return (options.client ?? this.client).post({
|
|
2375
3476
|
url: "/sync_service/wakeup",
|
|
@@ -2393,6 +3494,31 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2393
3494
|
}
|
|
2394
3495
|
});
|
|
2395
3496
|
}
|
|
3497
|
+
/**
|
|
3498
|
+
* List the caller's API keys.
|
|
3499
|
+
*/
|
|
3500
|
+
listUserApiKeys(options) {
|
|
3501
|
+
return (options?.client ?? this.client).get({ url: "/user-api-keys", ...options });
|
|
3502
|
+
}
|
|
3503
|
+
/**
|
|
3504
|
+
* Mint a new API key for the caller.
|
|
3505
|
+
*/
|
|
3506
|
+
createUserApiKey(options) {
|
|
3507
|
+
return (options.client ?? this.client).post({
|
|
3508
|
+
url: "/user-api-keys",
|
|
3509
|
+
...options,
|
|
3510
|
+
headers: {
|
|
3511
|
+
"Content-Type": "application/json",
|
|
3512
|
+
...options.headers
|
|
3513
|
+
}
|
|
3514
|
+
});
|
|
3515
|
+
}
|
|
3516
|
+
/**
|
|
3517
|
+
* Delete one of the caller's API keys.
|
|
3518
|
+
*/
|
|
3519
|
+
deleteUserApiKey(options) {
|
|
3520
|
+
return (options.client ?? this.client).delete({ url: "/user-api-keys/{id}", ...options });
|
|
3521
|
+
}
|
|
2396
3522
|
/**
|
|
2397
3523
|
* Deletes a document location for the user
|
|
2398
3524
|
*/
|
|
@@ -2434,6 +3560,12 @@ var Sdk = class _Sdk extends HeyApiClient {
|
|
|
2434
3560
|
}
|
|
2435
3561
|
});
|
|
2436
3562
|
}
|
|
3563
|
+
/**
|
|
3564
|
+
* Stream matching broker events to the caller over Server-Sent Events.
|
|
3565
|
+
*/
|
|
3566
|
+
streamEvents(options) {
|
|
3567
|
+
return (options.client ?? this.client).sse.get({ url: "/webhook/events/stream", ...options });
|
|
3568
|
+
}
|
|
2437
3569
|
/**
|
|
2438
3570
|
* List the caller's webhooks.
|
|
2439
3571
|
*/
|