@macro-inc/sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +177 -0
- package/dist/chunk-5HAKQN23.js +1263 -0
- package/dist/chunk-77EI4LSQ.js +2492 -0
- package/dist/chunk-CTKR64MY.js +1436 -0
- package/dist/chunk-JXIQT5TH.js +1467 -0
- package/dist/chunk-P4DTO6VD.js +830 -0
- package/dist/chunk-PAAFJYGO.js +967 -0
- package/dist/chunk-QNUS5BC5.js +913 -0
- package/dist/chunk-SGAHIERJ.js +1235 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
- package/dist/generated/agent-harness/client/index.d.ts +10 -0
- package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
- package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
- package/dist/generated/agent-harness/client.gen.d.ts +12 -0
- package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
- package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
- package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
- package/dist/generated/agent-harness/index.d.ts +2 -0
- package/dist/generated/agent-harness/index.js +6 -0
- package/dist/generated/agent-harness/sdk.gen.d.ts +84 -0
- package/dist/generated/agent-harness/types.gen.d.ts +539 -0
- package/dist/generated/auth/client/client.gen.d.ts +2 -0
- package/dist/generated/auth/client/index.d.ts +10 -0
- package/dist/generated/auth/client/types.gen.d.ts +120 -0
- package/dist/generated/auth/client/utils.gen.d.ts +37 -0
- package/dist/generated/auth/client.gen.d.ts +12 -0
- package/dist/generated/auth/core/auth.gen.d.ts +25 -0
- package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/auth/core/params.gen.d.ts +43 -0
- package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/auth/core/types.gen.d.ts +83 -0
- package/dist/generated/auth/core/utils.gen.d.ts +19 -0
- package/dist/generated/auth/index.d.ts +2 -0
- package/dist/generated/auth/index.js +6 -0
- package/dist/generated/auth/sdk.gen.d.ts +383 -0
- package/dist/generated/auth/types.gen.d.ts +2175 -0
- package/dist/generated/cognition/client/client.gen.d.ts +2 -0
- package/dist/generated/cognition/client/index.d.ts +10 -0
- package/dist/generated/cognition/client/types.gen.d.ts +120 -0
- package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
- package/dist/generated/cognition/client.gen.d.ts +12 -0
- package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
- package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/cognition/core/params.gen.d.ts +43 -0
- package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/cognition/core/types.gen.d.ts +83 -0
- package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
- package/dist/generated/cognition/index.d.ts +2 -0
- package/dist/generated/cognition/index.js +6 -0
- package/dist/generated/cognition/sdk.gen.d.ts +224 -0
- package/dist/generated/cognition/types.gen.d.ts +2484 -0
- package/dist/generated/connection/client/client.gen.d.ts +2 -0
- package/dist/generated/connection/client/index.d.ts +10 -0
- package/dist/generated/connection/client/types.gen.d.ts +120 -0
- package/dist/generated/connection/client/utils.gen.d.ts +37 -0
- package/dist/generated/connection/client.gen.d.ts +12 -0
- package/dist/generated/connection/core/auth.gen.d.ts +25 -0
- package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/connection/core/params.gen.d.ts +43 -0
- package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/connection/core/types.gen.d.ts +83 -0
- package/dist/generated/connection/core/utils.gen.d.ts +19 -0
- package/dist/generated/connection/index.d.ts +2 -0
- package/dist/generated/connection/index.js +839 -0
- package/dist/generated/connection/sdk.gen.d.ts +38 -0
- package/dist/generated/connection/types.gen.d.ts +235 -0
- package/dist/generated/contacts/client/client.gen.d.ts +2 -0
- package/dist/generated/contacts/client/index.d.ts +10 -0
- package/dist/generated/contacts/client/types.gen.d.ts +120 -0
- package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
- package/dist/generated/contacts/client.gen.d.ts +12 -0
- package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
- package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/contacts/core/params.gen.d.ts +43 -0
- package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/contacts/core/types.gen.d.ts +83 -0
- package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
- package/dist/generated/contacts/index.d.ts +2 -0
- package/dist/generated/contacts/index.js +6 -0
- package/dist/generated/contacts/sdk.gen.d.ts +43 -0
- package/dist/generated/contacts/types.gen.d.ts +52 -0
- package/dist/generated/email/client/client.gen.d.ts +2 -0
- package/dist/generated/email/client/index.d.ts +10 -0
- package/dist/generated/email/client/types.gen.d.ts +120 -0
- package/dist/generated/email/client/utils.gen.d.ts +37 -0
- package/dist/generated/email/client.gen.d.ts +12 -0
- package/dist/generated/email/core/auth.gen.d.ts +25 -0
- package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/email/core/params.gen.d.ts +43 -0
- package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/email/core/types.gen.d.ts +83 -0
- package/dist/generated/email/core/utils.gen.d.ts +19 -0
- package/dist/generated/email/index.d.ts +2 -0
- package/dist/generated/email/index.js +6 -0
- package/dist/generated/email/sdk.gen.d.ts +254 -0
- package/dist/generated/email/types.gen.d.ts +2614 -0
- package/dist/generated/notification/client/client.gen.d.ts +2 -0
- package/dist/generated/notification/client/index.d.ts +10 -0
- package/dist/generated/notification/client/types.gen.d.ts +120 -0
- package/dist/generated/notification/client/utils.gen.d.ts +37 -0
- package/dist/generated/notification/client.gen.d.ts +12 -0
- package/dist/generated/notification/core/auth.gen.d.ts +25 -0
- package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/notification/core/params.gen.d.ts +43 -0
- package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/notification/core/types.gen.d.ts +83 -0
- package/dist/generated/notification/core/utils.gen.d.ts +19 -0
- package/dist/generated/notification/index.d.ts +2 -0
- package/dist/generated/notification/index.js +6 -0
- package/dist/generated/notification/sdk.gen.d.ts +118 -0
- package/dist/generated/notification/types.gen.d.ts +1352 -0
- package/dist/generated/properties/client/client.gen.d.ts +2 -0
- package/dist/generated/properties/client/index.d.ts +10 -0
- package/dist/generated/properties/client/types.gen.d.ts +120 -0
- package/dist/generated/properties/client/utils.gen.d.ts +37 -0
- package/dist/generated/properties/client.gen.d.ts +12 -0
- package/dist/generated/properties/core/auth.gen.d.ts +25 -0
- package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/properties/core/params.gen.d.ts +43 -0
- package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/properties/core/types.gen.d.ts +83 -0
- package/dist/generated/properties/core/utils.gen.d.ts +19 -0
- package/dist/generated/properties/index.d.ts +2 -0
- package/dist/generated/properties/index.js +6 -0
- package/dist/generated/properties/sdk.gen.d.ts +158 -0
- package/dist/generated/properties/types.gen.d.ts +1288 -0
- package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
- package/dist/generated/scheduled-action/client/index.d.ts +10 -0
- package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
- package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
- package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
- package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
- package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
- package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
- package/dist/generated/scheduled-action/index.d.ts +2 -0
- package/dist/generated/scheduled-action/index.js +845 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +42 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +241 -0
- package/dist/generated/search/client/client.gen.d.ts +2 -0
- package/dist/generated/search/client/index.d.ts +10 -0
- package/dist/generated/search/client/types.gen.d.ts +120 -0
- package/dist/generated/search/client/utils.gen.d.ts +37 -0
- package/dist/generated/search/client.gen.d.ts +12 -0
- package/dist/generated/search/core/auth.gen.d.ts +25 -0
- package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/search/core/params.gen.d.ts +43 -0
- package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/search/core/types.gen.d.ts +83 -0
- package/dist/generated/search/core/utils.gen.d.ts +19 -0
- package/dist/generated/search/index.d.ts +2 -0
- package/dist/generated/search/index.js +6 -0
- package/dist/generated/search/sdk.gen.d.ts +44 -0
- package/dist/generated/search/types.gen.d.ts +2194 -0
- package/dist/generated/static-files/client/client.gen.d.ts +2 -0
- package/dist/generated/static-files/client/index.d.ts +10 -0
- package/dist/generated/static-files/client/types.gen.d.ts +120 -0
- package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
- package/dist/generated/static-files/client.gen.d.ts +12 -0
- package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
- package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/static-files/core/params.gen.d.ts +43 -0
- package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/static-files/core/types.gen.d.ts +83 -0
- package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
- package/dist/generated/static-files/index.d.ts +2 -0
- package/dist/generated/static-files/index.js +842 -0
- package/dist/generated/static-files/sdk.gen.d.ts +43 -0
- package/dist/generated/static-files/types.gen.d.ts +214 -0
- package/dist/generated/storage/client/client.gen.d.ts +2 -0
- package/dist/generated/storage/client/index.d.ts +10 -0
- package/dist/generated/storage/client/types.gen.d.ts +120 -0
- package/dist/generated/storage/client/utils.gen.d.ts +37 -0
- package/dist/generated/storage/client.gen.d.ts +12 -0
- package/dist/generated/storage/core/auth.gen.d.ts +25 -0
- package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/storage/core/params.gen.d.ts +43 -0
- package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/storage/core/types.gen.d.ts +83 -0
- package/dist/generated/storage/core/utils.gen.d.ts +19 -0
- package/dist/generated/storage/index.d.ts +2 -0
- package/dist/generated/storage/index.js +6 -0
- package/dist/generated/storage/sdk.gen.d.ts +858 -0
- package/dist/generated/storage/types.gen.d.ts +12105 -0
- package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
- package/dist/generated/unfurl/client/index.d.ts +10 -0
- package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
- package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
- package/dist/generated/unfurl/client.gen.d.ts +12 -0
- package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
- package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
- package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
- package/dist/generated/unfurl/index.d.ts +2 -0
- package/dist/generated/unfurl/index.js +835 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +125 -0
- package/dist/src/config.d.ts +51 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +45 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +18 -0
- package/dist/src/entities/bots/namespace.d.ts +25 -0
- package/dist/src/entities/calls/call-record.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +9 -0
- package/dist/src/entities/channels/channel.d.ts +88 -0
- package/dist/src/entities/channels/message.d.ts +64 -0
- package/dist/src/entities/channels/namespace.d.ts +30 -0
- package/dist/src/entities/channels/post.d.ts +20 -0
- package/dist/src/entities/channels/thread.d.ts +30 -0
- package/dist/src/entities/chats/chat.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +14 -0
- package/dist/src/entities/crm/comment.d.ts +43 -0
- package/dist/src/entities/crm/company.d.ts +70 -0
- package/dist/src/entities/crm/contact.d.ts +48 -0
- package/dist/src/entities/crm/namespace.d.ts +22 -0
- package/dist/src/entities/documents/comment.d.ts +41 -0
- package/dist/src/entities/documents/document.d.ts +130 -0
- package/dist/src/entities/documents/namespace.d.ts +43 -0
- package/dist/src/entities/documents/system-skill.d.ts +16 -0
- package/dist/src/entities/email/attachment.d.ts +36 -0
- package/dist/src/entities/email/label.d.ts +31 -0
- package/dist/src/entities/email/link.d.ts +29 -0
- package/dist/src/entities/email/message.d.ts +58 -0
- package/dist/src/entities/email/namespace.d.ts +49 -0
- package/dist/src/entities/email/thread.d.ts +88 -0
- package/dist/src/entities/entity.d.ts +101 -0
- package/dist/src/entities/favorites/namespace.d.ts +19 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +30 -0
- package/dist/src/entities/foreign/namespace.d.ts +7 -0
- package/dist/src/entities/notifications/namespace.d.ts +29 -0
- package/dist/src/entities/notifications/notification.d.ts +50 -0
- package/dist/src/entities/pins/namespace.d.ts +19 -0
- package/dist/src/entities/projects/namespace.d.ts +13 -0
- package/dist/src/entities/projects/project.d.ts +42 -0
- package/dist/src/entities/properties/namespace.d.ts +47 -0
- package/dist/src/entities/properties/property-definition.d.ts +45 -0
- package/dist/src/entities/properties/property-option.d.ts +32 -0
- package/dist/src/entities/search.d.ts +23 -0
- package/dist/src/entities/tasks/namespace.d.ts +21 -0
- package/dist/src/entities/tasks/task.d.ts +34 -0
- package/dist/src/entities/teams/namespace.d.ts +12 -0
- package/dist/src/entities/teams/team.d.ts +40 -0
- package/dist/src/entities/users/namespace.d.ts +10 -0
- package/dist/src/entities/users/user.d.ts +43 -0
- package/dist/src/entities/webhooks/namespace.d.ts +31 -0
- package/dist/src/entities/webhooks/webhook.d.ts +88 -0
- package/dist/src/events/hydrate/channel.d.ts +85 -0
- package/dist/src/events/hydrate/document.d.ts +54 -0
- package/dist/src/events/receiver.d.ts +51 -0
- package/dist/src/events/types.d.ts +40 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/macro.d.ts +62 -0
- package/dist/src/macro.js +4215 -0
- package/dist/src/mentions.d.ts +37 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/utils/client.d.ts +53 -0
- package/dist/src/utils/index.d.ts +4 -0
- package/dist/src/utils/lazy.d.ts +18 -0
- package/dist/src/utils/pagination.d.ts +7 -0
- package/dist/src/utils/unwrap.d.ts +23 -0
- package/package.json +49 -0
|
@@ -0,0 +1,383 @@
|
|
|
1
|
+
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
+
import type { AppleLoginData, AppleLoginErrors, AppleLoginResponses, CheckGithubLinkStatusData, CheckGithubLinkStatusErrors, CheckGithubLinkStatusResponses, CheckGmailLinkStatusData, CheckGmailLinkStatusErrors, CheckGmailLinkStatusResponses, CreateCheckoutSessionV2Data, CreateCheckoutSessionV2Errors, CreateCheckoutSessionV2Responses, CreateInProgressLinkData, CreateInProgressLinkErrors, CreateInProgressLinkResponses, CreateMergeRequestData, CreateMergeRequestErrors, CreateMergeRequestResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateTeamData, CreateTeamErrors, CreateTeamResponses, CreateUserData, CreateUserErrors, CreateUserResponses, DeleteCursorApiKeyData, DeleteCursorApiKeyErrors, DeleteCursorApiKeyResponses, DeleteGithubLinkData, DeleteGithubLinkErrors, DeleteGithubLinkResponses, DeleteTeamData, DeleteTeamErrors, DeleteTeamInviteHandlerData, DeleteTeamInviteHandlerErrors, DeleteTeamInviteHandlerResponses, DeleteTeamResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, EnrichGithubPullRequestsData, EnrichGithubPullRequestsErrors, EnrichGithubPullRequestsResponses, GenerateEmailLinkData, GenerateEmailLinkErrors, GenerateEmailLinkResponses, GetCursorApiKeyData, GetCursorApiKeyErrors, GetCursorApiKeyResponses, GetLegacyUserPermissionsData, GetLegacyUserPermissionsErrors, GetLegacyUserPermissionsResponses, GetPermissionsData, GetPermissionsErrors, GetPermissionsResponses, GetReferralCodeData, GetReferralCodeErrors, GetReferralCodeResponses, GetTeamData, GetTeamErrors, GetTeamInvitesData, GetTeamInvitesErrors, GetTeamInvitesResponses, GetTeamResponses, GetUserInfoData, GetUserInfoErrors, GetUserInfoResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserLinkExistsData, GetUserLinkExistsErrors, GetUserLinkExistsResponses, GetUserNameData, GetUserNameErrors, GetUserNameResponses, GetUserNamesData, GetUserNamesErrors, GetUserNamesResponses, GetUserNamesWithEmailData, GetUserNamesWithEmailErrors, GetUserNamesWithEmailResponses, GetUserOrganizationData, GetUserOrganizationErrors, GetUserOrganizationResponses, GetUserPermissionsData, GetUserPermissionsErrors, GetUserPermissionsResponses, GetUserQuotaData, GetUserQuotaErrors, GetUserQuotaResponses, GetUserTeamsData, GetUserTeamsErrors, GetUserTeamsResponses, HealthHandlerData, HealthHandlerResponses, InitGithubLinkData, InitGithubLinkErrors, InitGithubLinkResponses, InitGmailLinkData, InitGmailLinkErrors, InitGmailLinkResponses, InitOutlookLinkData, InitOutlookLinkErrors, InitOutlookLinkResponses, InviteToTeamData, InviteToTeamErrors, InviteToTeamResponses, JoinTeamData, JoinTeamErrors, JoinTeamResponses, ListCursorModelsData, ListCursorModelsErrors, ListCursorModelsResponses, LogoutData, LogoutResponses, MacroApiTokenData, MacroApiTokenErrors, MacroApiTokenResponses, Oauth2CallbackData, Oauth2CallbackErrors, Oauth2CallbackResponses, OauthRedirectData, OauthRedirectErrors, OauthRedirectResponses, PasswordlessCallbackData, PasswordlessCallbackErrors, PasswordlessCallbackResponses, PasswordlessLoginData, PasswordlessLoginErrors, PasswordlessLoginResponses, PasswordLoginData, PasswordLoginErrors, PasswordLoginResponses, PatchTeamCrmSettingsData, PatchTeamCrmSettingsErrors, PatchTeamCrmSettingsResponses, PatchTeamData, PatchTeamErrors, PatchTeamResponses, PatchUserGroupData, PatchUserGroupErrors, PatchUserGroupResponses, PatchUserOnboardingData, PatchUserOnboardingErrors, PatchUserOnboardingResponses, PatchUserTutorialData, PatchUserTutorialErrors, PatchUserTutorialResponses, PostProfilePicturesData, PostProfilePicturesErrors, PostProfilePicturesResponses, PutCursorApiKeyData, PutCursorApiKeyErrors, PutCursorApiKeyResponses, PutCursorDefaultModelData, PutCursorDefaultModelErrors, PutCursorDefaultModelResponses, PutProfilePictureData, PutProfilePictureErrors, PutProfilePictureResponses, PutUserNameData, PutUserNameErrors, PutUserNameResponses, RefreshData, RefreshErrors, RefreshResponses, RejectInvitationData, RejectInvitationErrors, RejectInvitationResponses, RemoveUserFromTeamData, RemoveUserFromTeamErrors, RemoveUserFromTeamResponses, ResendFusionauthVerifyUserEmailData, ResendFusionauthVerifyUserEmailErrors, ResendFusionauthVerifyUserEmailResponses, SendMobileWelcomeEmailData, SendMobileWelcomeEmailErrors, SendMobileWelcomeEmailResponses, SendReferralCodeData, SendReferralCodeErrors, SendReferralCodeResponses, SessionCreationData, SessionCreationErrors, SessionCreationResponses, SessionLoginData, SessionLoginErrors, SessionLoginResponses, SsoLoginData, SsoLoginErrors, SsoLoginResponses, ToggleTeamAutoJoinDomainData, ToggleTeamAutoJoinDomainErrors, ToggleTeamAutoJoinDomainResponses, ToggleTeamNonAdminInvitesData, ToggleTeamNonAdminInvitesErrors, ToggleTeamNonAdminInvitesResponses, VerifyEmailLinkData, VerifyEmailLinkErrors, VerifyEmailLinkResponses, VerifyFusionauthUserEmailData, VerifyFusionauthUserEmailErrors, VerifyFusionauthUserEmailResponses, VerifyMergeRequestData, VerifyMergeRequestErrors, VerifyMergeRequestResponses } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
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?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
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 Sdk extends HeyApiClient {
|
|
29
|
+
static readonly __registry: HeyApiRegistry<Sdk>;
|
|
30
|
+
constructor(args?: {
|
|
31
|
+
client?: Client;
|
|
32
|
+
key?: string;
|
|
33
|
+
});
|
|
34
|
+
/**
|
|
35
|
+
* Forgets the caller's Cursor API key.
|
|
36
|
+
*
|
|
37
|
+
* This does **not** revoke the key at Cursor — it keeps working everywhere
|
|
38
|
+
* else it is used, and only Cursor can revoke it. Any UI offering this has to
|
|
39
|
+
* say so rather than implying otherwise.
|
|
40
|
+
*
|
|
41
|
+
* Deleting when there is nothing to delete succeeds: the caller's intent is
|
|
42
|
+
* "I should have no key registered", and that is already true.
|
|
43
|
+
*/
|
|
44
|
+
deleteCursorApiKey<ThrowOnError extends boolean = false>(options?: Options<DeleteCursorApiKeyData, ThrowOnError>): RequestResult<DeleteCursorApiKeyResponses, DeleteCursorApiKeyErrors, ThrowOnError>;
|
|
45
|
+
/**
|
|
46
|
+
* Whether the caller has a Cursor API key registered.
|
|
47
|
+
*
|
|
48
|
+
* Never returns the key, or any part of it. There is no screen that needs one,
|
|
49
|
+
* and a masked key still leaks its length and alphabet.
|
|
50
|
+
*/
|
|
51
|
+
getCursorApiKey<ThrowOnError extends boolean = false>(options?: Options<GetCursorApiKeyData, ThrowOnError>): RequestResult<GetCursorApiKeyResponses, GetCursorApiKeyErrors, ThrowOnError>;
|
|
52
|
+
/**
|
|
53
|
+
* Registers or replaces the caller's Cursor API key.
|
|
54
|
+
*
|
|
55
|
+
* The key is validated on shape alone — this cannot distinguish a live key
|
|
56
|
+
* from forty random characters behind the right prefix. Confirming it against
|
|
57
|
+
* Cursor's `GET /v1/me` is the obvious improvement, and is what would let this
|
|
58
|
+
* report the connected account rather than only that a key exists.
|
|
59
|
+
*/
|
|
60
|
+
putCursorApiKey<ThrowOnError extends boolean = false>(options: Options<PutCursorApiKeyData, ThrowOnError>): RequestResult<PutCursorApiKeyResponses, PutCursorApiKeyErrors, ThrowOnError>;
|
|
61
|
+
/**
|
|
62
|
+
* Choose the model this user's `@cursor` sessions start on.
|
|
63
|
+
*
|
|
64
|
+
* Stores the id only; its parameters are resolved from Cursor's own default
|
|
65
|
+
* variant at session start. Not validated against the live model list here —
|
|
66
|
+
* the settings dropdown offers only real ids, and a stale id degrades to the
|
|
67
|
+
* deployment default at spawn rather than failing, so a round trip to Cursor
|
|
68
|
+
* on every save would buy nothing.
|
|
69
|
+
*/
|
|
70
|
+
putCursorDefaultModel<ThrowOnError extends boolean = false>(options: Options<PutCursorDefaultModelData, ThrowOnError>): RequestResult<PutCursorDefaultModelResponses, PutCursorDefaultModelErrors, ThrowOnError>;
|
|
71
|
+
/**
|
|
72
|
+
* List the models the caller's Cursor account offers.
|
|
73
|
+
*
|
|
74
|
+
* Reached only from the settings dropdown, so it decrypts the user's own key
|
|
75
|
+
* and asks Cursor directly — the list is per-account and changes, so there is
|
|
76
|
+
* nothing to cache statically. Reuses the harness's Cursor client rather than
|
|
77
|
+
* reimplementing the `/v1/models` parse, keeping one source of truth for what
|
|
78
|
+
* a model is.
|
|
79
|
+
*/
|
|
80
|
+
listCursorModels<ThrowOnError extends boolean = false>(options?: Options<ListCursorModelsData, ThrowOnError>): RequestResult<ListCursorModelsResponses, ListCursorModelsErrors, ThrowOnError>;
|
|
81
|
+
/**
|
|
82
|
+
* Verifies the user's primary email for FusionAuth
|
|
83
|
+
*/
|
|
84
|
+
verifyFusionauthUserEmail<ThrowOnError extends boolean = false>(options: Options<VerifyFusionauthUserEmailData, ThrowOnError>): RequestResult<VerifyFusionauthUserEmailResponses, VerifyFusionauthUserEmailErrors, ThrowOnError>;
|
|
85
|
+
/**
|
|
86
|
+
* Resend the user's primary email verification for FusionAuth
|
|
87
|
+
*/
|
|
88
|
+
resendFusionauthVerifyUserEmail<ThrowOnError extends boolean = false>(options: Options<ResendFusionauthVerifyUserEmailData, ThrowOnError>): RequestResult<ResendFusionauthVerifyUserEmailResponses, ResendFusionauthVerifyUserEmailErrors, ThrowOnError>;
|
|
89
|
+
/**
|
|
90
|
+
* Generates an email link for the user to verify their email address.
|
|
91
|
+
*/
|
|
92
|
+
generateEmailLink<ThrowOnError extends boolean = false>(options: Options<GenerateEmailLinkData, ThrowOnError>): RequestResult<GenerateEmailLinkResponses, GenerateEmailLinkErrors, ThrowOnError>;
|
|
93
|
+
/**
|
|
94
|
+
* Verifies the user's email for a user profile
|
|
95
|
+
*/
|
|
96
|
+
verifyEmailLink<ThrowOnError extends boolean = false>(options: Options<VerifyEmailLinkData, ThrowOnError>): RequestResult<VerifyEmailLinkResponses, VerifyEmailLinkErrors, ThrowOnError>;
|
|
97
|
+
/**
|
|
98
|
+
* Enriches GitHub pull request references with live GitHub data for the authenticated user.
|
|
99
|
+
*/
|
|
100
|
+
enrichGithubPullRequests<ThrowOnError extends boolean = false>(options: Options<EnrichGithubPullRequestsData, ThrowOnError>): RequestResult<EnrichGithubPullRequestsResponses, EnrichGithubPullRequestsErrors, ThrowOnError>;
|
|
101
|
+
/**
|
|
102
|
+
* Health check
|
|
103
|
+
*/
|
|
104
|
+
healthHandler<ThrowOnError extends boolean = false>(options?: Options<HealthHandlerData, ThrowOnError>): RequestResult<HealthHandlerResponses, unknown, ThrowOnError>;
|
|
105
|
+
/**
|
|
106
|
+
* Generates a macro-api-token using the user's macro-access-token
|
|
107
|
+
* You can either have your access token in the cookies or in the request
|
|
108
|
+
* headers
|
|
109
|
+
* Authorization: Bearer <access_token>
|
|
110
|
+
* This returns a new macro-api-token
|
|
111
|
+
*/
|
|
112
|
+
macroApiToken<ThrowOnError extends boolean = false>(options: Options<MacroApiTokenData, ThrowOnError>): RequestResult<MacroApiTokenResponses, MacroApiTokenErrors, ThrowOnError>;
|
|
113
|
+
/**
|
|
114
|
+
* Refreshes a JWT token
|
|
115
|
+
* You can either have your access token and refresh token in the cookies or in the request
|
|
116
|
+
* headers
|
|
117
|
+
* Authorization: Bearer <access_token>
|
|
118
|
+
* x-macro-refresh-token: <refresh_token>
|
|
119
|
+
* This returns the cookies with the new access and refresh token
|
|
120
|
+
*/
|
|
121
|
+
refresh<ThrowOnError extends boolean = false>(options?: Options<RefreshData, ThrowOnError>): RequestResult<RefreshResponses, RefreshErrors, ThrowOnError>;
|
|
122
|
+
/**
|
|
123
|
+
* Initiates a link for a user
|
|
124
|
+
*/
|
|
125
|
+
createInProgressLink<ThrowOnError extends boolean = false>(options?: Options<CreateInProgressLinkData, ThrowOnError>): RequestResult<CreateInProgressLinkResponses, CreateInProgressLinkErrors, ThrowOnError>;
|
|
126
|
+
/**
|
|
127
|
+
* Deletes a github link for a user
|
|
128
|
+
*/
|
|
129
|
+
deleteGithubLink<ThrowOnError extends boolean = false>(options?: Options<DeleteGithubLinkData, ThrowOnError>): RequestResult<DeleteGithubLinkResponses, DeleteGithubLinkErrors, ThrowOnError>;
|
|
130
|
+
/**
|
|
131
|
+
* Initiates a link for a user
|
|
132
|
+
*/
|
|
133
|
+
initGithubLink<ThrowOnError extends boolean = false>(options: Options<InitGithubLinkData, ThrowOnError>): RequestResult<InitGithubLinkResponses, InitGithubLinkErrors, ThrowOnError>;
|
|
134
|
+
/**
|
|
135
|
+
* Checks whether the authenticated user's GitHub link token is valid.
|
|
136
|
+
*/
|
|
137
|
+
checkGithubLinkStatus<ThrowOnError extends boolean = false>(options?: Options<CheckGithubLinkStatusData, ThrowOnError>): RequestResult<CheckGithubLinkStatusResponses, CheckGithubLinkStatusErrors, ThrowOnError>;
|
|
138
|
+
/**
|
|
139
|
+
* Initiates a Gmail link for a user
|
|
140
|
+
*/
|
|
141
|
+
initGmailLink<ThrowOnError extends boolean = false>(options: Options<InitGmailLinkData, ThrowOnError>): RequestResult<InitGmailLinkResponses, InitGmailLinkErrors, ThrowOnError>;
|
|
142
|
+
/**
|
|
143
|
+
* Checks whether the authenticated user's gmail link is valid.
|
|
144
|
+
*/
|
|
145
|
+
checkGmailLinkStatus<ThrowOnError extends boolean = false>(options?: Options<CheckGmailLinkStatusData, ThrowOnError>): RequestResult<CheckGmailLinkStatusResponses, CheckGmailLinkStatusErrors, ThrowOnError>;
|
|
146
|
+
/**
|
|
147
|
+
* Initiates a Microsoft Outlook account link for an authenticated user.
|
|
148
|
+
*/
|
|
149
|
+
initOutlookLink<ThrowOnError extends boolean = false>(options?: Options<InitOutlookLinkData, ThrowOnError>): RequestResult<InitOutlookLinkResponses, InitOutlookLinkErrors, ThrowOnError>;
|
|
150
|
+
/**
|
|
151
|
+
* Completes the apple login flow
|
|
152
|
+
*/
|
|
153
|
+
appleLogin<ThrowOnError extends boolean = false>(options: Options<AppleLoginData, ThrowOnError>): RequestResult<AppleLoginResponses, AppleLoginErrors, ThrowOnError>;
|
|
154
|
+
/**
|
|
155
|
+
* Performs a password login
|
|
156
|
+
*/
|
|
157
|
+
passwordLogin<ThrowOnError extends boolean = false>(options: Options<PasswordLoginData, ThrowOnError>): RequestResult<PasswordLoginResponses, PasswordLoginErrors, ThrowOnError>;
|
|
158
|
+
/**
|
|
159
|
+
* Initiates a passwordless login
|
|
160
|
+
*/
|
|
161
|
+
passwordlessLogin<ThrowOnError extends boolean = false>(options: Options<PasswordlessLoginData, ThrowOnError>): RequestResult<PasswordlessLoginResponses, PasswordlessLoginErrors, ThrowOnError>;
|
|
162
|
+
/**
|
|
163
|
+
* Initiates an SSO login
|
|
164
|
+
*/
|
|
165
|
+
ssoLogin<ThrowOnError extends boolean = false>(options: Options<SsoLoginData, ThrowOnError>): RequestResult<SsoLoginResponses, SsoLoginErrors, ThrowOnError>;
|
|
166
|
+
/**
|
|
167
|
+
* Initiates a passwordless login
|
|
168
|
+
*/
|
|
169
|
+
logout<ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>): RequestResult<LogoutResponses, unknown, ThrowOnError>;
|
|
170
|
+
/**
|
|
171
|
+
* Creates a merge request used to verify the user's email address in order to merge their
|
|
172
|
+
* accounts.
|
|
173
|
+
* This is different than generate_email_link which is used to verify a new email address to add a
|
|
174
|
+
* new profile to a user's account.
|
|
175
|
+
*/
|
|
176
|
+
createMergeRequest<ThrowOnError extends boolean = false>(options: Options<CreateMergeRequestData, ThrowOnError>): RequestResult<CreateMergeRequestResponses, CreateMergeRequestErrors, ThrowOnError>;
|
|
177
|
+
/**
|
|
178
|
+
* Verifies the merge request
|
|
179
|
+
*/
|
|
180
|
+
verifyMergeRequest<ThrowOnError extends boolean = false>(options: Options<VerifyMergeRequestData, ThrowOnError>): RequestResult<VerifyMergeRequestResponses, VerifyMergeRequestErrors, ThrowOnError>;
|
|
181
|
+
/**
|
|
182
|
+
* Enrolls a mobile lead in the Loops nurture sequence, which sends the welcome
|
|
183
|
+
* email inviting them to register on desktop. No-ops if the address was already
|
|
184
|
+
* enrolled, and rejects blocked addresses.
|
|
185
|
+
*/
|
|
186
|
+
sendMobileWelcomeEmail<ThrowOnError extends boolean = false>(options: Options<SendMobileWelcomeEmailData, ThrowOnError>): RequestResult<SendMobileWelcomeEmailResponses, SendMobileWelcomeEmailErrors, ThrowOnError>;
|
|
187
|
+
/**
|
|
188
|
+
* Handles oauth redirect
|
|
189
|
+
*/
|
|
190
|
+
passwordlessCallback<ThrowOnError extends boolean = false>(options: Options<PasswordlessCallbackData, ThrowOnError>): RequestResult<PasswordlessCallbackResponses, PasswordlessCallbackErrors, ThrowOnError>;
|
|
191
|
+
/**
|
|
192
|
+
* Handles oauth redirect
|
|
193
|
+
*/
|
|
194
|
+
oauthRedirect<ThrowOnError extends boolean = false>(options?: Options<OauthRedirectData, ThrowOnError>): RequestResult<OauthRedirectResponses, OauthRedirectErrors, ThrowOnError>;
|
|
195
|
+
/**
|
|
196
|
+
* Custom OAuth2 callback
|
|
197
|
+
*/
|
|
198
|
+
oauth2Callback<ThrowOnError extends boolean = false>(options: Options<Oauth2CallbackData, ThrowOnError>): RequestResult<Oauth2CallbackResponses, Oauth2CallbackErrors, ThrowOnError>;
|
|
199
|
+
/**
|
|
200
|
+
* Gets all permissions
|
|
201
|
+
*/
|
|
202
|
+
getPermissions<ThrowOnError extends boolean = false>(options?: Options<GetPermissionsData, ThrowOnError>): RequestResult<GetPermissionsResponses, GetPermissionsErrors, ThrowOnError>;
|
|
203
|
+
/**
|
|
204
|
+
* Gets a list of the users permissions
|
|
205
|
+
*/
|
|
206
|
+
getUserPermissions<ThrowOnError extends boolean = false>(options?: Options<GetUserPermissionsData, ThrowOnError>): RequestResult<GetUserPermissionsResponses, GetUserPermissionsErrors, ThrowOnError>;
|
|
207
|
+
/**
|
|
208
|
+
* Handler for `GET /referral-code`.
|
|
209
|
+
*
|
|
210
|
+
* Returns the authenticated user's referral code.
|
|
211
|
+
*/
|
|
212
|
+
getReferralCode<ThrowOnError extends boolean = false>(options?: Options<GetReferralCodeData, ThrowOnError>): RequestResult<GetReferralCodeResponses, GetReferralCodeErrors, ThrowOnError>;
|
|
213
|
+
/**
|
|
214
|
+
* Handler for `POST /referral/send`.
|
|
215
|
+
*
|
|
216
|
+
* Sends a referral code via email to a user
|
|
217
|
+
*/
|
|
218
|
+
sendReferralCode<ThrowOnError extends boolean = false>(options: Options<SendReferralCodeData, ThrowOnError>): RequestResult<SendReferralCodeResponses, SendReferralCodeErrors, ThrowOnError>;
|
|
219
|
+
/**
|
|
220
|
+
* Refreshes a JWT token
|
|
221
|
+
*/
|
|
222
|
+
sessionCreation<ThrowOnError extends boolean = false>(options?: Options<SessionCreationData, ThrowOnError>): RequestResult<SessionCreationResponses, SessionCreationErrors, ThrowOnError>;
|
|
223
|
+
/**
|
|
224
|
+
* Performs a login via session code
|
|
225
|
+
*/
|
|
226
|
+
sessionLogin<ThrowOnError extends boolean = false>(options: Options<SessionLoginData, ThrowOnError>): RequestResult<SessionLoginResponses, SessionLoginErrors, ThrowOnError>;
|
|
227
|
+
/**
|
|
228
|
+
* Deletes a team.
|
|
229
|
+
* This will update all team members roles and cancel your subscription for the team.
|
|
230
|
+
* This action is **irreversible** and you will not be able to recover the team afterwards.
|
|
231
|
+
*/
|
|
232
|
+
deleteTeam<ThrowOnError extends boolean = false>(options?: Options<DeleteTeamData, ThrowOnError>): RequestResult<DeleteTeamResponses, DeleteTeamErrors, ThrowOnError>;
|
|
233
|
+
/**
|
|
234
|
+
* Gets a team by ID.
|
|
235
|
+
*/
|
|
236
|
+
getTeam<ThrowOnError extends boolean = false>(options?: Options<GetTeamData, ThrowOnError>): RequestResult<GetTeamResponses, GetTeamErrors, ThrowOnError>;
|
|
237
|
+
/**
|
|
238
|
+
* Updates a team.
|
|
239
|
+
*/
|
|
240
|
+
patchTeam<ThrowOnError extends boolean = false>(options: Options<PatchTeamData, ThrowOnError>): RequestResult<PatchTeamResponses, PatchTeamErrors, ThrowOnError>;
|
|
241
|
+
/**
|
|
242
|
+
* Creates a new team.
|
|
243
|
+
*/
|
|
244
|
+
createTeam<ThrowOnError extends boolean = false>(options: Options<CreateTeamData, ThrowOnError>): RequestResult<CreateTeamResponses, CreateTeamErrors, ThrowOnError>;
|
|
245
|
+
/**
|
|
246
|
+
* Toggles automatic domain joining for the team. When the team has no
|
|
247
|
+
* auto-join domain, sets it to the team owner's email domain — rejected
|
|
248
|
+
* with a 400 when that domain is a generic email provider domain (e.g.
|
|
249
|
+
* gmail.com). When one is already set, removes it. New users whose email
|
|
250
|
+
* domain matches a team's auto-join domain are added to that team on
|
|
251
|
+
* signup. Requires the caller to be an Admin or Owner of the team.
|
|
252
|
+
*/
|
|
253
|
+
toggleTeamAutoJoinDomain<ThrowOnError extends boolean = false>(options?: Options<ToggleTeamAutoJoinDomainData, ThrowOnError>): RequestResult<ToggleTeamAutoJoinDomainResponses, ToggleTeamAutoJoinDomainErrors, ThrowOnError>;
|
|
254
|
+
/**
|
|
255
|
+
* Enables or disables CRM for the team. On enable with `backfill`
|
|
256
|
+
* (the default), kicks off a best-effort backfill that enqueues a
|
|
257
|
+
* `PopulateCrmForUser` message per team member (no-op if CRM is
|
|
258
|
+
* already enabled); without `backfill` the CRM starts empty and fills
|
|
259
|
+
* from new activity only. On disable,
|
|
260
|
+
* flips the flag and purges the team's CRM data (cascading through
|
|
261
|
+
* `crm_companies` → `crm_domains` / `crm_contacts` /
|
|
262
|
+
* `crm_contact_sources`). Requires the caller to be an Admin or
|
|
263
|
+
* Owner of the team.
|
|
264
|
+
*/
|
|
265
|
+
patchTeamCrmSettings<ThrowOnError extends boolean = false>(options: Options<PatchTeamCrmSettingsData, ThrowOnError>): RequestResult<PatchTeamCrmSettingsResponses, PatchTeamCrmSettingsErrors, ThrowOnError>;
|
|
266
|
+
/**
|
|
267
|
+
* Invites a user to a team.
|
|
268
|
+
*/
|
|
269
|
+
inviteToTeam<ThrowOnError extends boolean = false>(options: Options<InviteToTeamData, ThrowOnError>): RequestResult<InviteToTeamResponses, InviteToTeamErrors, ThrowOnError>;
|
|
270
|
+
/**
|
|
271
|
+
* Deletes a team invite from a team.
|
|
272
|
+
*/
|
|
273
|
+
deleteTeamInviteHandler<ThrowOnError extends boolean = false>(options: Options<DeleteTeamInviteHandlerData, ThrowOnError>): RequestResult<DeleteTeamInviteHandlerResponses, DeleteTeamInviteHandlerErrors, ThrowOnError>;
|
|
274
|
+
/**
|
|
275
|
+
* Gets all invites for a team.
|
|
276
|
+
*/
|
|
277
|
+
getTeamInvites<ThrowOnError extends boolean = false>(options?: Options<GetTeamInvitesData, ThrowOnError>): RequestResult<GetTeamInvitesResponses, GetTeamInvitesErrors, ThrowOnError>;
|
|
278
|
+
/**
|
|
279
|
+
* Rejects an invitation to join a team.
|
|
280
|
+
*/
|
|
281
|
+
rejectInvitation<ThrowOnError extends boolean = false>(options: Options<RejectInvitationData, ThrowOnError>): RequestResult<RejectInvitationResponses, RejectInvitationErrors, ThrowOnError>;
|
|
282
|
+
/**
|
|
283
|
+
* Joins a team by accepting an invite.
|
|
284
|
+
*/
|
|
285
|
+
joinTeam<ThrowOnError extends boolean = false>(options: Options<JoinTeamData, ThrowOnError>): RequestResult<JoinTeamResponses, JoinTeamErrors, ThrowOnError>;
|
|
286
|
+
/**
|
|
287
|
+
* Toggles whether non-admin members may invite users to the team. Teams
|
|
288
|
+
* start with this on (any member can invite); turning it off restricts
|
|
289
|
+
* inviting to team admins and owners. Requires the caller to be an Admin
|
|
290
|
+
* or Owner of the team.
|
|
291
|
+
*/
|
|
292
|
+
toggleTeamNonAdminInvites<ThrowOnError extends boolean = false>(options?: Options<ToggleTeamNonAdminInvitesData, ThrowOnError>): RequestResult<ToggleTeamNonAdminInvitesResponses, ToggleTeamNonAdminInvitesErrors, ThrowOnError>;
|
|
293
|
+
/**
|
|
294
|
+
* Removes a user from a team.
|
|
295
|
+
*/
|
|
296
|
+
removeUserFromTeam<ThrowOnError extends boolean = false>(options: Options<RemoveUserFromTeamData, ThrowOnError>): RequestResult<RemoveUserFromTeamResponses, RemoveUserFromTeamErrors, ThrowOnError>;
|
|
297
|
+
/**
|
|
298
|
+
* Gets all teams for the authenticated user.
|
|
299
|
+
*/
|
|
300
|
+
getUserTeams<ThrowOnError extends boolean = false>(options?: Options<GetUserTeamsData, ThrowOnError>): RequestResult<GetUserTeamsResponses, GetUserTeamsErrors, ThrowOnError>;
|
|
301
|
+
/**
|
|
302
|
+
* Gets all of a user's invitations.
|
|
303
|
+
*/
|
|
304
|
+
getUserInvites<ThrowOnError extends boolean = false>(options?: Options<GetUserInvitesData, ThrowOnError>): RequestResult<GetUserInvitesResponses, GetUserInvitesErrors, ThrowOnError>;
|
|
305
|
+
/**
|
|
306
|
+
* Creates a new user.
|
|
307
|
+
*/
|
|
308
|
+
createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): RequestResult<CreateUserResponses, CreateUserErrors, ThrowOnError>;
|
|
309
|
+
/**
|
|
310
|
+
* Retrieves user names in bulk
|
|
311
|
+
*/
|
|
312
|
+
getUserNames<ThrowOnError extends boolean = false>(options: Options<GetUserNamesData, ThrowOnError>): RequestResult<GetUserNamesResponses, GetUserNamesErrors, ThrowOnError>;
|
|
313
|
+
/**
|
|
314
|
+
* Gets names for passed user profile ids, falling back to the requesting user's email contact names
|
|
315
|
+
*/
|
|
316
|
+
getUserNamesWithEmail<ThrowOnError extends boolean = false>(options: Options<GetUserNamesWithEmailData, ThrowOnError>): RequestResult<GetUserNamesWithEmailResponses, GetUserNamesWithEmailErrors, ThrowOnError>;
|
|
317
|
+
/**
|
|
318
|
+
* Updates the user's group.
|
|
319
|
+
*/
|
|
320
|
+
patchUserGroup<ThrowOnError extends boolean = false>(options: Options<PatchUserGroupData, ThrowOnError>): RequestResult<PatchUserGroupResponses, PatchUserGroupErrors, ThrowOnError>;
|
|
321
|
+
/**
|
|
322
|
+
* Gets the calling user's info which matches what was given in the **deprecated**
|
|
323
|
+
* getUserPermissions query in our graphql api.
|
|
324
|
+
* This will eventually be removed and optimized to use smaller calls that grab
|
|
325
|
+
* what is needed for various parts of the UI.
|
|
326
|
+
*/
|
|
327
|
+
getLegacyUserPermissions<ThrowOnError extends boolean = false>(options?: Options<GetLegacyUserPermissionsData, ThrowOnError>): RequestResult<GetLegacyUserPermissionsResponses, GetLegacyUserPermissionsErrors, ThrowOnError>;
|
|
328
|
+
/**
|
|
329
|
+
* Returns whether or not a given idp link exists for a user
|
|
330
|
+
*/
|
|
331
|
+
getUserLinkExists<ThrowOnError extends boolean = false>(options: Options<GetUserLinkExistsData, ThrowOnError>): RequestResult<GetUserLinkExistsResponses, GetUserLinkExistsErrors, ThrowOnError>;
|
|
332
|
+
/**
|
|
333
|
+
* Deletes the user who calls this endpoint
|
|
334
|
+
*/
|
|
335
|
+
deleteUser<ThrowOnError extends boolean = false>(options?: Options<DeleteUserData, ThrowOnError>): RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError>;
|
|
336
|
+
/**
|
|
337
|
+
* Gets the calling user's info
|
|
338
|
+
*/
|
|
339
|
+
getUserInfo<ThrowOnError extends boolean = false>(options?: Options<GetUserInfoData, ThrowOnError>): RequestResult<GetUserInfoResponses, GetUserInfoErrors, ThrowOnError>;
|
|
340
|
+
/**
|
|
341
|
+
* Retrieves the name of a particular user.
|
|
342
|
+
*/
|
|
343
|
+
getUserName<ThrowOnError extends boolean = false>(options?: Options<GetUserNameData, ThrowOnError>): RequestResult<GetUserNameResponses, GetUserNameErrors, ThrowOnError>;
|
|
344
|
+
/**
|
|
345
|
+
* Sets the name of a particular user
|
|
346
|
+
*/
|
|
347
|
+
putUserName<ThrowOnError extends boolean = false>(options?: Options<PutUserNameData, ThrowOnError>): RequestResult<PutUserNameResponses, PutUserNameErrors, ThrowOnError>;
|
|
348
|
+
/**
|
|
349
|
+
* Updates the user's onboarding.
|
|
350
|
+
*/
|
|
351
|
+
patchUserOnboarding<ThrowOnError extends boolean = false>(options: Options<PatchUserOnboardingData, ThrowOnError>): RequestResult<PatchUserOnboardingResponses, PatchUserOnboardingErrors, ThrowOnError>;
|
|
352
|
+
/**
|
|
353
|
+
* Retrieves the users organization if present.
|
|
354
|
+
* Returns NO_CONTENT if the user is a not part of an organization.
|
|
355
|
+
*/
|
|
356
|
+
getUserOrganization<ThrowOnError extends boolean = false>(options?: Options<GetUserOrganizationData, ThrowOnError>): RequestResult<GetUserOrganizationResponses, GetUserOrganizationErrors, ThrowOnError>;
|
|
357
|
+
/**
|
|
358
|
+
* Sets the profile picture URL for a particular user
|
|
359
|
+
*/
|
|
360
|
+
putProfilePicture<ThrowOnError extends boolean = false>(options: Options<PutProfilePictureData, ThrowOnError>): RequestResult<PutProfilePictureResponses, PutProfilePictureErrors, ThrowOnError>;
|
|
361
|
+
/**
|
|
362
|
+
* Retrieves profile picture URLs for a list of users
|
|
363
|
+
*/
|
|
364
|
+
postProfilePictures<ThrowOnError extends boolean = false>(options: Options<PostProfilePicturesData, ThrowOnError>): RequestResult<PostProfilePicturesResponses, PostProfilePicturesErrors, ThrowOnError>;
|
|
365
|
+
/**
|
|
366
|
+
* Retrieves the users quota.
|
|
367
|
+
* Returns NO_CONTENT if the user is a premium user with no quota.
|
|
368
|
+
*/
|
|
369
|
+
getUserQuota<ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>): RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError>;
|
|
370
|
+
/**
|
|
371
|
+
* Creates a Stripe checkout session for the user to subscribe.
|
|
372
|
+
*/
|
|
373
|
+
createCheckoutSessionV2<ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionV2Data, ThrowOnError>): RequestResult<CreateCheckoutSessionV2Responses, CreateCheckoutSessionV2Errors, ThrowOnError>;
|
|
374
|
+
/**
|
|
375
|
+
* Creates a Stripe billing portal session.
|
|
376
|
+
*/
|
|
377
|
+
createPortalSession<ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>): RequestResult<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError>;
|
|
378
|
+
/**
|
|
379
|
+
* Updates the user's tutorialComplete flag.
|
|
380
|
+
*/
|
|
381
|
+
patchUserTutorial<ThrowOnError extends boolean = false>(options: Options<PatchUserTutorialData, ThrowOnError>): RequestResult<PatchUserTutorialResponses, PatchUserTutorialErrors, ThrowOnError>;
|
|
382
|
+
}
|
|
383
|
+
export {};
|