@linebundle-sdk/ts 1.0.0-rc.4 → 1.0.0-rc.5
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/esm/index.d.ts +14622 -3
- package/esm/index.js +7854 -2
- package/esm/index.js.map +1 -1
- package/package.json +4 -13
- package/tsup.config.ts +11 -0
- package/esm/client/client.gen.d.ts +0 -3
- package/esm/client/client.gen.d.ts.map +0 -1
- package/esm/client/client.gen.js +0 -236
- package/esm/client/client.gen.js.map +0 -1
- package/esm/client/index.d.ts +0 -9
- package/esm/client/index.d.ts.map +0 -1
- package/esm/client/index.js +0 -7
- package/esm/client/index.js.map +0 -1
- package/esm/client/types.gen.d.ts +0 -118
- package/esm/client/types.gen.d.ts.map +0 -1
- package/esm/client/types.gen.js +0 -3
- package/esm/client/types.gen.js.map +0 -1
- package/esm/client/utils.gen.d.ts +0 -34
- package/esm/client/utils.gen.d.ts.map +0 -1
- package/esm/client/utils.gen.js +0 -231
- package/esm/client/utils.gen.js.map +0 -1
- package/esm/client.gen.d.ts +0 -13
- package/esm/client.gen.d.ts.map +0 -1
- package/esm/client.gen.js +0 -4
- package/esm/client.gen.js.map +0 -1
- package/esm/core/auth.gen.d.ts +0 -19
- package/esm/core/auth.gen.d.ts.map +0 -1
- package/esm/core/auth.gen.js +0 -15
- package/esm/core/auth.gen.js.map +0 -1
- package/esm/core/bodySerializer.gen.d.ts +0 -26
- package/esm/core/bodySerializer.gen.d.ts.map +0 -1
- package/esm/core/bodySerializer.gen.js +0 -58
- package/esm/core/bodySerializer.gen.js.map +0 -1
- package/esm/core/params.gen.d.ts +0 -44
- package/esm/core/params.gen.d.ts.map +0 -1
- package/esm/core/params.gen.js +0 -101
- package/esm/core/params.gen.js.map +0 -1
- package/esm/core/pathSerializer.gen.d.ts +0 -34
- package/esm/core/pathSerializer.gen.d.ts.map +0 -1
- package/esm/core/pathSerializer.gen.js +0 -107
- package/esm/core/pathSerializer.gen.js.map +0 -1
- package/esm/core/queryKeySerializer.gen.d.ts +0 -19
- package/esm/core/queryKeySerializer.gen.d.ts.map +0 -1
- package/esm/core/queryKeySerializer.gen.js +0 -93
- package/esm/core/queryKeySerializer.gen.js.map +0 -1
- package/esm/core/serverSentEvents.gen.d.ts +0 -72
- package/esm/core/serverSentEvents.gen.d.ts.map +0 -1
- package/esm/core/serverSentEvents.gen.js +0 -134
- package/esm/core/serverSentEvents.gen.js.map +0 -1
- package/esm/core/types.gen.d.ts +0 -79
- package/esm/core/types.gen.d.ts.map +0 -1
- package/esm/core/types.gen.js +0 -3
- package/esm/core/types.gen.js.map +0 -1
- package/esm/core/utils.gen.d.ts +0 -20
- package/esm/core/utils.gen.d.ts.map +0 -1
- package/esm/core/utils.gen.js +0 -88
- package/esm/core/utils.gen.js.map +0 -1
- package/esm/index.d.ts.map +0 -1
- package/esm/sdk.gen.d.ts +0 -1854
- package/esm/sdk.gen.d.ts.map +0 -1
- package/esm/sdk.gen.js +0 -3875
- package/esm/sdk.gen.js.map +0 -1
- package/esm/types.gen.d.ts +0 -12463
- package/esm/types.gen.d.ts.map +0 -1
- package/esm/types.gen.js +0 -3
- package/esm/types.gen.js.map +0 -1
- package/esm/zod.gen.d.ts +0 -8634
- package/esm/zod.gen.d.ts.map +0 -1
- package/esm/zod.gen.js +0 -4430
- package/esm/zod.gen.js.map +0 -1
- package/scripts/fix-esm-extensions.mjs +0 -31
package/esm/sdk.gen.d.ts
DELETED
|
@@ -1,1854 +0,0 @@
|
|
|
1
|
-
import { type Client, type Options as Options2, type TDataShape } from './client.js';
|
|
2
|
-
import type { AiAgentCancelWorkflowData, AiAgentCancelWorkflowErrors, AiAgentCancelWorkflowResponses, AiAgentCreateSessionData, AiAgentCreateSessionErrors, AiAgentCreateSessionResponses, AiAgentGetSessionCostsData, AiAgentGetSessionCostsErrors, AiAgentGetSessionCostsResponses, AiAgentGetSessionData, AiAgentGetSessionErrors, AiAgentGetSessionResponses, AiAgentListSessionsData, AiAgentListSessionsErrors, AiAgentListSessionsResponses, AiAgentListWorkflowsData, AiAgentListWorkflowsErrors, AiAgentListWorkflowsResponses, AiAgentSendMessage2Data, AiAgentSendMessage2Errors, AiAgentSendMessage2Responses, AiAgentSendMessageData, AiAgentSendMessageErrors, AiAgentSendMessageResponses, AiAgentsGetOrgCostsData, AiAgentsGetOrgCostsErrors, AiAgentsGetOrgCostsResponses, AiAgentStartWorkflowAsyncData, AiAgentStartWorkflowAsyncErrors, AiAgentStartWorkflowAsyncResponses, AiAgentStartWorkflowData, AiAgentStartWorkflowErrors, AiAgentStartWorkflowResponses, AIDeleteSessionData, AIDeleteSessionErrors, AIDeleteSessionResponses, AiWorkflowsGetExecutionDetailsData, AiWorkflowsGetExecutionDetailsErrors, AiWorkflowsGetExecutionDetailsResponses, AnalyticGetDashboardData, AnalyticGetDashboardErrors, AnalyticGetDashboardResponses, AnalyticGetTotalsData, AnalyticGetTotalsErrors, AnalyticGetTotalsResponses, AuditLogsGetPermissionStatsData, AuditLogsGetPermissionStatsErrors, AuditLogsGetPermissionStatsResponses, AuditLogsListPermissionsData, AuditLogsListPermissionsErrors, AuditLogsListPermissionsResponses, AuthContextsGetData, AuthContextsGetErrors, AuthContextsGetResponses, AutomationCronHealthCheckData, AutomationCronHealthCheckErrors, AutomationCronHealthCheckResponses, AutomationCronTriggerScheduledData, AutomationCronTriggerScheduledErrors, AutomationCronTriggerScheduledResponses, AutomationMetadataGetActionsData, AutomationMetadataGetActionsErrors, AutomationMetadataGetActionsResponses, AutomationMetadataGetTaskData, AutomationMetadataGetTaskErrors, AutomationMetadataGetTaskResponses, AutomationMetadataGetTasksData, AutomationMetadataGetTasksErrors, AutomationMetadataGetTasksResponses, AutomationMetadataGetTriggersData, AutomationMetadataGetTriggersErrors, AutomationMetadataGetTriggersResponses, AutomationRulesCreateData, AutomationRulesCreateErrors, AutomationRulesCreateResponses, AutomationRulesDeleteData, AutomationRulesDeleteErrors, AutomationRulesDeleteResponses, AutomationRulesExecuteData, AutomationRulesExecuteErrors, AutomationRulesExecuteResponses, AutomationRulesGetConditionsData, AutomationRulesGetConditionsErrors, AutomationRulesGetConditionsResponses, AutomationRulesGetData, AutomationRulesGetErrors, AutomationRulesGetExecutionsData, AutomationRulesGetExecutionsErrors, AutomationRulesGetExecutionsResponses, AutomationRulesGetMetadataData, AutomationRulesGetMetadataErrors, AutomationRulesGetMetadataResponses, AutomationRulesGetResponses, AutomationRulesListData, AutomationRulesListErrors, AutomationRulesListResponses, AutomationRulesPatchData, AutomationRulesPatchErrors, AutomationRulesPatchResponses, AutomationRulesUpdateData, AutomationRulesUpdateErrors, AutomationRulesUpdateResponses, BookingCreateData, BookingCreateErrors, BookingCreateResponses, BookingsCheckAvailabilityData, BookingsCheckAvailabilityErrors, BookingsCheckAvailabilityResponses, BookingsDeleteData, BookingsDeleteErrors, BookingsDeleteResponses, BookingsGetByIdData, BookingsGetByIdErrors, BookingsGetByIdResponses, BookingsGetPlaceScheduleData, BookingsGetPlaceScheduleErrors, BookingsGetPlaceScheduleResponses, BookingsListData, BookingsListErrors, BookingsListResponses, BookingsUpdateData, BookingsUpdateErrors, BookingsUpdateResponses, ChatMessagesDeleteData, ChatMessagesDeleteErrors, ChatMessagesDeleteResponses, ChatMessagesGetCountData, ChatMessagesGetCountErrors, ChatMessagesGetCountResponses, ChatMessagesGetUnreadCountData, ChatMessagesGetUnreadCountErrors, ChatMessagesGetUnreadCountResponses, ChatMessagesListData, ChatMessagesListErrors, ChatMessagesListResponses, ChatMessagesMarkReadData, ChatMessagesMarkReadErrors, ChatMessagesMarkReadResponses, ChatRoomsAddMemberData, ChatRoomsAddMemberErrors, ChatRoomsAddMemberResponses, ChatRoomsCreateDirectData, ChatRoomsCreateDirectErrors, ChatRoomsCreateDirectResponses, ChatRoomsCreateGroupData, ChatRoomsCreateGroupErrors, ChatRoomsCreateGroupResponses, ChatRoomsGetByIdData, ChatRoomsGetByIdErrors, ChatRoomsGetByIdResponses, ChatRoomsListData, ChatRoomsListErrors, ChatRoomsListMembersData, ChatRoomsListMembersErrors, ChatRoomsListMembersResponses, ChatRoomsListResponses, ChatRoomsRemoveMemberData, ChatRoomsRemoveMemberErrors, ChatRoomsRemoveMemberResponses, ChatRoomsUpdateData, ChatRoomsUpdateErrors, ChatRoomsUpdateResponses, ConnectWebSocketData, ConnectWebSocketErrors, ConnectWebSocketResponses, ContactsCreateData, ContactsCreateErrors, ContactsCreateResponses, ContactsDeleteData, ContactsDeleteErrors, ContactsDeleteResponses, ContactsGetData, ContactsGetErrors, ContactsGetResponses, ContactsListData, ContactsListErrors, ContactsListResponses, ContactsSearchData, ContactsSearchErrors, ContactsSearchResponses, ContactsToggleFavoriteData, ContactsToggleFavoriteErrors, ContactsToggleFavoriteResponses, ContactsUpdateData, ContactsUpdateErrors, ContactsUpdateResponses, CustomRolesAddPermissionData, CustomRolesAddPermissionErrors, CustomRolesAddPermissionResponses, CustomRolesAssignToUserData, CustomRolesAssignToUserErrors, CustomRolesAssignToUserResponses, CustomRolesCreateData, CustomRolesCreateErrors, CustomRolesCreateResponses, CustomRolesGetData, CustomRolesGetErrors, CustomRolesGetMyPermissionsData, CustomRolesGetMyPermissionsErrors, CustomRolesGetMyPermissionsResponses, CustomRolesGetResponses, CustomRolesListData, CustomRolesListErrors, CustomRolesListResponses, CustomRolesRemovePermissionData, CustomRolesRemovePermissionErrors, CustomRolesRemovePermissionResponses, CustomRolesRemoveUserRoleData, CustomRolesRemoveUserRoleErrors, CustomRolesRemoveUserRoleResponses, CustomRolesSetPermissionsData, CustomRolesSetPermissionsErrors, CustomRolesSetPermissionsResponses, CustomRolesUpdateData, CustomRolesUpdateErrors, CustomRolesUpdateResponses, EventAttendeesAddBulkData, EventAttendeesAddBulkErrors, EventAttendeesAddBulkResponses, EventAttendeesAddData, EventAttendeesAddErrors, EventAttendeesAddResponses, EventAttendeesCheckInData, EventAttendeesCheckInErrors, EventAttendeesCheckInResponses, EventAttendeesGetData, EventAttendeesGetErrors, EventAttendeesGetResponses, EventAttendeesRemoveBulkData, EventAttendeesRemoveBulkErrors, EventAttendeesRemoveBulkResponses, EventAttendeesRemoveData, EventAttendeesRemoveErrors, EventAttendeesRemoveResponses, EventAttendeesUpdateBulkStatusData, EventAttendeesUpdateBulkStatusErrors, EventAttendeesUpdateBulkStatusResponses, EventAttendeesUpdateData, EventAttendeesUpdateErrors, EventAttendeesUpdateResponses, EventCompareVersionsData, EventCompareVersionsErrors, EventCompareVersionsResponses, EventDocumentsAddDocumentData, EventDocumentsAddDocumentErrors, EventDocumentsAddDocumentResponses, EventDocumentsGetDocumentsData, EventDocumentsGetDocumentsErrors, EventDocumentsGetDocumentsResponses, EventDocumentsRemoveData, EventDocumentsRemoveErrors, EventDocumentsRemoveResponses, EventGetData, EventGetErrors, EventGetLatestVersionData, EventGetLatestVersionErrors, EventGetLatestVersionResponses, EventGetResponses, EventGetSectionSettingsData, EventGetSectionSettingsErrors, EventGetSectionSettingsResponses, EventGetVersionData, EventGetVersionErrors, EventGetVersionResponses, EventLocationGetData, EventLocationGetErrors, EventLocationGetResponses, EventLocationUpdateData, EventLocationUpdateErrors, EventLocationUpdateResponses, EventsArchiveData, EventsArchiveErrors, EventsArchiveResponses, EventsCreateData, EventsCreateErrors, EventsCreateResponses, EventsDeleteData, EventsDeleteErrors, EventsDeleteResponses, EventsFilterAdvancedData, EventsFilterAdvancedErrors, EventsFilterAdvancedResponses, EventsGetSectionContentData, EventsGetSectionContentErrors, EventsGetSectionContentResponses, EventsGetSectionIdentificationData, EventsGetSectionIdentificationErrors, EventsGetSectionIdentificationResponses, EventsGetSettingsData, EventsGetSettingsErrors, EventsGetSettingsResponses, EventsGetSocialFeedData, EventsGetSocialFeedErrors, EventsGetSocialFeedResponses, EventsGetTimezonesData, EventsGetTimezonesErrors, EventsGetTimezonesResponses, EventsListBySpaceData, EventsListBySpaceErrors, EventsListBySpaceResponses, EventsListCalendarData, EventsListCalendarErrors, EventsListCalendarResponses, EventsListData, EventsListErrors, EventsListResponses, EventsListVersionsData, EventsListVersionsErrors, EventsListVersionsResponses, EventsPatchContentData, EventsPatchContentErrors, EventsPatchContentResponses, EventsPatchIdentificationData, EventsPatchIdentificationErrors, EventsPatchIdentificationResponses, EventsPatchSettingsData, EventsPatchSettingsErrors, EventsPatchSettingsResponses, EventsPublishData, EventsPublishErrors, EventsPublishResponses, EventsPublishVersionData, EventsPublishVersionErrors, EventsPublishVersionResponses, EventsPublishWithNotificationsData, EventsPublishWithNotificationsErrors, EventsPublishWithNotificationsResponses, EventsRollbackVersionData, EventsRollbackVersionErrors, EventsRollbackVersionResponses, EventsTransferData, EventsTransferErrors, EventsTransferResponses, EventsUpdateCoverData, EventsUpdateCoverErrors, EventsUpdateCoverResponses, EventTimelineCreateMilestoneData, EventTimelineCreateMilestoneErrors, EventTimelineCreateMilestoneResponses, EventTimelineGetData, EventTimelineGetErrors, EventTimelineGetPublishedData, EventTimelineGetPublishedErrors, EventTimelineGetPublishedResponses, EventTimelineGetResponses, EventTimelineLinkMilestoneData, EventTimelineLinkMilestoneErrors, EventTimelineLinkMilestoneResponses, EventTimelineUnlinkData, EventTimelineUnlinkErrors, EventTimelineUnlinkResponses, EventTimezonesValidateData, EventTimezonesValidateErrors, EventTimezonesValidateResponses, EventUnpublishVersionData, EventUnpublishVersionErrors, EventUnpublishVersionResponses, EventUpdateData, EventUpdateErrors, EventUpdateResponses, FeaturesGetData, FeaturesGetErrors, FeaturesGetResponses, GetLatestPublicEventVersionData, GetLatestPublicEventVersionErrors, GetLatestPublicEventVersionResponses, GetLatestPublicSpaceVersionData, GetLatestPublicSpaceVersionErrors, GetLatestPublicSpaceVersionResponses, HandleUserCreatedApiV1IntegrationUserCreatedPostData, HandleUserCreatedApiV1IntegrationUserCreatedPostErrors, HandleUserCreatedApiV1IntegrationUserCreatedPostResponses, HandleUserUpdatedApiV1IntegrationUserUpdatedPostData, HandleUserUpdatedApiV1IntegrationUserUpdatedPostErrors, HandleUserUpdatedApiV1IntegrationUserUpdatedPostResponses, HealthCheckAutomationData, HealthCheckAutomationErrors, HealthCheckAutomationResponses, HealthCheckData, HealthCheckErrors, HealthCheckResponses, HealthNotificationsCheckData, HealthNotificationsCheckErrors, HealthNotificationsCheckResponses, IntegrationHandleOrgRemovedData, IntegrationHandleOrgRemovedErrors, IntegrationHandleOrgRemovedResponses, IntegrationUserHandleRemovedData, IntegrationUserHandleRemovedErrors, IntegrationUserHandleRemovedResponses, MetricsGetData, MetricsGetErrors, MetricsGetResponses, OrganizationsArchiveData, OrganizationsArchiveErrors, OrganizationsArchiveResponses, OrganizationsCreateData, OrganizationsCreateErrors, OrganizationsCreateInviteData, OrganizationsCreateInviteErrors, OrganizationsCreateInviteResponses, OrganizationsCreateResponses, OrganizationsDeleteInviteData, OrganizationsDeleteInviteErrors, OrganizationsDeleteInviteResponses, OrganizationsGetByIdData, OrganizationsGetByIdErrors, OrganizationsGetByIdResponses, OrganizationsGetCurrentData, OrganizationsGetCurrentErrors, OrganizationsGetCurrentResponses, OrganizationsGetInvitesData, OrganizationsGetInvitesErrors, OrganizationsGetInvitesResponses, OrganizationsListData, OrganizationsListErrors, OrganizationsListResponses, OrganizationsUpdateData, OrganizationsUpdateErrors, OrganizationsUpdateResponses, PermissionsGetData, PermissionsGetErrors, PermissionsGetResponses, PermissionsListData, PermissionsListErrors, PermissionsListResponses, PlaceArchiveData, PlaceArchiveErrors, PlaceArchiveResponses, PlacePublishData, PlacePublishErrors, PlacePublishResponses, PlacesCreateData, PlacesCreateErrors, PlacesCreateResponses, PlacesDeleteData, PlacesDeleteErrors, PlacesDeleteResponses, PlacesGetData, PlacesGetErrors, PlacesGetResponses, PlacesListData, PlacesListErrors, PlacesListResponses, PlacesUpdateData, PlacesUpdateErrors, PlacesUpdateResponses, RealtimeGetInfoData, RealtimeGetInfoErrors, RealtimeGetInfoResponses, RolesDeleteData, RolesDeleteErrors, RolesDeleteResponses, SentryTriggerErrorData, SentryTriggerErrorErrors, SentryTriggerErrorResponses, SpaceArchiveData, SpaceArchiveErrors, SpaceArchiveResponses, SpaceAssignUserToRoleData, SpaceAssignUserToRoleErrors, SpaceAssignUserToRoleResponses, SpaceBulkUpdateParentData, SpaceBulkUpdateParentErrors, SpaceBulkUpdateParentResponses, SpaceContactsAddBulkData, SpaceContactsAddBulkErrors, SpaceContactsAddBulkResponses, SpaceContactsAddData, SpaceContactsAddErrors, SpaceContactsAddResponses, SpaceContactsBulkDeleteData, SpaceContactsBulkDeleteErrors, SpaceContactsBulkDeleteResponses, SpaceContactsCountData, SpaceContactsCountErrors, SpaceContactsCountResponses, SpaceContactsGetContactsBySpaceData, SpaceContactsGetContactsBySpaceErrors, SpaceContactsGetContactsBySpaceResponses, SpaceContactsGetData, SpaceContactsGetErrors, SpaceContactsGetResponses, SpaceContactsGetSpacesByContactData, SpaceContactsGetSpacesByContactErrors, SpaceContactsGetSpacesByContactResponses, SpaceContactsRemoveData, SpaceContactsRemoveErrors, SpaceContactsRemoveResponses, SpaceDocumentsAddData, SpaceDocumentsAddErrors, SpaceDocumentsAddResponses, SpaceDocumentsGetData, SpaceDocumentsGetErrors, SpaceDocumentsGetResponses, SpaceDocumentsRemoveData, SpaceDocumentsRemoveErrors, SpaceDocumentsRemoveResponses, SpaceEventsAddData, SpaceEventsAddErrors, SpaceEventsAddResponses, SpaceEventsBulkAddData, SpaceEventsBulkAddErrors, SpaceEventsBulkAddResponses, SpaceEventsBulkRemoveData, SpaceEventsBulkRemoveErrors, SpaceEventsBulkRemoveResponses, SpaceEventsCountData, SpaceEventsCountErrors, SpaceEventsCountResponses, SpaceEventsGetByIdData, SpaceEventsGetByIdErrors, SpaceEventsGetByIdResponses, SpaceEventsGetData, SpaceEventsGetErrors, SpaceEventsGetEventSpacesData, SpaceEventsGetEventSpacesErrors, SpaceEventsGetEventSpacesResponses, SpaceEventsGetResponses, SpaceEventsRemoveEventData, SpaceEventsRemoveEventErrors, SpaceEventsRemoveEventResponses, SpaceGetLatestVersionData, SpaceGetLatestVersionErrors, SpaceGetLatestVersionResponses, SpaceGetUserRolesData, SpaceGetUserRolesErrors, SpaceGetUserRolesResponses, SpacePublishData, SpacePublishErrors, SpacePublishResponses, SpaceRolesAssignPermissionData, SpaceRolesAssignPermissionErrors, SpaceRolesAssignPermissionResponses, SpaceRolesCreateData, SpaceRolesCreateErrors, SpaceRolesCreateResponses, SpaceRolesDeleteData, SpaceRolesDeleteErrors, SpaceRolesDeleteResponses, SpaceRolesGetData, SpaceRolesGetErrors, SpaceRolesGetResponses, SpaceRolesListRolesData, SpaceRolesListRolesErrors, SpaceRolesListRolesResponses, SpaceRolesRemovePermissionData, SpaceRolesRemovePermissionErrors, SpaceRolesRemovePermissionResponses, SpaceRolesUpdateRoleData, SpaceRolesUpdateRoleErrors, SpaceRolesUpdateRoleResponses, SpacesAddMemberData, SpacesAddMemberErrors, SpacesAddMemberResponses, SpacesCompareVersionsData, SpacesCompareVersionsErrors, SpacesCompareVersionsResponses, SpacesCreateSpaceData, SpacesCreateSpaceErrors, SpacesCreateSpaceResponses, SpacesCreateWithParentData, SpacesCreateWithParentErrors, SpacesCreateWithParentResponses, SpacesDeleteByIdData, SpacesDeleteByIdErrors, SpacesDeleteByIdResponses, SpacesDetachParentData, SpacesDetachParentErrors, SpacesDetachParentResponses, SpacesGetByIdData, SpacesGetByIdErrors, SpacesGetByIdResponses, SpacesGetHierarchyData, SpacesGetHierarchyErrors, SpacesGetHierarchyResponses, SpacesGetJoinableByUserData, SpacesGetJoinableByUserErrors, SpacesGetJoinableByUserResponses, SpacesGetMembersData, SpacesGetMembersErrors, SpacesGetMembersResponses, SpacesGetParentData, SpacesGetParentErrors, SpacesGetParentResponses, SpacesGetVersionData, SpacesGetVersionErrors, SpacesGetVersionResponses, SpacesJoinData, SpacesJoinErrors, SpacesJoinResponses, SpacesListChildrenData, SpacesListChildrenErrors, SpacesListChildrenResponses, SpacesListData, SpacesListErrors, SpacesListResponses, SpacesListVersionsData, SpacesListVersionsErrors, SpacesListVersionsResponses, SpacesPublishVersionData, SpacesPublishVersionErrors, SpacesPublishVersionResponses, SpacesRemoveMemberData, SpacesRemoveMemberErrors, SpacesRemoveMemberResponses, SpacesRemoveUserFromRoleData, SpacesRemoveUserFromRoleErrors, SpacesRemoveUserFromRoleResponses, SpacesRollbackData, SpacesRollbackErrors, SpacesRollbackResponses, SpacesUnpublishData, SpacesUnpublishErrors, SpacesUnpublishResponses, SpacesUpdateParentData, SpacesUpdateParentErrors, SpacesUpdateParentResponses, SpaceTestAuthData, SpaceTestAuthErrors, SpaceTestAuthResponses, SpaceTransferData, SpaceTransferErrors, SpaceTransferResponses, SpaceUpdateData, SpaceUpdateErrors, SpaceUpdateMemberRoleData, SpaceUpdateMemberRoleErrors, SpaceUpdateMemberRoleResponses, SpaceUpdateResponses, UserCreateAssistantData, UserCreateAssistantErrors, UserCreateAssistantResponses, UserGetAssistantData, UserGetAssistantErrors, UserGetAssistantResponses, UserGetProfileData, UserGetProfileErrors, UserGetProfileResponses, UserListData, UserListErrors, UserListResponses, UsersDeleteAvatarData, UsersDeleteAvatarErrors, UsersDeleteAvatarResponses, UsersGetAvatarByIdData, UsersGetAvatarByIdErrors, UsersGetAvatarByIdResponses, UsersGetAvatarData, UsersGetAvatarErrors, UsersGetAvatarResponses, UsersGetCurrentProfileData, UsersGetCurrentProfileErrors, UsersGetCurrentProfileResponses, UsersSearchData, UsersSearchErrors, UsersSearchResponses, UserUpdateProfileData, UserUpdateProfileErrors, UserUpdateProfileResponses, UserUploadAvatarData, UserUploadAvatarErrors, UserUploadAvatarResponses } from './types.gen.js';
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
-
/**
|
|
5
|
-
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
-
* individual options. This might be also useful if you want to implement a
|
|
7
|
-
* custom client.
|
|
8
|
-
*/
|
|
9
|
-
client?: Client;
|
|
10
|
-
/**
|
|
11
|
-
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
-
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
-
*/
|
|
14
|
-
meta?: Record<string, unknown>;
|
|
15
|
-
};
|
|
16
|
-
declare class HeyApiClient {
|
|
17
|
-
protected client: Client;
|
|
18
|
-
constructor(args?: {
|
|
19
|
-
client?: Client;
|
|
20
|
-
});
|
|
21
|
-
}
|
|
22
|
-
declare class HeyApiRegistry<T> {
|
|
23
|
-
private readonly defaultKey;
|
|
24
|
-
private readonly instances;
|
|
25
|
-
get(key?: string): T;
|
|
26
|
-
set(value: T, key?: string): void;
|
|
27
|
-
}
|
|
28
|
-
export declare class User extends HeyApiClient {
|
|
29
|
-
/**
|
|
30
|
-
* Get Assistant
|
|
31
|
-
*
|
|
32
|
-
* Get the current user's AI assistant if it exists.
|
|
33
|
-
*/
|
|
34
|
-
getAssistant<ThrowOnError extends boolean = false>(options?: Options<UserGetAssistantData, ThrowOnError>): import("./client").RequestResult<UserGetAssistantResponses, UserGetAssistantErrors, ThrowOnError, "fields">;
|
|
35
|
-
/**
|
|
36
|
-
* Create Assistant
|
|
37
|
-
*
|
|
38
|
-
* Create a personal AI assistant for the current user.
|
|
39
|
-
*/
|
|
40
|
-
createAssistant<ThrowOnError extends boolean = false>(options?: Options<UserCreateAssistantData, ThrowOnError>): import("./client").RequestResult<UserCreateAssistantResponses, UserCreateAssistantErrors, ThrowOnError, "fields">;
|
|
41
|
-
/**
|
|
42
|
-
* Get User List
|
|
43
|
-
*/
|
|
44
|
-
list<ThrowOnError extends boolean = false>(options?: Options<UserListData, ThrowOnError>): import("./client").RequestResult<UserListResponses, UserListErrors, ThrowOnError, "fields">;
|
|
45
|
-
/**
|
|
46
|
-
* Update Profile
|
|
47
|
-
*
|
|
48
|
-
* Update current user's profile.
|
|
49
|
-
*/
|
|
50
|
-
updateProfile<ThrowOnError extends boolean = false>(options: Options<UserUpdateProfileData, ThrowOnError>): import("./client").RequestResult<UserUpdateProfileResponses, UserUpdateProfileErrors, ThrowOnError, "fields">;
|
|
51
|
-
/**
|
|
52
|
-
* Get User Profile By Id
|
|
53
|
-
*
|
|
54
|
-
* Get public profile information for a specific user by ID.
|
|
55
|
-
*
|
|
56
|
-
* This endpoint allows authenticated users to view public profile information
|
|
57
|
-
* of any user in the system. Used for user discovery and profile viewing.
|
|
58
|
-
*
|
|
59
|
-
* Args:
|
|
60
|
-
* user_id: UUID string of the user whose profile to retrieve
|
|
61
|
-
*
|
|
62
|
-
* Returns:
|
|
63
|
-
* UserProfileResponse: Public profile information (excludes sensitive data like email)
|
|
64
|
-
*
|
|
65
|
-
* Raises:
|
|
66
|
-
* HTTPException: 400 for invalid UUID format, 404 for user not found, 500 for server errors
|
|
67
|
-
*/
|
|
68
|
-
getProfile<ThrowOnError extends boolean = false>(options: Options<UserGetProfileData, ThrowOnError>): import("./client").RequestResult<UserGetProfileResponses, UserGetProfileErrors, ThrowOnError, "fields">;
|
|
69
|
-
/**
|
|
70
|
-
* Upload Avatar
|
|
71
|
-
*
|
|
72
|
-
* Upload avatar for current user.
|
|
73
|
-
*/
|
|
74
|
-
uploadAvatar<ThrowOnError extends boolean = false>(options: Options<UserUploadAvatarData, ThrowOnError>): import("./client").RequestResult<UserUploadAvatarResponses, UserUploadAvatarErrors, ThrowOnError, "fields">;
|
|
75
|
-
}
|
|
76
|
-
export declare class Users extends HeyApiClient {
|
|
77
|
-
/**
|
|
78
|
-
* Search Users
|
|
79
|
-
*/
|
|
80
|
-
search<ThrowOnError extends boolean = false>(options?: Options<UsersSearchData, ThrowOnError>): import("./client").RequestResult<UsersSearchResponses, UsersSearchErrors, ThrowOnError, "fields">;
|
|
81
|
-
/**
|
|
82
|
-
* Get Current User Profile
|
|
83
|
-
*
|
|
84
|
-
* Get current user's profile information.
|
|
85
|
-
*/
|
|
86
|
-
getCurrentProfile<ThrowOnError extends boolean = false>(options?: Options<UsersGetCurrentProfileData, ThrowOnError>): import("./client").RequestResult<UsersGetCurrentProfileResponses, UsersGetCurrentProfileErrors, ThrowOnError, "fields">;
|
|
87
|
-
/**
|
|
88
|
-
* Delete Avatar
|
|
89
|
-
*
|
|
90
|
-
* Delete current user's avatar.
|
|
91
|
-
*/
|
|
92
|
-
deleteAvatar<ThrowOnError extends boolean = false>(options?: Options<UsersDeleteAvatarData, ThrowOnError>): import("./client").RequestResult<UsersDeleteAvatarResponses, UsersDeleteAvatarErrors, ThrowOnError, "fields">;
|
|
93
|
-
/**
|
|
94
|
-
* Get Avatar
|
|
95
|
-
*
|
|
96
|
-
* Get current user's avatar image.
|
|
97
|
-
*/
|
|
98
|
-
getAvatar<ThrowOnError extends boolean = false>(options?: Options<UsersGetAvatarData, ThrowOnError>): import("./client").RequestResult<UsersGetAvatarResponses, UsersGetAvatarErrors, ThrowOnError, "fields">;
|
|
99
|
-
/**
|
|
100
|
-
* Get User Avatar
|
|
101
|
-
*
|
|
102
|
-
* Get user's avatar image (requires authentication).
|
|
103
|
-
*/
|
|
104
|
-
getAvatarById<ThrowOnError extends boolean = false>(options: Options<UsersGetAvatarByIdData, ThrowOnError>): import("./client").RequestResult<UsersGetAvatarByIdResponses, UsersGetAvatarByIdErrors, ThrowOnError, "fields">;
|
|
105
|
-
}
|
|
106
|
-
export declare class AuthContexts extends HeyApiClient {
|
|
107
|
-
/**
|
|
108
|
-
* Get Auth Context
|
|
109
|
-
*
|
|
110
|
-
* Get the current authenticated user's context.
|
|
111
|
-
*
|
|
112
|
-
* Returns user profile information and a list of organizations they belong to.
|
|
113
|
-
* For M2M tokens (service accounts), returns minimal info with is_service_account=True.
|
|
114
|
-
*/
|
|
115
|
-
get<ThrowOnError extends boolean = false>(options?: Options<AuthContextsGetData, ThrowOnError>): import("./client").RequestResult<AuthContextsGetResponses, AuthContextsGetErrors, ThrowOnError, "fields">;
|
|
116
|
-
}
|
|
117
|
-
export declare class AuditLogs extends HeyApiClient {
|
|
118
|
-
/**
|
|
119
|
-
* List Permission Audit Logs
|
|
120
|
-
*
|
|
121
|
-
* List permission audit logs with filtering and pagination.
|
|
122
|
-
*
|
|
123
|
-
* Requires PERMISSION_READ permission.
|
|
124
|
-
*
|
|
125
|
-
* **Security**: Non-admin users can only view logs for their own organization.
|
|
126
|
-
* The org_id filter is automatically applied based on the user's permissions.
|
|
127
|
-
*
|
|
128
|
-
* **Query Parameters**:
|
|
129
|
-
* - user_id: Filter by specific user
|
|
130
|
-
* - org_id: Filter by organization (auto-scoped for non-admins)
|
|
131
|
-
* - permission_code: Filter by permission (e.g., "SPACE_MANAGE_MEMBERS")
|
|
132
|
-
* - result: Filter by result ("granted" or "denied")
|
|
133
|
-
* - start_date/end_date: Filter by date range
|
|
134
|
-
* - skip/limit: Pagination controls
|
|
135
|
-
*
|
|
136
|
-
* **Returns**: Paginated list of audit log entries with total count.
|
|
137
|
-
*/
|
|
138
|
-
listPermissions<ThrowOnError extends boolean = false>(options?: Options<AuditLogsListPermissionsData, ThrowOnError>): import("./client").RequestResult<AuditLogsListPermissionsResponses, AuditLogsListPermissionsErrors, ThrowOnError, "fields">;
|
|
139
|
-
/**
|
|
140
|
-
* Get Permission Audit Stats
|
|
141
|
-
*
|
|
142
|
-
* Get aggregate statistics for permission audit logs.
|
|
143
|
-
*
|
|
144
|
-
* Requires PERMISSION_READ permission.
|
|
145
|
-
*
|
|
146
|
-
* **Security**: Non-admin users can only view stats for their own organization.
|
|
147
|
-
*
|
|
148
|
-
* **Returns**:
|
|
149
|
-
* - total_checks: Total number of permission checks
|
|
150
|
-
* - granted_count: Number of granted permissions
|
|
151
|
-
* - denied_count: Number of denied permissions
|
|
152
|
-
* - unique_users: Number of unique users who triggered checks
|
|
153
|
-
* - unique_permissions: Number of unique permissions checked
|
|
154
|
-
* - most_checked_permissions: Top 10 most frequently checked permissions
|
|
155
|
-
* - most_denied_permissions: Top 10 most frequently denied permissions
|
|
156
|
-
*/
|
|
157
|
-
getPermissionStats<ThrowOnError extends boolean = false>(options?: Options<AuditLogsGetPermissionStatsData, ThrowOnError>): import("./client").RequestResult<AuditLogsGetPermissionStatsResponses, AuditLogsGetPermissionStatsErrors, ThrowOnError, "fields">;
|
|
158
|
-
}
|
|
159
|
-
export declare class Events extends HeyApiClient {
|
|
160
|
-
/**
|
|
161
|
-
* Get Event List
|
|
162
|
-
*
|
|
163
|
-
* Get events with advanced filtering capabilities.
|
|
164
|
-
*
|
|
165
|
-
* Supports multiple filtering strategies:
|
|
166
|
-
* - Legacy query parameters for backward compatibility
|
|
167
|
-
* - Individual advanced filter parameters
|
|
168
|
-
* - Complex JSON filter object for advanced use cases
|
|
169
|
-
*/
|
|
170
|
-
list<ThrowOnError extends boolean = false>(options?: Options<EventsListData, ThrowOnError>): import("./client").RequestResult<EventsListResponses, EventsListErrors, ThrowOnError, "fields">;
|
|
171
|
-
/**
|
|
172
|
-
* Create Event
|
|
173
|
-
*/
|
|
174
|
-
create<ThrowOnError extends boolean = false>(options: Options<EventsCreateData, ThrowOnError>): import("./client").RequestResult<EventsCreateResponses, EventsCreateErrors, ThrowOnError, "fields">;
|
|
175
|
-
/**
|
|
176
|
-
* Get Calendar Events
|
|
177
|
-
*
|
|
178
|
-
* Get events for calendar view.
|
|
179
|
-
*
|
|
180
|
-
* Requires start_date and end_date.
|
|
181
|
-
* Returns all events in the range (high limit) to avoid missing data.
|
|
182
|
-
* Supports all standard event filters.
|
|
183
|
-
*/
|
|
184
|
-
listCalendar<ThrowOnError extends boolean = false>(options: Options<EventsListCalendarData, ThrowOnError>): import("./client").RequestResult<EventsListCalendarResponses, EventsListCalendarErrors, ThrowOnError, "fields">;
|
|
185
|
-
/**
|
|
186
|
-
* Get Social Feed
|
|
187
|
-
*
|
|
188
|
-
* Get the social feed of events for the current user.
|
|
189
|
-
*
|
|
190
|
-
* Events are ranked by:
|
|
191
|
-
* 1. User relationship (personal events > owned spaces > member spaces > others)
|
|
192
|
-
* 2. Temporal proximity to user's current time (events happening soon rank higher)
|
|
193
|
-
*/
|
|
194
|
-
getSocialFeed<ThrowOnError extends boolean = false>(options?: Options<EventsGetSocialFeedData, ThrowOnError>): import("./client").RequestResult<EventsGetSocialFeedResponses, EventsGetSocialFeedErrors, ThrowOnError, "fields">;
|
|
195
|
-
/**
|
|
196
|
-
* Filter Events Advanced
|
|
197
|
-
*
|
|
198
|
-
* Advanced event filtering using POST method for complex filter objects.
|
|
199
|
-
*
|
|
200
|
-
* This endpoint is useful for complex filtering scenarios that exceed
|
|
201
|
-
* URL length limits or require complex nested conditions.
|
|
202
|
-
*/
|
|
203
|
-
filterAdvanced<ThrowOnError extends boolean = false>(options: Options<EventsFilterAdvancedData, ThrowOnError>): import("./client").RequestResult<EventsFilterAdvancedResponses, EventsFilterAdvancedErrors, ThrowOnError, "fields">;
|
|
204
|
-
/**
|
|
205
|
-
* Get Events By Space
|
|
206
|
-
*/
|
|
207
|
-
listBySpace<ThrowOnError extends boolean = false>(options: Options<EventsListBySpaceData, ThrowOnError>): import("./client").RequestResult<EventsListBySpaceResponses, EventsListBySpaceErrors, ThrowOnError, "fields">;
|
|
208
|
-
/**
|
|
209
|
-
* Delete Event
|
|
210
|
-
*/
|
|
211
|
-
delete<ThrowOnError extends boolean = false>(options: Options<EventsDeleteData, ThrowOnError>): import("./client").RequestResult<EventsDeleteResponses, EventsDeleteErrors, ThrowOnError, "fields">;
|
|
212
|
-
/**
|
|
213
|
-
* Patch Event Identification
|
|
214
|
-
*
|
|
215
|
-
* Update event title and status (Identification info). API renamed from /header.
|
|
216
|
-
*/
|
|
217
|
-
patchIdentification<ThrowOnError extends boolean = false>(options: Options<EventsPatchIdentificationData, ThrowOnError>): import("./client").RequestResult<EventsPatchIdentificationResponses, EventsPatchIdentificationErrors, ThrowOnError, "fields">;
|
|
218
|
-
/**
|
|
219
|
-
* Get Section Identification
|
|
220
|
-
*/
|
|
221
|
-
getSectionIdentification<ThrowOnError extends boolean = false>(options: Options<EventsGetSectionIdentificationData, ThrowOnError>): import("./client").RequestResult<EventsGetSectionIdentificationResponses, EventsGetSectionIdentificationErrors, ThrowOnError, "fields">;
|
|
222
|
-
/**
|
|
223
|
-
* Get Section Content
|
|
224
|
-
*/
|
|
225
|
-
getSectionContent<ThrowOnError extends boolean = false>(options: Options<EventsGetSectionContentData, ThrowOnError>): import("./client").RequestResult<EventsGetSectionContentResponses, EventsGetSectionContentErrors, ThrowOnError, "fields">;
|
|
226
|
-
/**
|
|
227
|
-
* Patch Event Content
|
|
228
|
-
*
|
|
229
|
-
* Update event content (Description, Metadata, Theme).
|
|
230
|
-
*/
|
|
231
|
-
patchContent<ThrowOnError extends boolean = false>(options: Options<EventsPatchContentData, ThrowOnError>): import("./client").RequestResult<EventsPatchContentResponses, EventsPatchContentErrors, ThrowOnError, "fields">;
|
|
232
|
-
/**
|
|
233
|
-
* Get Event Settings
|
|
234
|
-
*
|
|
235
|
-
* Get dedicated event settings.
|
|
236
|
-
*/
|
|
237
|
-
getSettings<ThrowOnError extends boolean = false>(options: Options<EventsGetSettingsData, ThrowOnError>): import("./client").RequestResult<EventsGetSettingsResponses, EventsGetSettingsErrors, ThrowOnError, "fields">;
|
|
238
|
-
/**
|
|
239
|
-
* Patch Event Settings
|
|
240
|
-
*
|
|
241
|
-
* Update event settings (Visibility, Access).
|
|
242
|
-
*/
|
|
243
|
-
patchSettings<ThrowOnError extends boolean = false>(options: Options<EventsPatchSettingsData, ThrowOnError>): import("./client").RequestResult<EventsPatchSettingsResponses, EventsPatchSettingsErrors, ThrowOnError, "fields">;
|
|
244
|
-
/**
|
|
245
|
-
* Update Cover
|
|
246
|
-
*/
|
|
247
|
-
updateCover<ThrowOnError extends boolean = false>(options: Options<EventsUpdateCoverData, ThrowOnError>): import("./client").RequestResult<EventsUpdateCoverResponses, EventsUpdateCoverErrors, ThrowOnError, "fields">;
|
|
248
|
-
/**
|
|
249
|
-
* Publish Event
|
|
250
|
-
*/
|
|
251
|
-
publish<ThrowOnError extends boolean = false>(options: Options<EventsPublishData, ThrowOnError>): import("./client").RequestResult<EventsPublishResponses, EventsPublishErrors, ThrowOnError, "fields">;
|
|
252
|
-
/**
|
|
253
|
-
* Publish Event With Notifications
|
|
254
|
-
*/
|
|
255
|
-
publishWithNotifications<ThrowOnError extends boolean = false>(options: Options<EventsPublishWithNotificationsData, ThrowOnError>): import("./client").RequestResult<EventsPublishWithNotificationsResponses, EventsPublishWithNotificationsErrors, ThrowOnError, "fields">;
|
|
256
|
-
/**
|
|
257
|
-
* Archive Event
|
|
258
|
-
*/
|
|
259
|
-
archive<ThrowOnError extends boolean = false>(options: Options<EventsArchiveData, ThrowOnError>): import("./client").RequestResult<EventsArchiveResponses, EventsArchiveErrors, ThrowOnError, "fields">;
|
|
260
|
-
/**
|
|
261
|
-
* Transfer Event
|
|
262
|
-
*
|
|
263
|
-
* Transfer a personal event to an organization.
|
|
264
|
-
*
|
|
265
|
-
* Requirements:
|
|
266
|
-
* - Event must be personal (org_id IS NULL)
|
|
267
|
-
* - Current user must be the creator
|
|
268
|
-
* - Current user must be owner or admin of target organization
|
|
269
|
-
*
|
|
270
|
-
* Returns:
|
|
271
|
-
* - 200: Transfer successful
|
|
272
|
-
* - 400: Validation error (event already org-scoped, etc.)
|
|
273
|
-
* - 403: Permission denied (not creator or not org admin)
|
|
274
|
-
* - 404: Event not found
|
|
275
|
-
*/
|
|
276
|
-
transfer<ThrowOnError extends boolean = false>(options: Options<EventsTransferData, ThrowOnError>): import("./client").RequestResult<EventsTransferResponses, EventsTransferErrors, ThrowOnError, "fields">;
|
|
277
|
-
/**
|
|
278
|
-
* Publish Event Version
|
|
279
|
-
*
|
|
280
|
-
* Create an immutable published version of the event for recommendations
|
|
281
|
-
*/
|
|
282
|
-
publishVersion<ThrowOnError extends boolean = false>(options: Options<EventsPublishVersionData, ThrowOnError>): import("./client").RequestResult<EventsPublishVersionResponses, EventsPublishVersionErrors, ThrowOnError, "fields">;
|
|
283
|
-
/**
|
|
284
|
-
* List Event Versions
|
|
285
|
-
*
|
|
286
|
-
* Get all published versions of an event
|
|
287
|
-
*/
|
|
288
|
-
listVersions<ThrowOnError extends boolean = false>(options: Options<EventsListVersionsData, ThrowOnError>): import("./client").RequestResult<EventsListVersionsResponses, EventsListVersionsErrors, ThrowOnError, "fields">;
|
|
289
|
-
/**
|
|
290
|
-
* Rollback Event to Version
|
|
291
|
-
*
|
|
292
|
-
* Restore event to a specific published version
|
|
293
|
-
*/
|
|
294
|
-
rollbackVersion<ThrowOnError extends boolean = false>(options: Options<EventsRollbackVersionData, ThrowOnError>): import("./client").RequestResult<EventsRollbackVersionResponses, EventsRollbackVersionErrors, ThrowOnError, "fields">;
|
|
295
|
-
/**
|
|
296
|
-
* Get Timezone Info
|
|
297
|
-
*
|
|
298
|
-
* Get timezone information for frontend validation and suggestions.
|
|
299
|
-
*
|
|
300
|
-
* Returns:
|
|
301
|
-
* Dictionary containing:
|
|
302
|
-
* - all_timezones: List of all valid IANA timezones
|
|
303
|
-
* - common_timezones: List of commonly used timezones for UI suggestions
|
|
304
|
-
* - count: Total number of supported timezones
|
|
305
|
-
*/
|
|
306
|
-
getTimezones<ThrowOnError extends boolean = false>(options?: Options<EventsGetTimezonesData, ThrowOnError>): import("./client").RequestResult<EventsGetTimezonesResponses, EventsGetTimezonesErrors, ThrowOnError, "fields">;
|
|
307
|
-
}
|
|
308
|
-
export declare class Event_ extends HeyApiClient {
|
|
309
|
-
/**
|
|
310
|
-
* Get Event By Id
|
|
311
|
-
*/
|
|
312
|
-
get<ThrowOnError extends boolean = false>(options: Options<EventGetData, ThrowOnError>): import("./client").RequestResult<EventGetResponses, EventGetErrors, ThrowOnError, "fields">;
|
|
313
|
-
/**
|
|
314
|
-
* Update Event
|
|
315
|
-
*/
|
|
316
|
-
update<ThrowOnError extends boolean = false>(options: Options<EventUpdateData, ThrowOnError>): import("./client").RequestResult<EventUpdateResponses, EventUpdateErrors, ThrowOnError, "fields">;
|
|
317
|
-
/**
|
|
318
|
-
* Get Section Settings
|
|
319
|
-
*/
|
|
320
|
-
getSectionSettings<ThrowOnError extends boolean = false>(options: Options<EventGetSectionSettingsData, ThrowOnError>): import("./client").RequestResult<EventGetSectionSettingsResponses, EventGetSectionSettingsErrors, ThrowOnError, "fields">;
|
|
321
|
-
/**
|
|
322
|
-
* Unpublish Event (Mark as Draft)
|
|
323
|
-
*
|
|
324
|
-
* Mark event as draft (unpublished)
|
|
325
|
-
*/
|
|
326
|
-
unpublishVersion<ThrowOnError extends boolean = false>(options: Options<EventUnpublishVersionData, ThrowOnError>): import("./client").RequestResult<EventUnpublishVersionResponses, EventUnpublishVersionErrors, ThrowOnError, "fields">;
|
|
327
|
-
/**
|
|
328
|
-
* Compare Event Versions
|
|
329
|
-
*
|
|
330
|
-
* Compare two versions and see what changed
|
|
331
|
-
*/
|
|
332
|
-
compareVersions<ThrowOnError extends boolean = false>(options: Options<EventCompareVersionsData, ThrowOnError>): import("./client").RequestResult<EventCompareVersionsResponses, EventCompareVersionsErrors, ThrowOnError, "fields">;
|
|
333
|
-
/**
|
|
334
|
-
* Get Latest Event Version
|
|
335
|
-
*
|
|
336
|
-
* Get the most recent published version of an event
|
|
337
|
-
*/
|
|
338
|
-
getLatestVersion<ThrowOnError extends boolean = false>(options: Options<EventGetLatestVersionData, ThrowOnError>): import("./client").RequestResult<EventGetLatestVersionResponses, EventGetLatestVersionErrors, ThrowOnError, "fields">;
|
|
339
|
-
/**
|
|
340
|
-
* Get Event Version
|
|
341
|
-
*
|
|
342
|
-
* Get specific published version of an event
|
|
343
|
-
*/
|
|
344
|
-
getVersion<ThrowOnError extends boolean = false>(options: Options<EventGetVersionData, ThrowOnError>): import("./client").RequestResult<EventGetVersionResponses, EventGetVersionErrors, ThrowOnError, "fields">;
|
|
345
|
-
}
|
|
346
|
-
export declare class EventTimezones extends HeyApiClient {
|
|
347
|
-
/**
|
|
348
|
-
* Validate Timezone
|
|
349
|
-
*
|
|
350
|
-
* Validate a specific timezone string.
|
|
351
|
-
*
|
|
352
|
-
* Args:
|
|
353
|
-
* timezone: Timezone string to validate (query parameter)
|
|
354
|
-
*
|
|
355
|
-
* Returns:
|
|
356
|
-
* Dictionary containing:
|
|
357
|
-
* - valid: Boolean indicating if timezone is valid
|
|
358
|
-
* - timezone: The validated timezone string
|
|
359
|
-
* - suggestions: List of similar timezones if invalid (empty if valid)
|
|
360
|
-
*/
|
|
361
|
-
validate<ThrowOnError extends boolean = false>(options: Options<EventTimezonesValidateData, ThrowOnError>): import("./client").RequestResult<EventTimezonesValidateResponses, EventTimezonesValidateErrors, ThrowOnError, "fields">;
|
|
362
|
-
}
|
|
363
|
-
export declare class EventAttendees extends HeyApiClient {
|
|
364
|
-
/**
|
|
365
|
-
* Get Event Attendees
|
|
366
|
-
*
|
|
367
|
-
* Get all attendees for a specific event.
|
|
368
|
-
*
|
|
369
|
-
* Supports filtering by status and check-in status.
|
|
370
|
-
*/
|
|
371
|
-
get<ThrowOnError extends boolean = false>(options: Options<EventAttendeesGetData, ThrowOnError>): import("./client").RequestResult<EventAttendeesGetResponses, EventAttendeesGetErrors, ThrowOnError, "fields">;
|
|
372
|
-
/**
|
|
373
|
-
* Add Event Attendee
|
|
374
|
-
*
|
|
375
|
-
* Add a contact as an attendee to an event.
|
|
376
|
-
*
|
|
377
|
-
* The contact must belong to the user's contact list (personal or org).
|
|
378
|
-
*/
|
|
379
|
-
add<ThrowOnError extends boolean = false>(options: Options<EventAttendeesAddData, ThrowOnError>): import("./client").RequestResult<EventAttendeesAddResponses, EventAttendeesAddErrors, ThrowOnError, "fields">;
|
|
380
|
-
/**
|
|
381
|
-
* Remove Event Attendees Bulk
|
|
382
|
-
*
|
|
383
|
-
* Remove multiple attendees from an event.
|
|
384
|
-
*/
|
|
385
|
-
removeBulk<ThrowOnError extends boolean = false>(options: Options<EventAttendeesRemoveBulkData, ThrowOnError>): import("./client").RequestResult<EventAttendeesRemoveBulkResponses, EventAttendeesRemoveBulkErrors, ThrowOnError, "fields">;
|
|
386
|
-
/**
|
|
387
|
-
* Add Event Attendees Bulk
|
|
388
|
-
*
|
|
389
|
-
* Add multiple contacts as attendees to an event.
|
|
390
|
-
*
|
|
391
|
-
* All contacts must belong to the user's contact list.
|
|
392
|
-
*/
|
|
393
|
-
addBulk<ThrowOnError extends boolean = false>(options: Options<EventAttendeesAddBulkData, ThrowOnError>): import("./client").RequestResult<EventAttendeesAddBulkResponses, EventAttendeesAddBulkErrors, ThrowOnError, "fields">;
|
|
394
|
-
/**
|
|
395
|
-
* Remove Event Attendee
|
|
396
|
-
*
|
|
397
|
-
* Remove an attendee from an event.
|
|
398
|
-
*/
|
|
399
|
-
remove<ThrowOnError extends boolean = false>(options: Options<EventAttendeesRemoveData, ThrowOnError>): import("./client").RequestResult<EventAttendeesRemoveResponses, EventAttendeesRemoveErrors, ThrowOnError, "fields">;
|
|
400
|
-
/**
|
|
401
|
-
* Update Event Attendee
|
|
402
|
-
*
|
|
403
|
-
* Update an attendee's information (status, notes, check-in status).
|
|
404
|
-
*/
|
|
405
|
-
update<ThrowOnError extends boolean = false>(options: Options<EventAttendeesUpdateData, ThrowOnError>): import("./client").RequestResult<EventAttendeesUpdateResponses, EventAttendeesUpdateErrors, ThrowOnError, "fields">;
|
|
406
|
-
/**
|
|
407
|
-
* Check In Attendee
|
|
408
|
-
*
|
|
409
|
-
* Check in an attendee to the event.
|
|
410
|
-
*/
|
|
411
|
-
checkIn<ThrowOnError extends boolean = false>(options: Options<EventAttendeesCheckInData, ThrowOnError>): import("./client").RequestResult<EventAttendeesCheckInResponses, EventAttendeesCheckInErrors, ThrowOnError, "fields">;
|
|
412
|
-
/**
|
|
413
|
-
* Update Attendees Status Bulk
|
|
414
|
-
*
|
|
415
|
-
* Update status for multiple attendees at once.
|
|
416
|
-
*/
|
|
417
|
-
updateBulkStatus<ThrowOnError extends boolean = false>(options: Options<EventAttendeesUpdateBulkStatusData, ThrowOnError>): import("./client").RequestResult<EventAttendeesUpdateBulkStatusResponses, EventAttendeesUpdateBulkStatusErrors, ThrowOnError, "fields">;
|
|
418
|
-
}
|
|
419
|
-
export declare class EventTimeline extends HeyApiClient {
|
|
420
|
-
/**
|
|
421
|
-
* Get event timeline
|
|
422
|
-
*
|
|
423
|
-
* Retrieve all milestones linked to a base event.
|
|
424
|
-
*/
|
|
425
|
-
get<ThrowOnError extends boolean = false>(options: Options<EventTimelineGetData, ThrowOnError>): import("./client").RequestResult<EventTimelineGetResponses, EventTimelineGetErrors, ThrowOnError, "fields">;
|
|
426
|
-
/**
|
|
427
|
-
* Get published event timeline
|
|
428
|
-
*
|
|
429
|
-
* Retrieve published milestones for a base event's published version. Returns only milestones that were linked at publish time AND are themselves published.
|
|
430
|
-
*/
|
|
431
|
-
getPublished<ThrowOnError extends boolean = false>(options: Options<EventTimelineGetPublishedData, ThrowOnError>): import("./client").RequestResult<EventTimelineGetPublishedResponses, EventTimelineGetPublishedErrors, ThrowOnError, "fields">;
|
|
432
|
-
/**
|
|
433
|
-
* Create and link milestone
|
|
434
|
-
*
|
|
435
|
-
* Create a new event and automatically link it as a milestone.
|
|
436
|
-
*/
|
|
437
|
-
createMilestone<ThrowOnError extends boolean = false>(options: Options<EventTimelineCreateMilestoneData, ThrowOnError>): import("./client").RequestResult<EventTimelineCreateMilestoneResponses, EventTimelineCreateMilestoneErrors, ThrowOnError, "fields">;
|
|
438
|
-
/**
|
|
439
|
-
* Link existing event
|
|
440
|
-
*
|
|
441
|
-
* Link an existing event as a milestone to a base event.
|
|
442
|
-
*/
|
|
443
|
-
linkMilestone<ThrowOnError extends boolean = false>(options: Options<EventTimelineLinkMilestoneData, ThrowOnError>): import("./client").RequestResult<EventTimelineLinkMilestoneResponses, EventTimelineLinkMilestoneErrors, ThrowOnError, "fields">;
|
|
444
|
-
/**
|
|
445
|
-
* Unlink milestone
|
|
446
|
-
*
|
|
447
|
-
* Remove a milestone link without deleting the event.
|
|
448
|
-
*/
|
|
449
|
-
unlink<ThrowOnError extends boolean = false>(options: Options<EventTimelineUnlinkData, ThrowOnError>): import("./client").RequestResult<EventTimelineUnlinkResponses, EventTimelineUnlinkErrors, ThrowOnError, "fields">;
|
|
450
|
-
}
|
|
451
|
-
export declare class EventDocuments extends HeyApiClient {
|
|
452
|
-
/**
|
|
453
|
-
* Remove Document From Event
|
|
454
|
-
*
|
|
455
|
-
* Remove a document from an event.
|
|
456
|
-
*/
|
|
457
|
-
remove<ThrowOnError extends boolean = false>(options: Options<EventDocumentsRemoveData, ThrowOnError>): import("./client").RequestResult<EventDocumentsRemoveResponses, EventDocumentsRemoveErrors, ThrowOnError, "fields">;
|
|
458
|
-
/**
|
|
459
|
-
* Add Document To Event
|
|
460
|
-
*
|
|
461
|
-
* Associate a document with an event.
|
|
462
|
-
*/
|
|
463
|
-
addDocument<ThrowOnError extends boolean = false>(options: Options<EventDocumentsAddDocumentData, ThrowOnError>): import("./client").RequestResult<EventDocumentsAddDocumentResponses, EventDocumentsAddDocumentErrors, ThrowOnError, "fields">;
|
|
464
|
-
/**
|
|
465
|
-
* Get Event Documents
|
|
466
|
-
*
|
|
467
|
-
* Get all documents for an event.
|
|
468
|
-
*/
|
|
469
|
-
getDocuments<ThrowOnError extends boolean = false>(options: Options<EventDocumentsGetDocumentsData, ThrowOnError>): import("./client").RequestResult<EventDocumentsGetDocumentsResponses, EventDocumentsGetDocumentsErrors, ThrowOnError, "fields">;
|
|
470
|
-
}
|
|
471
|
-
export declare class EventLocation extends HeyApiClient {
|
|
472
|
-
/**
|
|
473
|
-
* Get Event Location
|
|
474
|
-
*
|
|
475
|
-
* Get the location details for an event.
|
|
476
|
-
*/
|
|
477
|
-
get<ThrowOnError extends boolean = false>(options: Options<EventLocationGetData, ThrowOnError>): import("./client").RequestResult<EventLocationGetResponses, EventLocationGetErrors, ThrowOnError, "fields">;
|
|
478
|
-
/**
|
|
479
|
-
* Update Event Location
|
|
480
|
-
*
|
|
481
|
-
* Update the location details for an event.
|
|
482
|
-
*/
|
|
483
|
-
update<ThrowOnError extends boolean = false>(options: Options<EventLocationUpdateData, ThrowOnError>): import("./client").RequestResult<EventLocationUpdateResponses, EventLocationUpdateErrors, ThrowOnError, "fields">;
|
|
484
|
-
}
|
|
485
|
-
export declare class Space extends HeyApiClient {
|
|
486
|
-
/**
|
|
487
|
-
* Test Auth
|
|
488
|
-
*
|
|
489
|
-
* Test endpoint to verify authentication
|
|
490
|
-
*/
|
|
491
|
-
testAuth<ThrowOnError extends boolean = false>(options?: Options<SpaceTestAuthData, ThrowOnError>): import("./client").RequestResult<SpaceTestAuthResponses, SpaceTestAuthErrors, ThrowOnError, "fields">;
|
|
492
|
-
/**
|
|
493
|
-
* Update Space
|
|
494
|
-
*/
|
|
495
|
-
update<ThrowOnError extends boolean = false>(options: Options<SpaceUpdateData, ThrowOnError>): import("./client").RequestResult<SpaceUpdateResponses, SpaceUpdateErrors, ThrowOnError, "fields">;
|
|
496
|
-
/**
|
|
497
|
-
* Publish Space
|
|
498
|
-
*/
|
|
499
|
-
publish<ThrowOnError extends boolean = false>(options: Options<SpacePublishData, ThrowOnError>): import("./client").RequestResult<SpacePublishResponses, SpacePublishErrors, ThrowOnError, "fields">;
|
|
500
|
-
/**
|
|
501
|
-
* Archive Space
|
|
502
|
-
*/
|
|
503
|
-
archive<ThrowOnError extends boolean = false>(options: Options<SpaceArchiveData, ThrowOnError>): import("./client").RequestResult<SpaceArchiveResponses, SpaceArchiveErrors, ThrowOnError, "fields">;
|
|
504
|
-
/**
|
|
505
|
-
* Update Space Member Role
|
|
506
|
-
*
|
|
507
|
-
* Update a space member's role
|
|
508
|
-
*/
|
|
509
|
-
updateMemberRole<ThrowOnError extends boolean = false>(options: Options<SpaceUpdateMemberRoleData, ThrowOnError>): import("./client").RequestResult<SpaceUpdateMemberRoleResponses, SpaceUpdateMemberRoleErrors, ThrowOnError, "fields">;
|
|
510
|
-
/**
|
|
511
|
-
* Transfer Space
|
|
512
|
-
*
|
|
513
|
-
* Transfer a personal space to an organization.
|
|
514
|
-
*
|
|
515
|
-
* This endpoint allows the creator of a personal space to transfer ownership
|
|
516
|
-
* to an organization they are a member of with owner or admin privileges.
|
|
517
|
-
*
|
|
518
|
-
* Requirements:
|
|
519
|
-
* - Space must be personal (org_id IS NULL)
|
|
520
|
-
* - Caller must be the space creator
|
|
521
|
-
* - Caller must be owner or admin of the target organization
|
|
522
|
-
*
|
|
523
|
-
* Args:
|
|
524
|
-
* space_id: ID of the space to transfer
|
|
525
|
-
* request: Transfer request containing target_org_id
|
|
526
|
-
*
|
|
527
|
-
* Returns:
|
|
528
|
-
* TransferSpaceResponse: Transfer status and metadata
|
|
529
|
-
*
|
|
530
|
-
* Raises:
|
|
531
|
-
* HTTPException:
|
|
532
|
-
* - 400: Invalid request (already org-scoped, not creator, etc.)
|
|
533
|
-
* - 403: Permission denied (not org owner/admin)
|
|
534
|
-
* - 404: Space or organization not found
|
|
535
|
-
* - 500: Server error
|
|
536
|
-
*/
|
|
537
|
-
transfer<ThrowOnError extends boolean = false>(options: Options<SpaceTransferData, ThrowOnError>): import("./client").RequestResult<SpaceTransferResponses, SpaceTransferErrors, ThrowOnError, "fields">;
|
|
538
|
-
/**
|
|
539
|
-
* Bulk Update Space Parent
|
|
540
|
-
*
|
|
541
|
-
* Bulk update parent relationship for multiple spaces
|
|
542
|
-
*/
|
|
543
|
-
bulkUpdateParent<ThrowOnError extends boolean = false>(options: Options<SpaceBulkUpdateParentData, ThrowOnError>): import("./client").RequestResult<SpaceBulkUpdateParentResponses, SpaceBulkUpdateParentErrors, ThrowOnError, "fields">;
|
|
544
|
-
/**
|
|
545
|
-
* Get latest published space version
|
|
546
|
-
*
|
|
547
|
-
* Retrieve the most recent published version of a space
|
|
548
|
-
*/
|
|
549
|
-
getLatestVersion<ThrowOnError extends boolean = false>(options: Options<SpaceGetLatestVersionData, ThrowOnError>): import("./client").RequestResult<SpaceGetLatestVersionResponses, SpaceGetLatestVersionErrors, ThrowOnError, "fields">;
|
|
550
|
-
/**
|
|
551
|
-
* Get User Space Roles
|
|
552
|
-
*
|
|
553
|
-
* Get all space roles for a user in a specific space.
|
|
554
|
-
*
|
|
555
|
-
* Requires space read permissions.
|
|
556
|
-
*/
|
|
557
|
-
getUserRoles<ThrowOnError extends boolean = false>(options: Options<SpaceGetUserRolesData, ThrowOnError>): import("./client").RequestResult<SpaceGetUserRolesResponses, SpaceGetUserRolesErrors, ThrowOnError, "fields">;
|
|
558
|
-
/**
|
|
559
|
-
* Assign User To Space Role
|
|
560
|
-
*
|
|
561
|
-
* Assign a user to a space role.
|
|
562
|
-
*
|
|
563
|
-
* Requires space member management permissions.
|
|
564
|
-
*/
|
|
565
|
-
assignUserToRole<ThrowOnError extends boolean = false>(options: Options<SpaceAssignUserToRoleData, ThrowOnError>): import("./client").RequestResult<SpaceAssignUserToRoleResponses, SpaceAssignUserToRoleErrors, ThrowOnError, "fields">;
|
|
566
|
-
}
|
|
567
|
-
export declare class Spaces extends HeyApiClient {
|
|
568
|
-
/**
|
|
569
|
-
* Get Space List
|
|
570
|
-
*/
|
|
571
|
-
list<ThrowOnError extends boolean = false>(options?: Options<SpacesListData, ThrowOnError>): import("./client").RequestResult<SpacesListResponses, SpacesListErrors, ThrowOnError, "fields">;
|
|
572
|
-
/**
|
|
573
|
-
* Create Space
|
|
574
|
-
*/
|
|
575
|
-
createSpace<ThrowOnError extends boolean = false>(options: Options<SpacesCreateSpaceData, ThrowOnError>): import("./client").RequestResult<SpacesCreateSpaceResponses, SpacesCreateSpaceErrors, ThrowOnError, "fields">;
|
|
576
|
-
/**
|
|
577
|
-
* Delete Space
|
|
578
|
-
*/
|
|
579
|
-
deleteById<ThrowOnError extends boolean = false>(options: Options<SpacesDeleteByIdData, ThrowOnError>): import("./client").RequestResult<SpacesDeleteByIdResponses, SpacesDeleteByIdErrors, ThrowOnError, "fields">;
|
|
580
|
-
/**
|
|
581
|
-
* Get Space By Id
|
|
582
|
-
*/
|
|
583
|
-
getById<ThrowOnError extends boolean = false>(options: Options<SpacesGetByIdData, ThrowOnError>): import("./client").RequestResult<SpacesGetByIdResponses, SpacesGetByIdErrors, ThrowOnError, "fields">;
|
|
584
|
-
/**
|
|
585
|
-
* Create Space With Parent
|
|
586
|
-
*
|
|
587
|
-
* Create a space with parent relationship and inheritance settings
|
|
588
|
-
*/
|
|
589
|
-
createWithParent<ThrowOnError extends boolean = false>(options: Options<SpacesCreateWithParentData, ThrowOnError>): import("./client").RequestResult<SpacesCreateWithParentResponses, SpacesCreateWithParentErrors, ThrowOnError, "fields">;
|
|
590
|
-
/**
|
|
591
|
-
* Publish space
|
|
592
|
-
*
|
|
593
|
-
* Publish current space state as immutable version for community discovery
|
|
594
|
-
*/
|
|
595
|
-
publishVersion<ThrowOnError extends boolean = false>(options: Options<SpacesPublishVersionData, ThrowOnError>): import("./client").RequestResult<SpacesPublishVersionResponses, SpacesPublishVersionErrors, ThrowOnError, "fields">;
|
|
596
|
-
/**
|
|
597
|
-
* Get Space Members
|
|
598
|
-
*
|
|
599
|
-
* Get all members of a space
|
|
600
|
-
*/
|
|
601
|
-
getMembers<ThrowOnError extends boolean = false>(options: Options<SpacesGetMembersData, ThrowOnError>): import("./client").RequestResult<SpacesGetMembersResponses, SpacesGetMembersErrors, ThrowOnError, "fields">;
|
|
602
|
-
/**
|
|
603
|
-
* Add Space Member
|
|
604
|
-
*
|
|
605
|
-
* Add a member to a space
|
|
606
|
-
*/
|
|
607
|
-
addMember<ThrowOnError extends boolean = false>(options: Options<SpacesAddMemberData, ThrowOnError>): import("./client").RequestResult<SpacesAddMemberResponses, SpacesAddMemberErrors, ThrowOnError, "fields">;
|
|
608
|
-
/**
|
|
609
|
-
* Remove Space Member
|
|
610
|
-
*
|
|
611
|
-
* Remove a member from a space
|
|
612
|
-
*/
|
|
613
|
-
removeMember<ThrowOnError extends boolean = false>(options: Options<SpacesRemoveMemberData, ThrowOnError>): import("./client").RequestResult<SpacesRemoveMemberResponses, SpacesRemoveMemberErrors, ThrowOnError, "fields">;
|
|
614
|
-
/**
|
|
615
|
-
* Get Joinable Spaces By User
|
|
616
|
-
*
|
|
617
|
-
* Get spaces owned by a user that the current viewer can join.
|
|
618
|
-
*
|
|
619
|
-
* This endpoint returns spaces where the target user is an owner and the current
|
|
620
|
-
* viewer has permission to join based on visibility rules:
|
|
621
|
-
* - PUBLIC: Always visible to all users
|
|
622
|
-
* - TENANT: Visible only to users in the same organization
|
|
623
|
-
* - MEMBERS_ONLY: Excluded from joinable list (requires approval)
|
|
624
|
-
*
|
|
625
|
-
* Args:
|
|
626
|
-
* user_id: UUID string of the user whose spaces to retrieve
|
|
627
|
-
* limit: Maximum number of spaces to return (default: 10, max: 12)
|
|
628
|
-
* prev: Previous ID for cursor-based pagination
|
|
629
|
-
* sort_by: Field to sort by (default: "created_at")
|
|
630
|
-
* sort_order: Sort order - "asc" or "desc" (default: "desc")
|
|
631
|
-
*
|
|
632
|
-
* Returns:
|
|
633
|
-
* List[GetSpaceListResponseDTO]: List of joinable spaces
|
|
634
|
-
*
|
|
635
|
-
* Raises:
|
|
636
|
-
* HTTPException: 401 for unauthorized access, 500 for server errors
|
|
637
|
-
*/
|
|
638
|
-
getJoinableByUser<ThrowOnError extends boolean = false>(options: Options<SpacesGetJoinableByUserData, ThrowOnError>): import("./client").RequestResult<SpacesGetJoinableByUserResponses, SpacesGetJoinableByUserErrors, ThrowOnError, "fields">;
|
|
639
|
-
/**
|
|
640
|
-
* Join Space
|
|
641
|
-
*
|
|
642
|
-
* Self-join the current user to a space if permitted.
|
|
643
|
-
*
|
|
644
|
-
* This endpoint allows the current user to join a space based on visibility rules:
|
|
645
|
-
* - PUBLIC: Anyone can join
|
|
646
|
-
* - TENANT: Only users in the same organization can join
|
|
647
|
-
* - MEMBERS_ONLY: Requires approval (returns 403)
|
|
648
|
-
*
|
|
649
|
-
* Args:
|
|
650
|
-
* space_id: ID of the space to join
|
|
651
|
-
*
|
|
652
|
-
* Returns:
|
|
653
|
-
* SpaceMemberResponse: Membership information after successful join
|
|
654
|
-
*
|
|
655
|
-
* Raises:
|
|
656
|
-
* HTTPException:
|
|
657
|
-
* - 404: Space not found
|
|
658
|
-
* - 403: Permission denied (wrong tenant or members-only space)
|
|
659
|
-
* - 409: Already a member
|
|
660
|
-
* - 500: Server error
|
|
661
|
-
*/
|
|
662
|
-
join<ThrowOnError extends boolean = false>(options: Options<SpacesJoinData, ThrowOnError>): import("./client").RequestResult<SpacesJoinResponses, SpacesJoinErrors, ThrowOnError, "fields">;
|
|
663
|
-
/**
|
|
664
|
-
* Get Space Children
|
|
665
|
-
*
|
|
666
|
-
* Get all child spaces of a given space
|
|
667
|
-
*/
|
|
668
|
-
listChildren<ThrowOnError extends boolean = false>(options: Options<SpacesListChildrenData, ThrowOnError>): import("./client").RequestResult<SpacesListChildrenResponses, SpacesListChildrenErrors, ThrowOnError, "fields">;
|
|
669
|
-
/**
|
|
670
|
-
* Detach Space From Parent
|
|
671
|
-
*
|
|
672
|
-
* Detach a space from its parent, making it standalone
|
|
673
|
-
*/
|
|
674
|
-
detachParent<ThrowOnError extends boolean = false>(options: Options<SpacesDetachParentData, ThrowOnError>): import("./client").RequestResult<SpacesDetachParentResponses, SpacesDetachParentErrors, ThrowOnError, "fields">;
|
|
675
|
-
/**
|
|
676
|
-
* Get Space Parent
|
|
677
|
-
*
|
|
678
|
-
* Get the parent space of a given space
|
|
679
|
-
*/
|
|
680
|
-
getParent<ThrowOnError extends boolean = false>(options: Options<SpacesGetParentData, ThrowOnError>): import("./client").RequestResult<SpacesGetParentResponses, SpacesGetParentErrors, ThrowOnError, "fields">;
|
|
681
|
-
/**
|
|
682
|
-
* Update Space Parent
|
|
683
|
-
*
|
|
684
|
-
* Update the parent relationship of a space
|
|
685
|
-
*/
|
|
686
|
-
updateParent<ThrowOnError extends boolean = false>(options: Options<SpacesUpdateParentData, ThrowOnError>): import("./client").RequestResult<SpacesUpdateParentResponses, SpacesUpdateParentErrors, ThrowOnError, "fields">;
|
|
687
|
-
/**
|
|
688
|
-
* Get Space Hierarchy
|
|
689
|
-
*
|
|
690
|
-
* Get the full hierarchy tree starting from a given space
|
|
691
|
-
*/
|
|
692
|
-
getHierarchy<ThrowOnError extends boolean = false>(options: Options<SpacesGetHierarchyData, ThrowOnError>): import("./client").RequestResult<SpacesGetHierarchyResponses, SpacesGetHierarchyErrors, ThrowOnError, "fields">;
|
|
693
|
-
/**
|
|
694
|
-
* Unpublish space
|
|
695
|
-
*
|
|
696
|
-
* Mark space as draft (unpublished), preserving version history
|
|
697
|
-
*/
|
|
698
|
-
unpublish<ThrowOnError extends boolean = false>(options: Options<SpacesUnpublishData, ThrowOnError>): import("./client").RequestResult<SpacesUnpublishResponses, SpacesUnpublishErrors, ThrowOnError, "fields">;
|
|
699
|
-
/**
|
|
700
|
-
* List space versions
|
|
701
|
-
*
|
|
702
|
-
* Get all published versions of a space
|
|
703
|
-
*/
|
|
704
|
-
listVersions<ThrowOnError extends boolean = false>(options: Options<SpacesListVersionsData, ThrowOnError>): import("./client").RequestResult<SpacesListVersionsResponses, SpacesListVersionsErrors, ThrowOnError, "fields">;
|
|
705
|
-
/**
|
|
706
|
-
* Get specific space version
|
|
707
|
-
*
|
|
708
|
-
* Retrieve a specific published version of a space
|
|
709
|
-
*/
|
|
710
|
-
getVersion<ThrowOnError extends boolean = false>(options: Options<SpacesGetVersionData, ThrowOnError>): import("./client").RequestResult<SpacesGetVersionResponses, SpacesGetVersionErrors, ThrowOnError, "fields">;
|
|
711
|
-
/**
|
|
712
|
-
* Compare space versions
|
|
713
|
-
*
|
|
714
|
-
* Compare two versions and see what changed
|
|
715
|
-
*/
|
|
716
|
-
compareVersions<ThrowOnError extends boolean = false>(options: Options<SpacesCompareVersionsData, ThrowOnError>): import("./client").RequestResult<SpacesCompareVersionsResponses, SpacesCompareVersionsErrors, ThrowOnError, "fields">;
|
|
717
|
-
/**
|
|
718
|
-
* Rollback space to version
|
|
719
|
-
*
|
|
720
|
-
* Restore space to a specific published version
|
|
721
|
-
*/
|
|
722
|
-
rollback<ThrowOnError extends boolean = false>(options: Options<SpacesRollbackData, ThrowOnError>): import("./client").RequestResult<SpacesRollbackResponses, SpacesRollbackErrors, ThrowOnError, "fields">;
|
|
723
|
-
/**
|
|
724
|
-
* Remove User From Space Role
|
|
725
|
-
*
|
|
726
|
-
* Remove a user from a space role.
|
|
727
|
-
*
|
|
728
|
-
* Requires space member management permissions.
|
|
729
|
-
*/
|
|
730
|
-
removeUserFromRole<ThrowOnError extends boolean = false>(options: Options<SpacesRemoveUserFromRoleData, ThrowOnError>): import("./client").RequestResult<SpacesRemoveUserFromRoleResponses, SpacesRemoveUserFromRoleErrors, ThrowOnError, "fields">;
|
|
731
|
-
}
|
|
732
|
-
export declare class SpaceRoles extends HeyApiClient {
|
|
733
|
-
/**
|
|
734
|
-
* List Space Roles
|
|
735
|
-
*
|
|
736
|
-
* List all roles for a space.
|
|
737
|
-
*
|
|
738
|
-
* Requires space read permissions.
|
|
739
|
-
*/
|
|
740
|
-
listRoles<ThrowOnError extends boolean = false>(options: Options<SpaceRolesListRolesData, ThrowOnError>): import("./client").RequestResult<SpaceRolesListRolesResponses, SpaceRolesListRolesErrors, ThrowOnError, "fields">;
|
|
741
|
-
/**
|
|
742
|
-
* Create Space Role
|
|
743
|
-
*
|
|
744
|
-
* Create a new role for a space.
|
|
745
|
-
*
|
|
746
|
-
* Requires space management permissions.
|
|
747
|
-
*/
|
|
748
|
-
create<ThrowOnError extends boolean = false>(options: Options<SpaceRolesCreateData, ThrowOnError>): import("./client").RequestResult<SpaceRolesCreateResponses, SpaceRolesCreateErrors, ThrowOnError, "fields">;
|
|
749
|
-
/**
|
|
750
|
-
* Delete Space Role
|
|
751
|
-
*
|
|
752
|
-
* Delete a space role.
|
|
753
|
-
*
|
|
754
|
-
* Requires space management permissions.
|
|
755
|
-
*/
|
|
756
|
-
delete<ThrowOnError extends boolean = false>(options: Options<SpaceRolesDeleteData, ThrowOnError>): import("./client").RequestResult<SpaceRolesDeleteResponses, SpaceRolesDeleteErrors, ThrowOnError, "fields">;
|
|
757
|
-
/**
|
|
758
|
-
* Get Space Role
|
|
759
|
-
*
|
|
760
|
-
* Get a specific space role by ID.
|
|
761
|
-
*
|
|
762
|
-
* Requires space read permissions.
|
|
763
|
-
*/
|
|
764
|
-
get<ThrowOnError extends boolean = false>(options: Options<SpaceRolesGetData, ThrowOnError>): import("./client").RequestResult<SpaceRolesGetResponses, SpaceRolesGetErrors, ThrowOnError, "fields">;
|
|
765
|
-
/**
|
|
766
|
-
* Update Space Role
|
|
767
|
-
*
|
|
768
|
-
* Update a space role.
|
|
769
|
-
*
|
|
770
|
-
* Requires space management permissions.
|
|
771
|
-
*/
|
|
772
|
-
updateRole<ThrowOnError extends boolean = false>(options: Options<SpaceRolesUpdateRoleData, ThrowOnError>): import("./client").RequestResult<SpaceRolesUpdateRoleResponses, SpaceRolesUpdateRoleErrors, ThrowOnError, "fields">;
|
|
773
|
-
/**
|
|
774
|
-
* Assign Permission To Space Role
|
|
775
|
-
*
|
|
776
|
-
* Assign a permission to a space role.
|
|
777
|
-
*
|
|
778
|
-
* Requires space management permissions.
|
|
779
|
-
*/
|
|
780
|
-
assignPermission<ThrowOnError extends boolean = false>(options: Options<SpaceRolesAssignPermissionData, ThrowOnError>): import("./client").RequestResult<SpaceRolesAssignPermissionResponses, SpaceRolesAssignPermissionErrors, ThrowOnError, "fields">;
|
|
781
|
-
/**
|
|
782
|
-
* Remove Permission From Space Role
|
|
783
|
-
*
|
|
784
|
-
* Remove a permission from a space role.
|
|
785
|
-
*
|
|
786
|
-
* Requires space management permissions.
|
|
787
|
-
*/
|
|
788
|
-
removePermission<ThrowOnError extends boolean = false>(options: Options<SpaceRolesRemovePermissionData, ThrowOnError>): import("./client").RequestResult<SpaceRolesRemovePermissionResponses, SpaceRolesRemovePermissionErrors, ThrowOnError, "fields">;
|
|
789
|
-
}
|
|
790
|
-
export declare class SpaceContacts extends HeyApiClient {
|
|
791
|
-
/**
|
|
792
|
-
* Get Space Contacts
|
|
793
|
-
*
|
|
794
|
-
* Get all contacts for a specific space.
|
|
795
|
-
*
|
|
796
|
-
* Args:
|
|
797
|
-
* space_id: Space ID
|
|
798
|
-
* limit: Maximum number of contacts to return
|
|
799
|
-
* offset: Number of contacts to skip
|
|
800
|
-
* current_user: Current authenticated user
|
|
801
|
-
* tenant_ctx: Tenant context
|
|
802
|
-
* service: Space contact service
|
|
803
|
-
*
|
|
804
|
-
* Returns:
|
|
805
|
-
* List of space contacts with total count
|
|
806
|
-
*/
|
|
807
|
-
getContactsBySpace<ThrowOnError extends boolean = false>(options: Options<SpaceContactsGetContactsBySpaceData, ThrowOnError>): import("./client").RequestResult<SpaceContactsGetContactsBySpaceResponses, SpaceContactsGetContactsBySpaceErrors, ThrowOnError, "fields">;
|
|
808
|
-
/**
|
|
809
|
-
* Add Contact To Space
|
|
810
|
-
*
|
|
811
|
-
* Add a contact to a space.
|
|
812
|
-
*
|
|
813
|
-
* Args:
|
|
814
|
-
* space_id: Space ID
|
|
815
|
-
* request: Space contact creation request
|
|
816
|
-
* current_user: Current authenticated user
|
|
817
|
-
* tenant_ctx: Tenant context
|
|
818
|
-
* service: Space contact service
|
|
819
|
-
*
|
|
820
|
-
* Returns:
|
|
821
|
-
* Created space contact
|
|
822
|
-
*/
|
|
823
|
-
add<ThrowOnError extends boolean = false>(options: Options<SpaceContactsAddData, ThrowOnError>): import("./client").RequestResult<SpaceContactsAddResponses, SpaceContactsAddErrors, ThrowOnError, "fields">;
|
|
824
|
-
/**
|
|
825
|
-
* Get Contact Spaces
|
|
826
|
-
*
|
|
827
|
-
* Get all spaces for a specific contact.
|
|
828
|
-
*
|
|
829
|
-
* Args:
|
|
830
|
-
* contact_id: Contact ID
|
|
831
|
-
* limit: Maximum number of spaces to return
|
|
832
|
-
* offset: Number of spaces to skip
|
|
833
|
-
* current_user: Current authenticated user
|
|
834
|
-
* tenant_ctx: Tenant context
|
|
835
|
-
* service: Space contact service
|
|
836
|
-
*
|
|
837
|
-
* Returns:
|
|
838
|
-
* List of space contacts
|
|
839
|
-
*/
|
|
840
|
-
getSpacesByContact<ThrowOnError extends boolean = false>(options: Options<SpaceContactsGetSpacesByContactData, ThrowOnError>): import("./client").RequestResult<SpaceContactsGetSpacesByContactResponses, SpaceContactsGetSpacesByContactErrors, ThrowOnError, "fields">;
|
|
841
|
-
/**
|
|
842
|
-
* Remove Contact From Space
|
|
843
|
-
*
|
|
844
|
-
* Remove a contact from a space.
|
|
845
|
-
*
|
|
846
|
-
* Args:
|
|
847
|
-
* space_contact_id: Space contact relationship ID
|
|
848
|
-
* current_user: Current authenticated user
|
|
849
|
-
* tenant_ctx: Tenant context
|
|
850
|
-
* service: Space contact service
|
|
851
|
-
*
|
|
852
|
-
* Returns:
|
|
853
|
-
* Success message
|
|
854
|
-
*/
|
|
855
|
-
remove<ThrowOnError extends boolean = false>(options: Options<SpaceContactsRemoveData, ThrowOnError>): import("./client").RequestResult<SpaceContactsRemoveResponses, SpaceContactsRemoveErrors, ThrowOnError, "fields">;
|
|
856
|
-
/**
|
|
857
|
-
* Get Space Contact
|
|
858
|
-
*
|
|
859
|
-
* Get space contact by ID.
|
|
860
|
-
*
|
|
861
|
-
* Args:
|
|
862
|
-
* space_contact_id: Space contact relationship ID
|
|
863
|
-
* current_user: Current authenticated user
|
|
864
|
-
* tenant_ctx: Tenant context
|
|
865
|
-
* service: Space contact service
|
|
866
|
-
*
|
|
867
|
-
* Returns:
|
|
868
|
-
* Space contact details
|
|
869
|
-
*/
|
|
870
|
-
get<ThrowOnError extends boolean = false>(options: Options<SpaceContactsGetData, ThrowOnError>): import("./client").RequestResult<SpaceContactsGetResponses, SpaceContactsGetErrors, ThrowOnError, "fields">;
|
|
871
|
-
/**
|
|
872
|
-
* Bulk Remove Contacts From Space
|
|
873
|
-
*
|
|
874
|
-
* Bulk remove contacts from a space.
|
|
875
|
-
*
|
|
876
|
-
* Args:
|
|
877
|
-
* space_id: Space ID
|
|
878
|
-
* contact_ids: List of contact IDs to remove
|
|
879
|
-
* current_user: Current authenticated user
|
|
880
|
-
* tenant_ctx: Tenant context
|
|
881
|
-
* service: Space contact service
|
|
882
|
-
*
|
|
883
|
-
* Returns:
|
|
884
|
-
* Number of contacts removed
|
|
885
|
-
*/
|
|
886
|
-
bulkDelete<ThrowOnError extends boolean = false>(options: Options<SpaceContactsBulkDeleteData, ThrowOnError>): import("./client").RequestResult<SpaceContactsBulkDeleteResponses, SpaceContactsBulkDeleteErrors, ThrowOnError, "fields">;
|
|
887
|
-
/**
|
|
888
|
-
* Bulk Add Contacts To Space
|
|
889
|
-
*
|
|
890
|
-
* Add multiple contacts to a space.
|
|
891
|
-
*
|
|
892
|
-
* Args:
|
|
893
|
-
* space_id: Space ID
|
|
894
|
-
* contact_ids: List of contact IDs to add
|
|
895
|
-
* current_user: Current authenticated user
|
|
896
|
-
* tenant_ctx: Tenant context
|
|
897
|
-
* service: Space contact service
|
|
898
|
-
*
|
|
899
|
-
* Returns:
|
|
900
|
-
* List of created space contacts
|
|
901
|
-
*/
|
|
902
|
-
addBulk<ThrowOnError extends boolean = false>(options: Options<SpaceContactsAddBulkData, ThrowOnError>): import("./client").RequestResult<SpaceContactsAddBulkResponses, SpaceContactsAddBulkErrors, ThrowOnError, "fields">;
|
|
903
|
-
/**
|
|
904
|
-
* Count Space Contacts
|
|
905
|
-
*
|
|
906
|
-
* Count contacts in a space.
|
|
907
|
-
*
|
|
908
|
-
* Args:
|
|
909
|
-
* space_id: Space ID
|
|
910
|
-
* current_user: Current authenticated user
|
|
911
|
-
* tenant_ctx: Tenant context
|
|
912
|
-
* service: Space contact service
|
|
913
|
-
*
|
|
914
|
-
* Returns:
|
|
915
|
-
* Number of contacts in space
|
|
916
|
-
*/
|
|
917
|
-
count<ThrowOnError extends boolean = false>(options: Options<SpaceContactsCountData, ThrowOnError>): import("./client").RequestResult<SpaceContactsCountResponses, SpaceContactsCountErrors, ThrowOnError, "fields">;
|
|
918
|
-
}
|
|
919
|
-
export declare class SpaceEvents extends HeyApiClient {
|
|
920
|
-
/**
|
|
921
|
-
* Get Space Events
|
|
922
|
-
*
|
|
923
|
-
* Get all events for a specific space.
|
|
924
|
-
*
|
|
925
|
-
* Args:
|
|
926
|
-
* space_id: Space ID
|
|
927
|
-
* limit: Maximum number of events to return
|
|
928
|
-
* offset: Number of events to skip
|
|
929
|
-
* current_user: Current authenticated user
|
|
930
|
-
* tenant_ctx: Tenant context
|
|
931
|
-
* service: Space event service
|
|
932
|
-
*
|
|
933
|
-
* Returns:
|
|
934
|
-
* List of space events with total count
|
|
935
|
-
*/
|
|
936
|
-
get<ThrowOnError extends boolean = false>(options: Options<SpaceEventsGetData, ThrowOnError>): import("./client").RequestResult<SpaceEventsGetResponses, SpaceEventsGetErrors, ThrowOnError, "fields">;
|
|
937
|
-
/**
|
|
938
|
-
* Add Event To Space
|
|
939
|
-
*
|
|
940
|
-
* Add an event to a space.
|
|
941
|
-
*
|
|
942
|
-
* Args:
|
|
943
|
-
* space_id: Space ID
|
|
944
|
-
* request: Space event creation request
|
|
945
|
-
* current_user: Current authenticated user
|
|
946
|
-
* tenant_ctx: Tenant context
|
|
947
|
-
* service: Space event service
|
|
948
|
-
*
|
|
949
|
-
* Returns:
|
|
950
|
-
* Created space event
|
|
951
|
-
*/
|
|
952
|
-
add<ThrowOnError extends boolean = false>(options: Options<SpaceEventsAddData, ThrowOnError>): import("./client").RequestResult<SpaceEventsAddResponses, SpaceEventsAddErrors, ThrowOnError, "fields">;
|
|
953
|
-
/**
|
|
954
|
-
* Get Event Spaces
|
|
955
|
-
*
|
|
956
|
-
* Get all spaces for a specific event.
|
|
957
|
-
*
|
|
958
|
-
* Args:
|
|
959
|
-
* event_id: Event ID
|
|
960
|
-
* limit: Maximum number of spaces to return
|
|
961
|
-
* offset: Number of spaces to skip
|
|
962
|
-
* current_user: Current authenticated user
|
|
963
|
-
* tenant_ctx: Tenant context
|
|
964
|
-
* service: Space event service
|
|
965
|
-
*
|
|
966
|
-
* Returns:
|
|
967
|
-
* List of space events
|
|
968
|
-
*/
|
|
969
|
-
getEventSpaces<ThrowOnError extends boolean = false>(options: Options<SpaceEventsGetEventSpacesData, ThrowOnError>): import("./client").RequestResult<SpaceEventsGetEventSpacesResponses, SpaceEventsGetEventSpacesErrors, ThrowOnError, "fields">;
|
|
970
|
-
/**
|
|
971
|
-
* Remove Event From Space
|
|
972
|
-
*
|
|
973
|
-
* Remove an event from a space.
|
|
974
|
-
*
|
|
975
|
-
* Args:
|
|
976
|
-
* space_event_id: Space event relationship ID
|
|
977
|
-
* current_user: Current authenticated user
|
|
978
|
-
* tenant_ctx: Tenant context
|
|
979
|
-
* service: Space event service
|
|
980
|
-
*
|
|
981
|
-
* Returns:
|
|
982
|
-
* Success message
|
|
983
|
-
*/
|
|
984
|
-
removeEvent<ThrowOnError extends boolean = false>(options: Options<SpaceEventsRemoveEventData, ThrowOnError>): import("./client").RequestResult<SpaceEventsRemoveEventResponses, SpaceEventsRemoveEventErrors, ThrowOnError, "fields">;
|
|
985
|
-
/**
|
|
986
|
-
* Get Space Event
|
|
987
|
-
*
|
|
988
|
-
* Get space event by ID.
|
|
989
|
-
*
|
|
990
|
-
* Args:
|
|
991
|
-
* space_event_id: Space event relationship ID
|
|
992
|
-
* current_user: Current authenticated user
|
|
993
|
-
* tenant_ctx: Tenant context
|
|
994
|
-
* service: Space event service
|
|
995
|
-
*
|
|
996
|
-
* Returns:
|
|
997
|
-
* Space event details
|
|
998
|
-
*/
|
|
999
|
-
getById<ThrowOnError extends boolean = false>(options: Options<SpaceEventsGetByIdData, ThrowOnError>): import("./client").RequestResult<SpaceEventsGetByIdResponses, SpaceEventsGetByIdErrors, ThrowOnError, "fields">;
|
|
1000
|
-
/**
|
|
1001
|
-
* Bulk Remove Events From Space
|
|
1002
|
-
*
|
|
1003
|
-
* Bulk remove events from a space.
|
|
1004
|
-
*
|
|
1005
|
-
* Args:
|
|
1006
|
-
* space_id: Space ID
|
|
1007
|
-
* event_ids: List of event IDs to remove
|
|
1008
|
-
* current_user: Current authenticated user
|
|
1009
|
-
* tenant_ctx: Tenant context
|
|
1010
|
-
* service: Space event service
|
|
1011
|
-
*
|
|
1012
|
-
* Returns:
|
|
1013
|
-
* Number of events removed
|
|
1014
|
-
*/
|
|
1015
|
-
bulkRemove<ThrowOnError extends boolean = false>(options: Options<SpaceEventsBulkRemoveData, ThrowOnError>): import("./client").RequestResult<SpaceEventsBulkRemoveResponses, SpaceEventsBulkRemoveErrors, ThrowOnError, "fields">;
|
|
1016
|
-
/**
|
|
1017
|
-
* Bulk Add Events To Space
|
|
1018
|
-
*
|
|
1019
|
-
* Add multiple events to a space.
|
|
1020
|
-
*
|
|
1021
|
-
* Args:
|
|
1022
|
-
* space_id: Space ID
|
|
1023
|
-
* event_ids: List of event IDs to add
|
|
1024
|
-
* current_user: Current authenticated user
|
|
1025
|
-
* tenant_ctx: Tenant context
|
|
1026
|
-
* service: Space event service
|
|
1027
|
-
*
|
|
1028
|
-
* Returns:
|
|
1029
|
-
* List of created space events
|
|
1030
|
-
*/
|
|
1031
|
-
bulkAdd<ThrowOnError extends boolean = false>(options: Options<SpaceEventsBulkAddData, ThrowOnError>): import("./client").RequestResult<SpaceEventsBulkAddResponses, SpaceEventsBulkAddErrors, ThrowOnError, "fields">;
|
|
1032
|
-
/**
|
|
1033
|
-
* Count Space Events
|
|
1034
|
-
*
|
|
1035
|
-
* Count events in a space.
|
|
1036
|
-
*
|
|
1037
|
-
* Args:
|
|
1038
|
-
* space_id: Space ID
|
|
1039
|
-
* current_user: Current authenticated user
|
|
1040
|
-
* tenant_ctx: Tenant context
|
|
1041
|
-
* service: Space event service
|
|
1042
|
-
*
|
|
1043
|
-
* Returns:
|
|
1044
|
-
* Number of events in space
|
|
1045
|
-
*/
|
|
1046
|
-
count<ThrowOnError extends boolean = false>(options: Options<SpaceEventsCountData, ThrowOnError>): import("./client").RequestResult<SpaceEventsCountResponses, SpaceEventsCountErrors, ThrowOnError, "fields">;
|
|
1047
|
-
}
|
|
1048
|
-
export declare class SpaceDocuments extends HeyApiClient {
|
|
1049
|
-
/**
|
|
1050
|
-
* Remove Document From Space
|
|
1051
|
-
*
|
|
1052
|
-
* Remove a document from a space.
|
|
1053
|
-
*/
|
|
1054
|
-
remove<ThrowOnError extends boolean = false>(options: Options<SpaceDocumentsRemoveData, ThrowOnError>): import("./client").RequestResult<SpaceDocumentsRemoveResponses, SpaceDocumentsRemoveErrors, ThrowOnError, "fields">;
|
|
1055
|
-
/**
|
|
1056
|
-
* Add Document To Space
|
|
1057
|
-
*
|
|
1058
|
-
* Associate a document with a space.
|
|
1059
|
-
*/
|
|
1060
|
-
add<ThrowOnError extends boolean = false>(options: Options<SpaceDocumentsAddData, ThrowOnError>): import("./client").RequestResult<SpaceDocumentsAddResponses, SpaceDocumentsAddErrors, ThrowOnError, "fields">;
|
|
1061
|
-
/**
|
|
1062
|
-
* Get Space Documents
|
|
1063
|
-
*
|
|
1064
|
-
* Get all documents for a space.
|
|
1065
|
-
*/
|
|
1066
|
-
get<ThrowOnError extends boolean = false>(options: Options<SpaceDocumentsGetData, ThrowOnError>): import("./client").RequestResult<SpaceDocumentsGetResponses, SpaceDocumentsGetErrors, ThrowOnError, "fields">;
|
|
1067
|
-
}
|
|
1068
|
-
export declare class Places extends HeyApiClient {
|
|
1069
|
-
/**
|
|
1070
|
-
* Get Place List
|
|
1071
|
-
*/
|
|
1072
|
-
list<ThrowOnError extends boolean = false>(options?: Options<PlacesListData, ThrowOnError>): import("./client").RequestResult<PlacesListResponses, PlacesListErrors, ThrowOnError, "fields">;
|
|
1073
|
-
/**
|
|
1074
|
-
* Create Place
|
|
1075
|
-
*/
|
|
1076
|
-
create<ThrowOnError extends boolean = false>(options: Options<PlacesCreateData, ThrowOnError>): import("./client").RequestResult<PlacesCreateResponses, PlacesCreateErrors, ThrowOnError, "fields">;
|
|
1077
|
-
/**
|
|
1078
|
-
* Delete Place
|
|
1079
|
-
*/
|
|
1080
|
-
delete<ThrowOnError extends boolean = false>(options: Options<PlacesDeleteData, ThrowOnError>): import("./client").RequestResult<PlacesDeleteResponses, PlacesDeleteErrors, ThrowOnError, "fields">;
|
|
1081
|
-
/**
|
|
1082
|
-
* Get Place By Id
|
|
1083
|
-
*/
|
|
1084
|
-
get<ThrowOnError extends boolean = false>(options: Options<PlacesGetData, ThrowOnError>): import("./client").RequestResult<PlacesGetResponses, PlacesGetErrors, ThrowOnError, "fields">;
|
|
1085
|
-
/**
|
|
1086
|
-
* Update Place
|
|
1087
|
-
*/
|
|
1088
|
-
update<ThrowOnError extends boolean = false>(options: Options<PlacesUpdateData, ThrowOnError>): import("./client").RequestResult<PlacesUpdateResponses, PlacesUpdateErrors, ThrowOnError, "fields">;
|
|
1089
|
-
}
|
|
1090
|
-
export declare class Place extends HeyApiClient {
|
|
1091
|
-
/**
|
|
1092
|
-
* Publish Place
|
|
1093
|
-
*/
|
|
1094
|
-
publish<ThrowOnError extends boolean = false>(options: Options<PlacePublishData, ThrowOnError>): import("./client").RequestResult<PlacePublishResponses, PlacePublishErrors, ThrowOnError, "fields">;
|
|
1095
|
-
/**
|
|
1096
|
-
* Archive Place
|
|
1097
|
-
*/
|
|
1098
|
-
archive<ThrowOnError extends boolean = false>(options: Options<PlaceArchiveData, ThrowOnError>): import("./client").RequestResult<PlaceArchiveResponses, PlaceArchiveErrors, ThrowOnError, "fields">;
|
|
1099
|
-
}
|
|
1100
|
-
export declare class Analytic extends HeyApiClient {
|
|
1101
|
-
/**
|
|
1102
|
-
* Get Analytic Totals
|
|
1103
|
-
*/
|
|
1104
|
-
getTotals<ThrowOnError extends boolean = false>(options?: Options<AnalyticGetTotalsData, ThrowOnError>): import("./client").RequestResult<AnalyticGetTotalsResponses, AnalyticGetTotalsErrors, ThrowOnError, "fields">;
|
|
1105
|
-
/**
|
|
1106
|
-
* Get Dashboard Analytics
|
|
1107
|
-
*/
|
|
1108
|
-
getDashboard<ThrowOnError extends boolean = false>(options?: Options<AnalyticGetDashboardData, ThrowOnError>): import("./client").RequestResult<AnalyticGetDashboardResponses, AnalyticGetDashboardErrors, ThrowOnError, "fields">;
|
|
1109
|
-
}
|
|
1110
|
-
export declare class Organizations extends HeyApiClient {
|
|
1111
|
-
/**
|
|
1112
|
-
* List Organizations
|
|
1113
|
-
*
|
|
1114
|
-
* List all organizations the current user belongs to.
|
|
1115
|
-
*/
|
|
1116
|
-
list<ThrowOnError extends boolean = false>(options?: Options<OrganizationsListData, ThrowOnError>): import("./client").RequestResult<OrganizationsListResponses, OrganizationsListErrors, ThrowOnError, "fields">;
|
|
1117
|
-
/**
|
|
1118
|
-
* Create Organization
|
|
1119
|
-
*
|
|
1120
|
-
* Create a new organization.
|
|
1121
|
-
*/
|
|
1122
|
-
create<ThrowOnError extends boolean = false>(options: Options<OrganizationsCreateData, ThrowOnError>): import("./client").RequestResult<OrganizationsCreateResponses, OrganizationsCreateErrors, ThrowOnError, "fields">;
|
|
1123
|
-
/**
|
|
1124
|
-
* Get Current Organization
|
|
1125
|
-
*
|
|
1126
|
-
* Get the current organization from JWT claims.
|
|
1127
|
-
* Returns the org that the user is currently authenticated for.
|
|
1128
|
-
*/
|
|
1129
|
-
getCurrent<ThrowOnError extends boolean = false>(options?: Options<OrganizationsGetCurrentData, ThrowOnError>): import("./client").RequestResult<OrganizationsGetCurrentResponses, OrganizationsGetCurrentErrors, ThrowOnError, "fields">;
|
|
1130
|
-
/**
|
|
1131
|
-
* Get Organization Invites Endpoint
|
|
1132
|
-
*
|
|
1133
|
-
* Get all pending invitations for an organization.
|
|
1134
|
-
*/
|
|
1135
|
-
getInvites<ThrowOnError extends boolean = false>(options: Options<OrganizationsGetInvitesData, ThrowOnError>): import("./client").RequestResult<OrganizationsGetInvitesResponses, OrganizationsGetInvitesErrors, ThrowOnError, "fields">;
|
|
1136
|
-
/**
|
|
1137
|
-
* Create Invite
|
|
1138
|
-
*
|
|
1139
|
-
* Create an invite to the organization. Requires owner or admin role.
|
|
1140
|
-
*/
|
|
1141
|
-
createInvite<ThrowOnError extends boolean = false>(options: Options<OrganizationsCreateInviteData, ThrowOnError>): import("./client").RequestResult<OrganizationsCreateInviteResponses, OrganizationsCreateInviteErrors, ThrowOnError, "fields">;
|
|
1142
|
-
/**
|
|
1143
|
-
* Delete Invite
|
|
1144
|
-
*
|
|
1145
|
-
* Delete/rescind an organization invite. Requires owner or admin role.
|
|
1146
|
-
*/
|
|
1147
|
-
deleteInvite<ThrowOnError extends boolean = false>(options: Options<OrganizationsDeleteInviteData, ThrowOnError>): import("./client").RequestResult<OrganizationsDeleteInviteResponses, OrganizationsDeleteInviteErrors, ThrowOnError, "fields">;
|
|
1148
|
-
/**
|
|
1149
|
-
* Archive Organization Endpoint
|
|
1150
|
-
*
|
|
1151
|
-
* Archive an organization (soft delete). Requires owner role only.
|
|
1152
|
-
*/
|
|
1153
|
-
archive<ThrowOnError extends boolean = false>(options: Options<OrganizationsArchiveData, ThrowOnError>): import("./client").RequestResult<OrganizationsArchiveResponses, OrganizationsArchiveErrors, ThrowOnError, "fields">;
|
|
1154
|
-
/**
|
|
1155
|
-
* Get Organization By Id
|
|
1156
|
-
*
|
|
1157
|
-
* Get a single organization by ID.
|
|
1158
|
-
*/
|
|
1159
|
-
getById<ThrowOnError extends boolean = false>(options: Options<OrganizationsGetByIdData, ThrowOnError>): import("./client").RequestResult<OrganizationsGetByIdResponses, OrganizationsGetByIdErrors, ThrowOnError, "fields">;
|
|
1160
|
-
/**
|
|
1161
|
-
* Update Organization
|
|
1162
|
-
*
|
|
1163
|
-
* Update an organization. Requires owner or admin role.
|
|
1164
|
-
*/
|
|
1165
|
-
update<ThrowOnError extends boolean = false>(options: Options<OrganizationsUpdateData, ThrowOnError>): import("./client").RequestResult<OrganizationsUpdateResponses, OrganizationsUpdateErrors, ThrowOnError, "fields">;
|
|
1166
|
-
}
|
|
1167
|
-
export declare class CustomRoles extends HeyApiClient {
|
|
1168
|
-
/**
|
|
1169
|
-
* List Roles Endpoint
|
|
1170
|
-
*
|
|
1171
|
-
* List all custom roles for an organization.
|
|
1172
|
-
*/
|
|
1173
|
-
list<ThrowOnError extends boolean = false>(options?: Options<CustomRolesListData, ThrowOnError>): import("./client").RequestResult<CustomRolesListResponses, CustomRolesListErrors, ThrowOnError, "fields">;
|
|
1174
|
-
/**
|
|
1175
|
-
* Create Role Endpoint
|
|
1176
|
-
*
|
|
1177
|
-
* Create a new custom role.
|
|
1178
|
-
*/
|
|
1179
|
-
create<ThrowOnError extends boolean = false>(options: Options<CustomRolesCreateData, ThrowOnError>): import("./client").RequestResult<CustomRolesCreateResponses, CustomRolesCreateErrors, ThrowOnError, "fields">;
|
|
1180
|
-
/**
|
|
1181
|
-
* Get Role Endpoint
|
|
1182
|
-
*
|
|
1183
|
-
* Get a single custom role by ID.
|
|
1184
|
-
*/
|
|
1185
|
-
get<ThrowOnError extends boolean = false>(options: Options<CustomRolesGetData, ThrowOnError>): import("./client").RequestResult<CustomRolesGetResponses, CustomRolesGetErrors, ThrowOnError, "fields">;
|
|
1186
|
-
/**
|
|
1187
|
-
* Update Role Endpoint
|
|
1188
|
-
*
|
|
1189
|
-
* Update an existing custom role.
|
|
1190
|
-
*/
|
|
1191
|
-
update<ThrowOnError extends boolean = false>(options: Options<CustomRolesUpdateData, ThrowOnError>): import("./client").RequestResult<CustomRolesUpdateResponses, CustomRolesUpdateErrors, ThrowOnError, "fields">;
|
|
1192
|
-
/**
|
|
1193
|
-
* Add Permission Endpoint
|
|
1194
|
-
*
|
|
1195
|
-
* Add a permission to a role.
|
|
1196
|
-
*/
|
|
1197
|
-
addPermission<ThrowOnError extends boolean = false>(options: Options<CustomRolesAddPermissionData, ThrowOnError>): import("./client").RequestResult<CustomRolesAddPermissionResponses, CustomRolesAddPermissionErrors, ThrowOnError, "fields">;
|
|
1198
|
-
/**
|
|
1199
|
-
* Set Permissions Endpoint
|
|
1200
|
-
*
|
|
1201
|
-
* Set all permissions for a role (replaces existing).
|
|
1202
|
-
*/
|
|
1203
|
-
setPermissions<ThrowOnError extends boolean = false>(options: Options<CustomRolesSetPermissionsData, ThrowOnError>): import("./client").RequestResult<CustomRolesSetPermissionsResponses, CustomRolesSetPermissionsErrors, ThrowOnError, "fields">;
|
|
1204
|
-
/**
|
|
1205
|
-
* Remove Permission Endpoint
|
|
1206
|
-
*
|
|
1207
|
-
* Remove a permission from a role.
|
|
1208
|
-
*/
|
|
1209
|
-
removePermission<ThrowOnError extends boolean = false>(options: Options<CustomRolesRemovePermissionData, ThrowOnError>): import("./client").RequestResult<CustomRolesRemovePermissionResponses, CustomRolesRemovePermissionErrors, ThrowOnError, "fields">;
|
|
1210
|
-
/**
|
|
1211
|
-
* Get My Permissions Endpoint
|
|
1212
|
-
*
|
|
1213
|
-
* Get current user's effective permissions.
|
|
1214
|
-
*
|
|
1215
|
-
* This returns the permissions from the JWT token claims, augmented with
|
|
1216
|
-
* any custom role permissions from the database.
|
|
1217
|
-
*/
|
|
1218
|
-
getMyPermissions<ThrowOnError extends boolean = false>(options?: Options<CustomRolesGetMyPermissionsData, ThrowOnError>): import("./client").RequestResult<CustomRolesGetMyPermissionsResponses, CustomRolesGetMyPermissionsErrors, ThrowOnError, "fields">;
|
|
1219
|
-
/**
|
|
1220
|
-
* Assign Role To User Endpoint
|
|
1221
|
-
*
|
|
1222
|
-
* Assign a role to a user.
|
|
1223
|
-
*/
|
|
1224
|
-
assignToUser<ThrowOnError extends boolean = false>(options: Options<CustomRolesAssignToUserData, ThrowOnError>): import("./client").RequestResult<CustomRolesAssignToUserResponses, CustomRolesAssignToUserErrors, ThrowOnError, "fields">;
|
|
1225
|
-
/**
|
|
1226
|
-
* Remove Role From User Endpoint
|
|
1227
|
-
*
|
|
1228
|
-
* Remove a role from a user.
|
|
1229
|
-
*/
|
|
1230
|
-
removeUserRole<ThrowOnError extends boolean = false>(options: Options<CustomRolesRemoveUserRoleData, ThrowOnError>): import("./client").RequestResult<CustomRolesRemoveUserRoleResponses, CustomRolesRemoveUserRoleErrors, ThrowOnError, "fields">;
|
|
1231
|
-
}
|
|
1232
|
-
export declare class Roles extends HeyApiClient {
|
|
1233
|
-
/**
|
|
1234
|
-
* Delete Role Endpoint
|
|
1235
|
-
*
|
|
1236
|
-
* Delete a custom role.
|
|
1237
|
-
*/
|
|
1238
|
-
delete<ThrowOnError extends boolean = false>(options: Options<RolesDeleteData, ThrowOnError>): import("./client").RequestResult<RolesDeleteResponses, RolesDeleteErrors, ThrowOnError, "fields">;
|
|
1239
|
-
}
|
|
1240
|
-
export declare class Permissions extends HeyApiClient {
|
|
1241
|
-
/**
|
|
1242
|
-
* List Permissions Endpoint
|
|
1243
|
-
*
|
|
1244
|
-
* List all available permissions in the system.
|
|
1245
|
-
*/
|
|
1246
|
-
list<ThrowOnError extends boolean = false>(options?: Options<PermissionsListData, ThrowOnError>): import("./client").RequestResult<PermissionsListResponses, PermissionsListErrors, ThrowOnError, "fields">;
|
|
1247
|
-
/**
|
|
1248
|
-
* Get Permission Endpoint
|
|
1249
|
-
*
|
|
1250
|
-
* Get a specific permission by code.
|
|
1251
|
-
*/
|
|
1252
|
-
get<ThrowOnError extends boolean = false>(options: Options<PermissionsGetData, ThrowOnError>): import("./client").RequestResult<PermissionsGetResponses, PermissionsGetErrors, ThrowOnError, "fields">;
|
|
1253
|
-
}
|
|
1254
|
-
export declare class Bookings extends HeyApiClient {
|
|
1255
|
-
/**
|
|
1256
|
-
* Get Bookings
|
|
1257
|
-
*
|
|
1258
|
-
* Get bookings with optional filters
|
|
1259
|
-
*/
|
|
1260
|
-
list<ThrowOnError extends boolean = false>(options?: Options<BookingsListData, ThrowOnError>): import("./client").RequestResult<BookingsListResponses, BookingsListErrors, ThrowOnError, "fields">;
|
|
1261
|
-
/**
|
|
1262
|
-
* Delete Booking
|
|
1263
|
-
*
|
|
1264
|
-
* Delete a booking
|
|
1265
|
-
*/
|
|
1266
|
-
delete<ThrowOnError extends boolean = false>(options: Options<BookingsDeleteData, ThrowOnError>): import("./client").RequestResult<BookingsDeleteResponses, BookingsDeleteErrors, ThrowOnError, "fields">;
|
|
1267
|
-
/**
|
|
1268
|
-
* Get Booking By Id
|
|
1269
|
-
*
|
|
1270
|
-
* Get booking by ID
|
|
1271
|
-
*/
|
|
1272
|
-
getById<ThrowOnError extends boolean = false>(options: Options<BookingsGetByIdData, ThrowOnError>): import("./client").RequestResult<BookingsGetByIdResponses, BookingsGetByIdErrors, ThrowOnError, "fields">;
|
|
1273
|
-
/**
|
|
1274
|
-
* Update Booking
|
|
1275
|
-
*
|
|
1276
|
-
* Update an existing booking
|
|
1277
|
-
*/
|
|
1278
|
-
update<ThrowOnError extends boolean = false>(options: Options<BookingsUpdateData, ThrowOnError>): import("./client").RequestResult<BookingsUpdateResponses, BookingsUpdateErrors, ThrowOnError, "fields">;
|
|
1279
|
-
/**
|
|
1280
|
-
* Check Availability
|
|
1281
|
-
*
|
|
1282
|
-
* Check if a place is available for booking
|
|
1283
|
-
*/
|
|
1284
|
-
checkAvailability<ThrowOnError extends boolean = false>(options: Options<BookingsCheckAvailabilityData, ThrowOnError>): import("./client").RequestResult<BookingsCheckAvailabilityResponses, BookingsCheckAvailabilityErrors, ThrowOnError, "fields">;
|
|
1285
|
-
/**
|
|
1286
|
-
* Get Place Schedule
|
|
1287
|
-
*
|
|
1288
|
-
* Get the schedule of bookings for a place in a date range
|
|
1289
|
-
*/
|
|
1290
|
-
getPlaceSchedule<ThrowOnError extends boolean = false>(options: Options<BookingsGetPlaceScheduleData, ThrowOnError>): import("./client").RequestResult<BookingsGetPlaceScheduleResponses, BookingsGetPlaceScheduleErrors, ThrowOnError, "fields">;
|
|
1291
|
-
}
|
|
1292
|
-
export declare class Booking extends HeyApiClient {
|
|
1293
|
-
/**
|
|
1294
|
-
* Create Booking
|
|
1295
|
-
*
|
|
1296
|
-
* Create a new booking
|
|
1297
|
-
*/
|
|
1298
|
-
create<ThrowOnError extends boolean = false>(options: Options<BookingCreateData, ThrowOnError>): import("./client").RequestResult<BookingCreateResponses, BookingCreateErrors, ThrowOnError, "fields">;
|
|
1299
|
-
}
|
|
1300
|
-
export declare class ChatRooms extends HeyApiClient {
|
|
1301
|
-
/**
|
|
1302
|
-
* Create Direct Room
|
|
1303
|
-
*/
|
|
1304
|
-
createDirect<ThrowOnError extends boolean = false>(options: Options<ChatRoomsCreateDirectData, ThrowOnError>): import("./client").RequestResult<ChatRoomsCreateDirectResponses, ChatRoomsCreateDirectErrors, ThrowOnError, "fields">;
|
|
1305
|
-
/**
|
|
1306
|
-
* Create Group Room
|
|
1307
|
-
*/
|
|
1308
|
-
createGroup<ThrowOnError extends boolean = false>(options: Options<ChatRoomsCreateGroupData, ThrowOnError>): import("./client").RequestResult<ChatRoomsCreateGroupResponses, ChatRoomsCreateGroupErrors, ThrowOnError, "fields">;
|
|
1309
|
-
/**
|
|
1310
|
-
* List User Rooms
|
|
1311
|
-
*/
|
|
1312
|
-
list<ThrowOnError extends boolean = false>(options?: Options<ChatRoomsListData, ThrowOnError>): import("./client").RequestResult<ChatRoomsListResponses, ChatRoomsListErrors, ThrowOnError, "fields">;
|
|
1313
|
-
/**
|
|
1314
|
-
* Get Room By Id
|
|
1315
|
-
*/
|
|
1316
|
-
getById<ThrowOnError extends boolean = false>(options: Options<ChatRoomsGetByIdData, ThrowOnError>): import("./client").RequestResult<ChatRoomsGetByIdResponses, ChatRoomsGetByIdErrors, ThrowOnError, "fields">;
|
|
1317
|
-
/**
|
|
1318
|
-
* Update Room
|
|
1319
|
-
*/
|
|
1320
|
-
update<ThrowOnError extends boolean = false>(options: Options<ChatRoomsUpdateData, ThrowOnError>): import("./client").RequestResult<ChatRoomsUpdateResponses, ChatRoomsUpdateErrors, ThrowOnError, "fields">;
|
|
1321
|
-
/**
|
|
1322
|
-
* List Room Members
|
|
1323
|
-
*/
|
|
1324
|
-
listMembers<ThrowOnError extends boolean = false>(options: Options<ChatRoomsListMembersData, ThrowOnError>): import("./client").RequestResult<ChatRoomsListMembersResponses, ChatRoomsListMembersErrors, ThrowOnError, "fields">;
|
|
1325
|
-
/**
|
|
1326
|
-
* Add Member To Room
|
|
1327
|
-
*/
|
|
1328
|
-
addMember<ThrowOnError extends boolean = false>(options: Options<ChatRoomsAddMemberData, ThrowOnError>): import("./client").RequestResult<ChatRoomsAddMemberResponses, ChatRoomsAddMemberErrors, ThrowOnError, "fields">;
|
|
1329
|
-
/**
|
|
1330
|
-
* Remove Member From Room
|
|
1331
|
-
*/
|
|
1332
|
-
removeMember<ThrowOnError extends boolean = false>(options: Options<ChatRoomsRemoveMemberData, ThrowOnError>): import("./client").RequestResult<ChatRoomsRemoveMemberResponses, ChatRoomsRemoveMemberErrors, ThrowOnError, "fields">;
|
|
1333
|
-
}
|
|
1334
|
-
export declare class ChatMessages extends HeyApiClient {
|
|
1335
|
-
/**
|
|
1336
|
-
* List Messages
|
|
1337
|
-
*/
|
|
1338
|
-
list<ThrowOnError extends boolean = false>(options: Options<ChatMessagesListData, ThrowOnError>): import("./client").RequestResult<ChatMessagesListResponses, ChatMessagesListErrors, ThrowOnError, "fields">;
|
|
1339
|
-
/**
|
|
1340
|
-
* Delete Message
|
|
1341
|
-
*/
|
|
1342
|
-
delete<ThrowOnError extends boolean = false>(options: Options<ChatMessagesDeleteData, ThrowOnError>): import("./client").RequestResult<ChatMessagesDeleteResponses, ChatMessagesDeleteErrors, ThrowOnError, "fields">;
|
|
1343
|
-
/**
|
|
1344
|
-
* Get Message Count
|
|
1345
|
-
*/
|
|
1346
|
-
getCount<ThrowOnError extends boolean = false>(options: Options<ChatMessagesGetCountData, ThrowOnError>): import("./client").RequestResult<ChatMessagesGetCountResponses, ChatMessagesGetCountErrors, ThrowOnError, "fields">;
|
|
1347
|
-
/**
|
|
1348
|
-
* Mark Messages As Read
|
|
1349
|
-
*/
|
|
1350
|
-
markRead<ThrowOnError extends boolean = false>(options: Options<ChatMessagesMarkReadData, ThrowOnError>): import("./client").RequestResult<ChatMessagesMarkReadResponses, ChatMessagesMarkReadErrors, ThrowOnError, "fields">;
|
|
1351
|
-
/**
|
|
1352
|
-
* Get Unread Count
|
|
1353
|
-
*/
|
|
1354
|
-
getUnreadCount<ThrowOnError extends boolean = false>(options: Options<ChatMessagesGetUnreadCountData, ThrowOnError>): import("./client").RequestResult<ChatMessagesGetUnreadCountResponses, ChatMessagesGetUnreadCountErrors, ThrowOnError, "fields">;
|
|
1355
|
-
}
|
|
1356
|
-
export declare class AiAgent extends HeyApiClient {
|
|
1357
|
-
/**
|
|
1358
|
-
* Send Message
|
|
1359
|
-
*/
|
|
1360
|
-
sendMessage<ThrowOnError extends boolean = false>(options: Options<AiAgentSendMessageData, ThrowOnError>): import("./client").RequestResult<AiAgentSendMessageResponses, AiAgentSendMessageErrors, ThrowOnError, "fields">;
|
|
1361
|
-
/**
|
|
1362
|
-
* Create a new AI agent session
|
|
1363
|
-
*
|
|
1364
|
-
* Create a new conversation session with an AI agent. The session persists across multiple messages and maintains context.
|
|
1365
|
-
*/
|
|
1366
|
-
createSession<ThrowOnError extends boolean = false>(options: Options<AiAgentCreateSessionData, ThrowOnError>): import("./client").RequestResult<AiAgentCreateSessionResponses, AiAgentCreateSessionErrors, ThrowOnError, "fields">;
|
|
1367
|
-
/**
|
|
1368
|
-
* Send a message to an AI agent session
|
|
1369
|
-
*
|
|
1370
|
-
* Send a user message to an existing AI agent session and receive a response. The conversation context is maintained across messages.
|
|
1371
|
-
*/
|
|
1372
|
-
sendMessage2<ThrowOnError extends boolean = false>(options: Options<AiAgentSendMessage2Data, ThrowOnError>): import("./client").RequestResult<AiAgentSendMessage2Responses, AiAgentSendMessage2Errors, ThrowOnError, "fields">;
|
|
1373
|
-
}
|
|
1374
|
-
export declare class AiAgent2 extends HeyApiClient {
|
|
1375
|
-
/**
|
|
1376
|
-
* List AI agent sessions
|
|
1377
|
-
*
|
|
1378
|
-
* Retrieve a list of AI agent sessions for the current user. Supports filtering by agent type and status.
|
|
1379
|
-
*/
|
|
1380
|
-
listSessions<ThrowOnError extends boolean = false>(options?: Options<AiAgentListSessionsData, ThrowOnError>): import("./client").RequestResult<AiAgentListSessionsResponses, AiAgentListSessionsErrors, ThrowOnError, "fields">;
|
|
1381
|
-
/**
|
|
1382
|
-
* Get AI agent session details
|
|
1383
|
-
*
|
|
1384
|
-
* Retrieve detailed information about a specific AI agent session.
|
|
1385
|
-
*/
|
|
1386
|
-
getSession<ThrowOnError extends boolean = false>(options: Options<AiAgentGetSessionData, ThrowOnError>): import("./client").RequestResult<AiAgentGetSessionResponses, AiAgentGetSessionErrors, ThrowOnError, "fields">;
|
|
1387
|
-
/**
|
|
1388
|
-
* Get session cost breakdown
|
|
1389
|
-
*
|
|
1390
|
-
* Retrieve token usage and cost information for a specific AI agent session.
|
|
1391
|
-
*/
|
|
1392
|
-
getSessionCosts<ThrowOnError extends boolean = false>(options: Options<AiAgentGetSessionCostsData, ThrowOnError>): import("./client").RequestResult<AiAgentGetSessionCostsResponses, AiAgentGetSessionCostsErrors, ThrowOnError, "fields">;
|
|
1393
|
-
/**
|
|
1394
|
-
* List workflow executions
|
|
1395
|
-
*
|
|
1396
|
-
* Retrieve a list of workflow executions for the current user. Supports filtering by workflow type and status.
|
|
1397
|
-
*/
|
|
1398
|
-
listWorkflows<ThrowOnError extends boolean = false>(options?: Options<AiAgentListWorkflowsData, ThrowOnError>): import("./client").RequestResult<AiAgentListWorkflowsResponses, AiAgentListWorkflowsErrors, ThrowOnError, "fields">;
|
|
1399
|
-
/**
|
|
1400
|
-
* Start a multi-agent workflow
|
|
1401
|
-
*
|
|
1402
|
-
* Execute a multi-agent workflow with specified parameters. Returns immediately with execution status; poll for completion.
|
|
1403
|
-
*/
|
|
1404
|
-
startWorkflow<ThrowOnError extends boolean = false>(options: Options<AiAgentStartWorkflowData, ThrowOnError>): import("./client").RequestResult<AiAgentStartWorkflowResponses, AiAgentStartWorkflowErrors, ThrowOnError, "fields">;
|
|
1405
|
-
/**
|
|
1406
|
-
* Start a multi-agent workflow (async)
|
|
1407
|
-
*
|
|
1408
|
-
* Queue a multi-agent workflow for asynchronous execution. Returns immediately with execution_id and task_id. Poll GET /workflows/{execution_id} for status updates.
|
|
1409
|
-
*/
|
|
1410
|
-
startWorkflowAsync<ThrowOnError extends boolean = false>(options: Options<AiAgentStartWorkflowAsyncData, ThrowOnError>): import("./client").RequestResult<AiAgentStartWorkflowAsyncResponses, AiAgentStartWorkflowAsyncErrors, ThrowOnError, "fields">;
|
|
1411
|
-
/**
|
|
1412
|
-
* Cancel a running workflow
|
|
1413
|
-
*
|
|
1414
|
-
* Cancel a pending or running workflow execution. Cannot cancel completed, failed, or already cancelled workflows.
|
|
1415
|
-
*/
|
|
1416
|
-
cancelWorkflow<ThrowOnError extends boolean = false>(options: Options<AiAgentCancelWorkflowData, ThrowOnError>): import("./client").RequestResult<AiAgentCancelWorkflowResponses, AiAgentCancelWorkflowErrors, ThrowOnError, "fields">;
|
|
1417
|
-
}
|
|
1418
|
-
export declare class AI extends HeyApiClient {
|
|
1419
|
-
/**
|
|
1420
|
-
* Delete AI agent session
|
|
1421
|
-
*
|
|
1422
|
-
* Mark an AI agent session as deleted. The session and its conversation history will be soft-deleted.
|
|
1423
|
-
*/
|
|
1424
|
-
deleteSession<ThrowOnError extends boolean = false>(options: Options<AIDeleteSessionData, ThrowOnError>): import("./client").RequestResult<AIDeleteSessionResponses, AIDeleteSessionErrors, ThrowOnError, "fields">;
|
|
1425
|
-
}
|
|
1426
|
-
export declare class AiAgents extends HeyApiClient {
|
|
1427
|
-
/**
|
|
1428
|
-
* Get organization-wide cost summary
|
|
1429
|
-
*
|
|
1430
|
-
* Retrieve aggregated cost and token usage across all AI agent sessions for the current organization. Requires organization context (not available in personal mode).
|
|
1431
|
-
*/
|
|
1432
|
-
getOrgCosts<ThrowOnError extends boolean = false>(options?: Options<AiAgentsGetOrgCostsData, ThrowOnError>): import("./client").RequestResult<AiAgentsGetOrgCostsResponses, AiAgentsGetOrgCostsErrors, ThrowOnError, "fields">;
|
|
1433
|
-
}
|
|
1434
|
-
export declare class AiWorkflows extends HeyApiClient {
|
|
1435
|
-
/**
|
|
1436
|
-
* Get workflow execution details
|
|
1437
|
-
*
|
|
1438
|
-
* Retrieve detailed information about a workflow execution, including status and results.
|
|
1439
|
-
*/
|
|
1440
|
-
getExecutionDetails<ThrowOnError extends boolean = false>(options: Options<AiWorkflowsGetExecutionDetailsData, ThrowOnError>): import("./client").RequestResult<AiWorkflowsGetExecutionDetailsResponses, AiWorkflowsGetExecutionDetailsErrors, ThrowOnError, "fields">;
|
|
1441
|
-
}
|
|
1442
|
-
export declare class Contacts extends HeyApiClient {
|
|
1443
|
-
/**
|
|
1444
|
-
* List Contacts
|
|
1445
|
-
*
|
|
1446
|
-
* List all contacts for the current user with tenant isolation.
|
|
1447
|
-
*/
|
|
1448
|
-
list<ThrowOnError extends boolean = false>(options?: Options<ContactsListData, ThrowOnError>): import("./client").RequestResult<ContactsListResponses, ContactsListErrors, ThrowOnError, "fields">;
|
|
1449
|
-
/**
|
|
1450
|
-
* Create Contact
|
|
1451
|
-
*
|
|
1452
|
-
* Create a new contact.
|
|
1453
|
-
*/
|
|
1454
|
-
create<ThrowOnError extends boolean = false>(options: Options<ContactsCreateData, ThrowOnError>): import("./client").RequestResult<ContactsCreateResponses, ContactsCreateErrors, ThrowOnError, "fields">;
|
|
1455
|
-
/**
|
|
1456
|
-
* Search Contacts
|
|
1457
|
-
*
|
|
1458
|
-
* Search contacts by query string with tenant isolation.
|
|
1459
|
-
*/
|
|
1460
|
-
search<ThrowOnError extends boolean = false>(options: Options<ContactsSearchData, ThrowOnError>): import("./client").RequestResult<ContactsSearchResponses, ContactsSearchErrors, ThrowOnError, "fields">;
|
|
1461
|
-
/**
|
|
1462
|
-
* Delete Contact
|
|
1463
|
-
*
|
|
1464
|
-
* Delete a contact.
|
|
1465
|
-
*/
|
|
1466
|
-
delete<ThrowOnError extends boolean = false>(options: Options<ContactsDeleteData, ThrowOnError>): import("./client").RequestResult<ContactsDeleteResponses, ContactsDeleteErrors, ThrowOnError, "fields">;
|
|
1467
|
-
/**
|
|
1468
|
-
* Get Contact
|
|
1469
|
-
*
|
|
1470
|
-
* Get a specific contact by ID.
|
|
1471
|
-
*/
|
|
1472
|
-
get<ThrowOnError extends boolean = false>(options: Options<ContactsGetData, ThrowOnError>): import("./client").RequestResult<ContactsGetResponses, ContactsGetErrors, ThrowOnError, "fields">;
|
|
1473
|
-
/**
|
|
1474
|
-
* Update Contact
|
|
1475
|
-
*
|
|
1476
|
-
* Update a contact.
|
|
1477
|
-
*/
|
|
1478
|
-
update<ThrowOnError extends boolean = false>(options: Options<ContactsUpdateData, ThrowOnError>): import("./client").RequestResult<ContactsUpdateResponses, ContactsUpdateErrors, ThrowOnError, "fields">;
|
|
1479
|
-
/**
|
|
1480
|
-
* Toggle Favorite
|
|
1481
|
-
*
|
|
1482
|
-
* Toggle contact favorite status.
|
|
1483
|
-
*/
|
|
1484
|
-
toggleFavorite<ThrowOnError extends boolean = false>(options: Options<ContactsToggleFavoriteData, ThrowOnError>): import("./client").RequestResult<ContactsToggleFavoriteResponses, ContactsToggleFavoriteErrors, ThrowOnError, "fields">;
|
|
1485
|
-
}
|
|
1486
|
-
export declare class AutomationRules extends HeyApiClient {
|
|
1487
|
-
/**
|
|
1488
|
-
* Get all metadata
|
|
1489
|
-
*
|
|
1490
|
-
* Get combined metadata for triggers, conditions, and actions in a single request
|
|
1491
|
-
*/
|
|
1492
|
-
getMetadata<ThrowOnError extends boolean = false>(options?: Options<AutomationRulesGetMetadataData, ThrowOnError>): import("./client").RequestResult<AutomationRulesGetMetadataResponses, AutomationRulesGetMetadataErrors, ThrowOnError, "fields">;
|
|
1493
|
-
/**
|
|
1494
|
-
* Get condition metadata
|
|
1495
|
-
*
|
|
1496
|
-
* Get metadata for all available condition types
|
|
1497
|
-
*/
|
|
1498
|
-
getConditions<ThrowOnError extends boolean = false>(options?: Options<AutomationRulesGetConditionsData, ThrowOnError>): import("./client").RequestResult<AutomationRulesGetConditionsResponses, AutomationRulesGetConditionsErrors, ThrowOnError, "fields">;
|
|
1499
|
-
/**
|
|
1500
|
-
* List Rules
|
|
1501
|
-
*
|
|
1502
|
-
* List automation rules.
|
|
1503
|
-
*
|
|
1504
|
-
* RLS automatically filters:
|
|
1505
|
-
* - Personal mode: only user's own rules
|
|
1506
|
-
* - Organization mode: all org rules
|
|
1507
|
-
*/
|
|
1508
|
-
list<ThrowOnError extends boolean = false>(options?: Options<AutomationRulesListData, ThrowOnError>): import("./client").RequestResult<AutomationRulesListResponses, AutomationRulesListErrors, ThrowOnError, "fields">;
|
|
1509
|
-
/**
|
|
1510
|
-
* Create Rule
|
|
1511
|
-
*
|
|
1512
|
-
* Create new automation rule.
|
|
1513
|
-
*
|
|
1514
|
-
* Supports dual-scope:
|
|
1515
|
-
* - Personal mode: org_id=None, creator_id=current_user.id
|
|
1516
|
-
* - Organization mode: org_id=tenant_ctx.org_id, creator_id=current_user.id
|
|
1517
|
-
*/
|
|
1518
|
-
create<ThrowOnError extends boolean = false>(options: Options<AutomationRulesCreateData, ThrowOnError>): import("./client").RequestResult<AutomationRulesCreateResponses, AutomationRulesCreateErrors, ThrowOnError, "fields">;
|
|
1519
|
-
/**
|
|
1520
|
-
* Delete Rule
|
|
1521
|
-
*
|
|
1522
|
-
* Delete automation rule.
|
|
1523
|
-
*/
|
|
1524
|
-
delete<ThrowOnError extends boolean = false>(options: Options<AutomationRulesDeleteData, ThrowOnError>): import("./client").RequestResult<AutomationRulesDeleteResponses, AutomationRulesDeleteErrors, ThrowOnError, "fields">;
|
|
1525
|
-
/**
|
|
1526
|
-
* Get Rule
|
|
1527
|
-
*
|
|
1528
|
-
* Get automation rule by ID.
|
|
1529
|
-
*/
|
|
1530
|
-
get<ThrowOnError extends boolean = false>(options: Options<AutomationRulesGetData, ThrowOnError>): import("./client").RequestResult<AutomationRulesGetResponses, AutomationRulesGetErrors, ThrowOnError, "fields">;
|
|
1531
|
-
/**
|
|
1532
|
-
* Patch Rule
|
|
1533
|
-
*
|
|
1534
|
-
* Partially update automation rule (PATCH).
|
|
1535
|
-
*/
|
|
1536
|
-
patch<ThrowOnError extends boolean = false>(options: Options<AutomationRulesPatchData, ThrowOnError>): import("./client").RequestResult<AutomationRulesPatchResponses, AutomationRulesPatchErrors, ThrowOnError, "fields">;
|
|
1537
|
-
/**
|
|
1538
|
-
* Update Rule
|
|
1539
|
-
*
|
|
1540
|
-
* Update automation rule.
|
|
1541
|
-
*/
|
|
1542
|
-
update<ThrowOnError extends boolean = false>(options: Options<AutomationRulesUpdateData, ThrowOnError>): import("./client").RequestResult<AutomationRulesUpdateResponses, AutomationRulesUpdateErrors, ThrowOnError, "fields">;
|
|
1543
|
-
/**
|
|
1544
|
-
* Execute Rule
|
|
1545
|
-
*
|
|
1546
|
-
* Manually execute automation rule.
|
|
1547
|
-
*/
|
|
1548
|
-
execute<ThrowOnError extends boolean = false>(options: Options<AutomationRulesExecuteData, ThrowOnError>): import("./client").RequestResult<AutomationRulesExecuteResponses, AutomationRulesExecuteErrors, ThrowOnError, "fields">;
|
|
1549
|
-
/**
|
|
1550
|
-
* Get Rule Executions
|
|
1551
|
-
*
|
|
1552
|
-
* Get execution history for a specific automation rule.
|
|
1553
|
-
*
|
|
1554
|
-
* Returns list of past executions with their status, results, and errors.
|
|
1555
|
-
*/
|
|
1556
|
-
getExecutions<ThrowOnError extends boolean = false>(options: Options<AutomationRulesGetExecutionsData, ThrowOnError>): import("./client").RequestResult<AutomationRulesGetExecutionsResponses, AutomationRulesGetExecutionsErrors, ThrowOnError, "fields">;
|
|
1557
|
-
}
|
|
1558
|
-
export declare class AutomationMetadata extends HeyApiClient {
|
|
1559
|
-
/**
|
|
1560
|
-
* Get trigger metadata
|
|
1561
|
-
*
|
|
1562
|
-
* Get metadata for all available trigger types
|
|
1563
|
-
*/
|
|
1564
|
-
getTriggers<ThrowOnError extends boolean = false>(options?: Options<AutomationMetadataGetTriggersData, ThrowOnError>): import("./client").RequestResult<AutomationMetadataGetTriggersResponses, AutomationMetadataGetTriggersErrors, ThrowOnError, "fields">;
|
|
1565
|
-
/**
|
|
1566
|
-
* Get action metadata
|
|
1567
|
-
*
|
|
1568
|
-
* Get metadata for all available action types
|
|
1569
|
-
*/
|
|
1570
|
-
getActions<ThrowOnError extends boolean = false>(options?: Options<AutomationMetadataGetActionsData, ThrowOnError>): import("./client").RequestResult<AutomationMetadataGetActionsResponses, AutomationMetadataGetActionsErrors, ThrowOnError, "fields">;
|
|
1571
|
-
/**
|
|
1572
|
-
* Get task metadata
|
|
1573
|
-
*
|
|
1574
|
-
* Get metadata for a specific task type
|
|
1575
|
-
*/
|
|
1576
|
-
getTask<ThrowOnError extends boolean = false>(options: Options<AutomationMetadataGetTaskData, ThrowOnError>): import("./client").RequestResult<AutomationMetadataGetTaskResponses, AutomationMetadataGetTaskErrors, ThrowOnError, "fields">;
|
|
1577
|
-
/**
|
|
1578
|
-
* Get all task metadata
|
|
1579
|
-
*
|
|
1580
|
-
* Get metadata for all registered tasks, optionally filtered by category or tags
|
|
1581
|
-
*/
|
|
1582
|
-
getTasks<ThrowOnError extends boolean = false>(options?: Options<AutomationMetadataGetTasksData, ThrowOnError>): import("./client").RequestResult<AutomationMetadataGetTasksResponses, AutomationMetadataGetTasksErrors, ThrowOnError, "fields">;
|
|
1583
|
-
}
|
|
1584
|
-
export declare class AutomationCron extends HeyApiClient {
|
|
1585
|
-
/**
|
|
1586
|
-
* Trigger Scheduled Automation
|
|
1587
|
-
*
|
|
1588
|
-
* Trigger execution of all scheduled automation rules.
|
|
1589
|
-
*
|
|
1590
|
-
* This endpoint is designed to be called by external cron services like:
|
|
1591
|
-
* - cron-job.org (free tier)
|
|
1592
|
-
* - GitHub Actions (free for public repos)
|
|
1593
|
-
* - EasyCron
|
|
1594
|
-
* - Any service that can make HTTP POST requests on a schedule
|
|
1595
|
-
*
|
|
1596
|
-
* **Security:**
|
|
1597
|
-
* - Requires API key in X-Automation-Key header
|
|
1598
|
-
* - Set AUTOMATION_API_KEY in Railway environment variables
|
|
1599
|
-
*
|
|
1600
|
-
* **Setup:**
|
|
1601
|
-
* 1. Add AUTOMATION_API_KEY to Railway env vars (e.g., generate with: openssl rand -hex 32)
|
|
1602
|
-
* 2. Configure external cron to POST to this endpoint every 15 minutes
|
|
1603
|
-
* 3. Include X-Automation-Key: <your-key> header
|
|
1604
|
-
*
|
|
1605
|
-
* **Example cron-job.org setup:**
|
|
1606
|
-
* - URL: https://your-app.railway.app/api/v1/automation/cron/trigger-scheduled
|
|
1607
|
-
* - Method: POST
|
|
1608
|
-
* - Schedule: *15 * * * * (every 15 minutes)
|
|
1609
|
-
* - Custom Header: X-Automation-Key: your-secret-key-here
|
|
1610
|
-
*
|
|
1611
|
-
* **Returns:**
|
|
1612
|
-
* - 200 OK: Automation triggered successfully
|
|
1613
|
-
* - 401 Unauthorized: Invalid or missing API key
|
|
1614
|
-
* - 500 Internal Server Error: Execution failed
|
|
1615
|
-
*/
|
|
1616
|
-
triggerScheduled<ThrowOnError extends boolean = false>(options: Options<AutomationCronTriggerScheduledData, ThrowOnError>): import("./client").RequestResult<AutomationCronTriggerScheduledResponses, AutomationCronTriggerScheduledErrors, ThrowOnError, "fields">;
|
|
1617
|
-
/**
|
|
1618
|
-
* Cron Health Check
|
|
1619
|
-
*
|
|
1620
|
-
* Health check endpoint for external cron services.
|
|
1621
|
-
*
|
|
1622
|
-
* Some cron services (like cron-job.org) verify the endpoint is reachable
|
|
1623
|
-
* before enabling the job. This endpoint confirms the automation cron
|
|
1624
|
-
* endpoint is accessible.
|
|
1625
|
-
*/
|
|
1626
|
-
healthCheck<ThrowOnError extends boolean = false>(options?: Options<AutomationCronHealthCheckData, ThrowOnError>): import("./client").RequestResult<AutomationCronHealthCheckResponses, AutomationCronHealthCheckErrors, ThrowOnError, "fields">;
|
|
1627
|
-
}
|
|
1628
|
-
export declare class Health extends HeyApiClient {
|
|
1629
|
-
/**
|
|
1630
|
-
* Automation Health Check
|
|
1631
|
-
*
|
|
1632
|
-
* Health check for automation system.
|
|
1633
|
-
*
|
|
1634
|
-
* Checks:
|
|
1635
|
-
* - API availability
|
|
1636
|
-
* - Prefect server connection
|
|
1637
|
-
* - Task registry
|
|
1638
|
-
* - Celery Beat (indirectly via task registry)
|
|
1639
|
-
*/
|
|
1640
|
-
checkAutomation<ThrowOnError extends boolean = false>(options?: Options<HealthCheckAutomationData, ThrowOnError>): import("./client").RequestResult<HealthCheckAutomationResponses, HealthCheckAutomationErrors, ThrowOnError, "fields">;
|
|
1641
|
-
/**
|
|
1642
|
-
* Health Check
|
|
1643
|
-
*
|
|
1644
|
-
* Health endpoint.
|
|
1645
|
-
*
|
|
1646
|
-
* - Default (`/health` or `/health?shallow=true`) is **liveness**: fast, no external deps.
|
|
1647
|
-
* - Optional (`/health?deep=true` or `/health?shallow=false`) performs **readiness** checks.
|
|
1648
|
-
*
|
|
1649
|
-
* Readiness only treats DB + Redis as critical. Other checks are informational/skipped.
|
|
1650
|
-
*/
|
|
1651
|
-
check<ThrowOnError extends boolean = false>(options?: Options<HealthCheckData, ThrowOnError>): import("./client").RequestResult<HealthCheckResponses, HealthCheckErrors, ThrowOnError, "fields">;
|
|
1652
|
-
}
|
|
1653
|
-
export declare class Integration extends HeyApiClient {
|
|
1654
|
-
/**
|
|
1655
|
-
* Webhook from Zitadel for organization removal
|
|
1656
|
-
*
|
|
1657
|
-
* Receives an authenticated JWT webhook payload from a Zitadel Action
|
|
1658
|
-
* when an organization is removed.
|
|
1659
|
-
*/
|
|
1660
|
-
handleOrgRemoved<ThrowOnError extends boolean = false>(options?: Options<IntegrationHandleOrgRemovedData, ThrowOnError>): import("./client").RequestResult<IntegrationHandleOrgRemovedResponses, IntegrationHandleOrgRemovedErrors, ThrowOnError, "fields">;
|
|
1661
|
-
}
|
|
1662
|
-
export declare class IntegrationUser extends HeyApiClient {
|
|
1663
|
-
/**
|
|
1664
|
-
* Webhook from Zitadel for user removal
|
|
1665
|
-
*
|
|
1666
|
-
* Receives an authenticated JWT webhook payload from a Zitadel Action
|
|
1667
|
-
* when a user is removed.
|
|
1668
|
-
*/
|
|
1669
|
-
handleRemoved<ThrowOnError extends boolean = false>(options?: Options<IntegrationUserHandleRemovedData, ThrowOnError>): import("./client").RequestResult<IntegrationUserHandleRemovedResponses, IntegrationUserHandleRemovedErrors, ThrowOnError, "fields">;
|
|
1670
|
-
}
|
|
1671
|
-
export declare class Sentry extends HeyApiClient {
|
|
1672
|
-
/**
|
|
1673
|
-
* Trigger Sentry Error
|
|
1674
|
-
*
|
|
1675
|
-
* Test endpoint to verify Sentry integration.
|
|
1676
|
-
* This endpoint intentionally raises an error to test error tracking.
|
|
1677
|
-
*/
|
|
1678
|
-
triggerError<ThrowOnError extends boolean = false>(options?: Options<SentryTriggerErrorData, ThrowOnError>): import("./client").RequestResult<SentryTriggerErrorResponses, SentryTriggerErrorErrors, ThrowOnError, "fields">;
|
|
1679
|
-
}
|
|
1680
|
-
export declare class HealthNotifications extends HeyApiClient {
|
|
1681
|
-
/**
|
|
1682
|
-
* Notification Health Check
|
|
1683
|
-
*
|
|
1684
|
-
* Health check endpoint for notification services configuration.
|
|
1685
|
-
*/
|
|
1686
|
-
check<ThrowOnError extends boolean = false>(options?: Options<HealthNotificationsCheckData, ThrowOnError>): import("./client").RequestResult<HealthNotificationsCheckResponses, HealthNotificationsCheckErrors, ThrowOnError, "fields">;
|
|
1687
|
-
}
|
|
1688
|
-
export declare class Metrics extends HeyApiClient {
|
|
1689
|
-
/**
|
|
1690
|
-
* Metrics
|
|
1691
|
-
*
|
|
1692
|
-
* Prometheus metrics endpoint for monitoring.
|
|
1693
|
-
*/
|
|
1694
|
-
get<ThrowOnError extends boolean = false>(options?: Options<MetricsGetData, ThrowOnError>): import("./client").RequestResult<MetricsGetResponses, MetricsGetErrors, ThrowOnError, "fields">;
|
|
1695
|
-
}
|
|
1696
|
-
export declare class Features extends HeyApiClient {
|
|
1697
|
-
/**
|
|
1698
|
-
* Get Feature Flags
|
|
1699
|
-
*
|
|
1700
|
-
* Get current feature flag status for frontend clients.
|
|
1701
|
-
*/
|
|
1702
|
-
get<ThrowOnError extends boolean = false>(options?: Options<FeaturesGetData, ThrowOnError>): import("./client").RequestResult<FeaturesGetResponses, FeaturesGetErrors, ThrowOnError, "fields">;
|
|
1703
|
-
}
|
|
1704
|
-
export declare class Realtime extends HeyApiClient {
|
|
1705
|
-
/**
|
|
1706
|
-
* Realtime WebSocket protocol info
|
|
1707
|
-
*
|
|
1708
|
-
* Get WebSocket protocol information.
|
|
1709
|
-
*
|
|
1710
|
-
* Returns documentation about the WebSocket endpoint including:
|
|
1711
|
-
* - Connection endpoint
|
|
1712
|
-
* - Authentication requirements
|
|
1713
|
-
* - Protocol details
|
|
1714
|
-
* - ACK message format
|
|
1715
|
-
*
|
|
1716
|
-
* Returns:
|
|
1717
|
-
* dict: WebSocket protocol information
|
|
1718
|
-
*/
|
|
1719
|
-
getInfo<ThrowOnError extends boolean = false>(options?: Options<RealtimeGetInfoData, ThrowOnError>): import("./client").RequestResult<RealtimeGetInfoResponses, RealtimeGetInfoErrors, ThrowOnError, "fields">;
|
|
1720
|
-
}
|
|
1721
|
-
export declare class Linebundle extends HeyApiClient {
|
|
1722
|
-
static readonly __registry: HeyApiRegistry<Linebundle>;
|
|
1723
|
-
constructor(args?: {
|
|
1724
|
-
client?: Client;
|
|
1725
|
-
key?: string;
|
|
1726
|
-
});
|
|
1727
|
-
/**
|
|
1728
|
-
* Webhook from Zitadel for user creation
|
|
1729
|
-
*
|
|
1730
|
-
* Receives an authenticated JWT webhook payload from a Zitadel Action
|
|
1731
|
-
* when a new human user is created (admin-created or self-registered).
|
|
1732
|
-
*/
|
|
1733
|
-
handleUserCreatedApiV1IntegrationUserCreatedPost<ThrowOnError extends boolean = false>(options?: Options<HandleUserCreatedApiV1IntegrationUserCreatedPostData, ThrowOnError>): import("./client").RequestResult<HandleUserCreatedApiV1IntegrationUserCreatedPostResponses, HandleUserCreatedApiV1IntegrationUserCreatedPostErrors, ThrowOnError, "fields">;
|
|
1734
|
-
/**
|
|
1735
|
-
* Webhook from Zitadel for user profile update
|
|
1736
|
-
*
|
|
1737
|
-
* Receives an authenticated JWT webhook payload from a Zitadel Action
|
|
1738
|
-
* when a user's profile is updated (name, email, etc.).
|
|
1739
|
-
*/
|
|
1740
|
-
handleUserUpdatedApiV1IntegrationUserUpdatedPost<ThrowOnError extends boolean = false>(options?: Options<HandleUserUpdatedApiV1IntegrationUserUpdatedPostData, ThrowOnError>): import("./client").RequestResult<HandleUserUpdatedApiV1IntegrationUserUpdatedPostResponses, HandleUserUpdatedApiV1IntegrationUserUpdatedPostErrors, ThrowOnError, "fields">;
|
|
1741
|
-
/**
|
|
1742
|
-
* Get Latest Event Version (Public Access)
|
|
1743
|
-
*
|
|
1744
|
-
* Get the most recent published version of an event. Supports unauthenticated access for PUBLIC events.
|
|
1745
|
-
*/
|
|
1746
|
-
getLatestPublicEventVersion<ThrowOnError extends boolean = false>(options: Options<GetLatestPublicEventVersionData, ThrowOnError>): import("./client").RequestResult<GetLatestPublicEventVersionResponses, GetLatestPublicEventVersionErrors, ThrowOnError, "fields">;
|
|
1747
|
-
/**
|
|
1748
|
-
* Get Latest Published Version
|
|
1749
|
-
*
|
|
1750
|
-
* Get the latest published version of a space.
|
|
1751
|
-
* Public access permitted.
|
|
1752
|
-
*/
|
|
1753
|
-
getLatestPublicSpaceVersion<ThrowOnError extends boolean = false>(options: Options<GetLatestPublicSpaceVersionData, ThrowOnError>): import("./client").RequestResult<GetLatestPublicSpaceVersionResponses, GetLatestPublicSpaceVersionErrors, ThrowOnError, "fields">;
|
|
1754
|
-
/**
|
|
1755
|
-
* Establish realtime WebSocket connection (upgrade)
|
|
1756
|
-
*
|
|
1757
|
-
* Upgrades to WebSocket at this path (subprotocol: json).
|
|
1758
|
-
*
|
|
1759
|
-
* Requires valid authenticated user & tenant context. Server sends single ACK then may push events.
|
|
1760
|
-
*/
|
|
1761
|
-
connectWebSocket<ThrowOnError extends boolean = false>(options?: Options<ConnectWebSocketData, ThrowOnError>): import("./client").RequestResult<ConnectWebSocketResponses, ConnectWebSocketErrors, ThrowOnError, "fields">;
|
|
1762
|
-
private _user?;
|
|
1763
|
-
get user(): User;
|
|
1764
|
-
private _users?;
|
|
1765
|
-
get users(): Users;
|
|
1766
|
-
private _authContexts?;
|
|
1767
|
-
get authContexts(): AuthContexts;
|
|
1768
|
-
private _auditLogs?;
|
|
1769
|
-
get auditLogs(): AuditLogs;
|
|
1770
|
-
private _events?;
|
|
1771
|
-
get events(): Events;
|
|
1772
|
-
private _event?;
|
|
1773
|
-
get event(): Event_;
|
|
1774
|
-
private _eventTimezones?;
|
|
1775
|
-
get eventTimezones(): EventTimezones;
|
|
1776
|
-
private _eventAttendees?;
|
|
1777
|
-
get eventAttendees(): EventAttendees;
|
|
1778
|
-
private _eventTimeline?;
|
|
1779
|
-
get eventTimeline(): EventTimeline;
|
|
1780
|
-
private _eventDocuments?;
|
|
1781
|
-
get eventDocuments(): EventDocuments;
|
|
1782
|
-
private _eventLocation?;
|
|
1783
|
-
get eventLocation(): EventLocation;
|
|
1784
|
-
private _space?;
|
|
1785
|
-
get space(): Space;
|
|
1786
|
-
private _spaces?;
|
|
1787
|
-
get spaces(): Spaces;
|
|
1788
|
-
private _spaceRoles?;
|
|
1789
|
-
get spaceRoles(): SpaceRoles;
|
|
1790
|
-
private _spaceContacts?;
|
|
1791
|
-
get spaceContacts(): SpaceContacts;
|
|
1792
|
-
private _spaceEvents?;
|
|
1793
|
-
get spaceEvents(): SpaceEvents;
|
|
1794
|
-
private _spaceDocuments?;
|
|
1795
|
-
get spaceDocuments(): SpaceDocuments;
|
|
1796
|
-
private _places?;
|
|
1797
|
-
get places(): Places;
|
|
1798
|
-
private _place?;
|
|
1799
|
-
get place(): Place;
|
|
1800
|
-
private _analytic?;
|
|
1801
|
-
get analytic(): Analytic;
|
|
1802
|
-
private _organizations?;
|
|
1803
|
-
get organizations(): Organizations;
|
|
1804
|
-
private _customRoles?;
|
|
1805
|
-
get customRoles(): CustomRoles;
|
|
1806
|
-
private _roles?;
|
|
1807
|
-
get roles(): Roles;
|
|
1808
|
-
private _permissions?;
|
|
1809
|
-
get permissions(): Permissions;
|
|
1810
|
-
private _bookings?;
|
|
1811
|
-
get bookings(): Bookings;
|
|
1812
|
-
private _booking?;
|
|
1813
|
-
get booking(): Booking;
|
|
1814
|
-
private _chatRooms?;
|
|
1815
|
-
get chatRooms(): ChatRooms;
|
|
1816
|
-
private _chatMessages?;
|
|
1817
|
-
get chatMessages(): ChatMessages;
|
|
1818
|
-
private _aiAgent?;
|
|
1819
|
-
get aiAgent(): AiAgent;
|
|
1820
|
-
private _aiAgent2?;
|
|
1821
|
-
get aiAgent2(): AiAgent2;
|
|
1822
|
-
private _ai?;
|
|
1823
|
-
get ai(): AI;
|
|
1824
|
-
private _aiAgents?;
|
|
1825
|
-
get aiAgents(): AiAgents;
|
|
1826
|
-
private _aiWorkflows?;
|
|
1827
|
-
get aiWorkflows(): AiWorkflows;
|
|
1828
|
-
private _contacts?;
|
|
1829
|
-
get contacts(): Contacts;
|
|
1830
|
-
private _automationRules?;
|
|
1831
|
-
get automationRules(): AutomationRules;
|
|
1832
|
-
private _automationMetadata?;
|
|
1833
|
-
get automationMetadata(): AutomationMetadata;
|
|
1834
|
-
private _automationCron?;
|
|
1835
|
-
get automationCron(): AutomationCron;
|
|
1836
|
-
private _health?;
|
|
1837
|
-
get health(): Health;
|
|
1838
|
-
private _integration?;
|
|
1839
|
-
get integration(): Integration;
|
|
1840
|
-
private _integrationUser?;
|
|
1841
|
-
get integrationUser(): IntegrationUser;
|
|
1842
|
-
private _sentry?;
|
|
1843
|
-
get sentry(): Sentry;
|
|
1844
|
-
private _healthNotifications?;
|
|
1845
|
-
get healthNotifications(): HealthNotifications;
|
|
1846
|
-
private _metrics?;
|
|
1847
|
-
get metrics(): Metrics;
|
|
1848
|
-
private _features?;
|
|
1849
|
-
get features(): Features;
|
|
1850
|
-
private _realtime?;
|
|
1851
|
-
get realtime(): Realtime;
|
|
1852
|
-
}
|
|
1853
|
-
export {};
|
|
1854
|
-
//# sourceMappingURL=sdk.gen.d.ts.map
|