@vibexp/api-client 0.1.0
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/LICENSE +21 -0
- package/README.md +93 -0
- package/dist/axios/client/client.gen.d.ts +2 -0
- package/dist/axios/client/client.gen.js +130 -0
- package/dist/axios/client/index.d.ts +10 -0
- package/dist/axios/client/index.js +6 -0
- package/dist/axios/client/types.gen.d.ts +87 -0
- package/dist/axios/client/types.gen.js +2 -0
- package/dist/axios/client/utils.gen.d.ts +14 -0
- package/dist/axios/client/utils.gen.js +168 -0
- package/dist/axios/client.gen.d.ts +12 -0
- package/dist/axios/client.gen.js +3 -0
- package/dist/axios/core/auth.gen.d.ts +25 -0
- package/dist/axios/core/auth.gen.js +14 -0
- package/dist/axios/core/bodySerializer.gen.d.ts +25 -0
- package/dist/axios/core/bodySerializer.gen.js +57 -0
- package/dist/axios/core/params.gen.d.ts +43 -0
- package/dist/axios/core/params.gen.js +100 -0
- package/dist/axios/core/pathSerializer.gen.d.ts +33 -0
- package/dist/axios/core/pathSerializer.gen.js +106 -0
- package/dist/axios/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/axios/core/queryKeySerializer.gen.js +92 -0
- package/dist/axios/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/axios/core/serverSentEvents.gen.js +132 -0
- package/dist/axios/core/types.gen.d.ts +83 -0
- package/dist/axios/core/types.gen.js +2 -0
- package/dist/axios/core/utils.gen.d.ts +19 -0
- package/dist/axios/core/utils.gen.js +87 -0
- package/dist/axios/index.d.ts +2 -0
- package/dist/axios/index.js +2 -0
- package/dist/axios/sdk.gen.d.ts +1391 -0
- package/dist/axios/sdk.gen.js +3600 -0
- package/dist/axios/types.gen.d.ts +11043 -0
- package/dist/axios/types.gen.js +2 -0
- package/dist/axios-entry.d.ts +2 -0
- package/dist/axios-entry.js +6 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +17 -0
- package/dist/schema.d.ts +18671 -0
- package/dist/schema.js +5 -0
- package/package.json +51 -0
|
@@ -0,0 +1,1391 @@
|
|
|
1
|
+
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client';
|
|
2
|
+
import type { AcceptInvitationData, AcceptInvitationErrors, AcceptInvitationResponses, ArchiveFeedItemData, ArchiveFeedItemErrors, ArchiveFeedItemResponses, AuthCallbackData, AuthCallbackErrors, BackfillEmbeddingsData, BackfillEmbeddingsErrors, BackfillEmbeddingsResponses, CompleteAgentExecutionData, CompleteAgentExecutionErrors, CompleteAgentExecutionResponses, CompleteOnboardingData, CompleteOnboardingErrors, CompleteOnboardingResponses, CreateActivityData, CreateActivityErrors, CreateActivityResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateApiKeySettingsData, CreateApiKeySettingsErrors, CreateApiKeySettingsResponses, CreateArtifactData, CreateArtifactErrors, CreateArtifactResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateEmbeddingProviderData, CreateEmbeddingProviderErrors, CreateEmbeddingProviderResponses, CreateEmbeddingProviderSettingsData, CreateEmbeddingProviderSettingsErrors, CreateEmbeddingProviderSettingsResponses, CreateFeedData, CreateFeedErrors, CreateFeedItemData, CreateFeedItemErrors, CreateFeedItemReplyData, CreateFeedItemReplyErrors, CreateFeedItemReplyResponses, CreateFeedItemResponses, CreateFeedResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreatePromptData, CreatePromptErrors, CreatePromptResponses, CreatePromptShareData, CreatePromptShareErrors, CreatePromptShareResponses, CreateTeamData, CreateTeamErrors, CreateTeamResponses, CreateTypeData, CreateTypeErrors, CreateTypeResponses, DeleteAgentData, DeleteAgentErrors, DeleteAgentResponses, DeleteApiKeyData, DeleteApiKeyErrors, DeleteApiKeyResponses, DeleteApiKeySettingsData, DeleteApiKeySettingsErrors, DeleteApiKeySettingsResponses, DeleteArtifactAttachmentData, DeleteArtifactAttachmentErrors, DeleteArtifactAttachmentResponses, DeleteArtifactData, DeleteArtifactErrors, DeleteArtifactResponses, DeleteAttachmentData, DeleteAttachmentErrors, DeleteAttachmentResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteClaudeCodeSessionData, DeleteClaudeCodeSessionErrors, DeleteClaudeCodeSessionResponses, DeleteCursorIdeSessionData, DeleteCursorIdeSessionErrors, DeleteCursorIdeSessionResponses, DeleteDeviceTokenData, DeleteDeviceTokenErrors, DeleteDeviceTokenResponses, DeleteEmbeddingProviderData, DeleteEmbeddingProviderErrors, DeleteEmbeddingProviderResponses, DeleteEmbeddingProviderSettingsData, DeleteEmbeddingProviderSettingsErrors, DeleteEmbeddingProviderSettingsResponses, DeleteFeedData, DeleteFeedErrors, DeleteFeedItemData, DeleteFeedItemErrors, DeleteFeedItemResponses, DeleteFeedResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponses, DeleteProjectData, DeleteProjectErrors, DeleteProjectResponses, DeletePromptData, DeletePromptErrors, DeletePromptResponses, DeletePromptShareData, DeletePromptShareErrors, DeletePromptShareResponses, DeleteTeamData, DeleteTeamErrors, DeleteTeamResponses, DeleteTypeData, DeleteTypeErrors, DeleteTypeResponses, DevLoginData, DevLoginErrors, DevLoginResponses, DisconnectGitHubData, DisconnectGitHubErrors, DisconnectGitHubResponses, DownloadArtifactAttachmentData, DownloadArtifactAttachmentErrors, DownloadArtifactAttachmentResponses, DownloadAttachmentData, DownloadAttachmentErrors, DownloadAttachmentResponses, ExecuteAgentData, ExecuteAgentErrors, ExecuteAgentResponses, GetActivityData, GetActivityEntityTypesData, GetActivityEntityTypesErrors, GetActivityEntityTypesResponses, GetActivityErrors, GetActivityResponses, GetActivityStatsData, GetActivityStatsErrors, GetActivityStatsResponses, GetActivityTypesData, GetActivityTypesErrors, GetActivityTypesResponses, GetAgentData, GetAgentErrors, GetAgentExecutionData, GetAgentExecutionErrors, GetAgentExecutionEventsData, GetAgentExecutionEventsErrors, GetAgentExecutionEventsResponses, GetAgentExecutionResponses, GetAgentExecutionStatusData, GetAgentExecutionStatusErrors, GetAgentExecutionStatusResponses, GetAgentResponses, GetAgentStatsData, GetAgentStatsErrors, GetAgentStatsResponses, GetArtifactData, GetArtifactErrors, GetArtifactResponses, GetArtifactStatsData, GetArtifactStatsErrors, GetArtifactStatsResponses, GetArtifactVersionData, GetArtifactVersionErrors, GetArtifactVersionResponses, GetBlueprintData, GetBlueprintErrors, GetBlueprintResponses, GetBlueprintStatsData, GetBlueprintStatsErrors, GetBlueprintStatsResponses, GetBlueprintVersionData, GetBlueprintVersionErrors, GetBlueprintVersionResponses, GetClaudeCodeOverviewStatsData, GetClaudeCodeOverviewStatsErrors, GetClaudeCodeOverviewStatsResponses, GetClaudeCodeSessionCountsData, GetClaudeCodeSessionCountsErrors, GetClaudeCodeSessionCountsResponses, GetCursorIdeOverviewStatsData, GetCursorIdeOverviewStatsErrors, GetCursorIdeOverviewStatsResponses, GetCursorIdeSessionCountsData, GetCursorIdeSessionCountsErrors, GetCursorIdeSessionCountsResponses, GetEmbeddingProviderData, GetEmbeddingProviderErrors, GetEmbeddingProviderResponses, GetEmbeddingProviderSettingsData, GetEmbeddingProviderSettingsErrors, GetEmbeddingProviderSettingsResponses, GetFeedData, GetFeedErrors, GetFeedItemData, GetFeedItemErrors, GetFeedItemResponses, GetFeedResponses, GetGitHubInstallUrlData, GetGitHubInstallUrlErrors, GetGitHubInstallUrlResponses, GetGitHubStatusData, GetGitHubStatusErrors, GetGitHubStatusResponses, GetInvitationByTokenData, GetInvitationByTokenErrors, GetInvitationByTokenResponses, GetMeData, GetMeErrors, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMemoryVersionData, GetMemoryVersionErrors, GetMemoryVersionResponses, GetMeResponses, GetPendingInvitationsData, GetPendingInvitationsErrors, GetPendingInvitationsResponses, GetPreferencesData, GetPreferencesErrors, GetPreferencesResponses, GetProjectData, GetProjectErrors, GetProjectMigrationInventoryData, GetProjectMigrationInventoryErrors, GetProjectMigrationInventoryResponses, GetProjectResourceCreationMetricsData, GetProjectResourceCreationMetricsErrors, GetProjectResourceCreationMetricsResponses, GetProjectResponses, GetProjectStatsData, GetProjectStatsErrors, GetProjectStatsResponses, GetPromptData, GetPromptDependenciesData, GetPromptDependenciesErrors, GetPromptDependenciesResponses, GetPromptErrors, GetPromptGalleryCategoriesData, GetPromptGalleryCategoriesErrors, GetPromptGalleryCategoriesResponses, GetPromptGalleryPromptData, GetPromptGalleryPromptErrors, GetPromptGalleryPromptResponses, GetPromptLabelsData, GetPromptLabelsErrors, GetPromptLabelsResponses, GetPromptPlaceholdersData, GetPromptPlaceholdersErrors, GetPromptPlaceholdersResponses, GetPromptResponses, GetPromptShareData, GetPromptShareErrors, GetPromptShareResponses, GetPromptVersionData, GetPromptVersionErrors, GetPromptVersionResponses, GetResourceAccessMetricsData, GetResourceAccessMetricsErrors, GetResourceAccessMetricsResponses, GetResourceUsageData, GetResourceUsageErrors, GetResourceUsageResponses, GetSharedPromptData, GetSharedPromptErrors, GetSharedPromptResponses, GetTeamData, GetTeamErrors, GetTeamFeedCreationMetricsData, GetTeamFeedCreationMetricsErrors, GetTeamFeedCreationMetricsResponses, GetTeamMembersData, GetTeamMembersErrors, GetTeamMembersResponses, GetTeamResourceAccessMetricsData, GetTeamResourceAccessMetricsErrors, GetTeamResourceAccessMetricsResponses, GetTeamResourceCreationMetricsData, GetTeamResourceCreationMetricsErrors, GetTeamResourceCreationMetricsResponses, GetTeamResponses, GetTeamStatsData, GetTeamStatsErrors, GetTeamStatsResponses, GetTeamTopAccessedResourcesData, GetTeamTopAccessedResourcesErrors, GetTeamTopAccessedResourcesResponses, GetUnreadNotificationCountData, GetUnreadNotificationCountErrors, GetUnreadNotificationCountResponses, GetUsageAndGrowthData, GetUsageAndGrowthErrors, GetUsageAndGrowthResponses, HandleGitHubCallbackData, HandleGitHubCallbackErrors, HandleGitHubCallbackResponses, HandleGitHubWebhookData, HandleGitHubWebhookErrors, HandleGitHubWebhookResponses, HealthData, HealthResponses, ImportGitHubBlueprintsData, ImportGitHubBlueprintsErrors, ImportGitHubBlueprintsResponses, ImportGitHubProjectData, ImportGitHubProjectErrors, ImportGitHubProjectResponses, IngestClaudeCodeHookData, IngestClaudeCodeHookErrors, IngestClaudeCodeHookResponses, IngestCursorIdeHookData, IngestCursorIdeHookErrors, IngestCursorIdeHookResponses, ListActivitiesData, ListActivitiesErrors, ListActivitiesResponses, ListAgentConversationsData, ListAgentConversationsErrors, ListAgentConversationsResponses, ListAgentExecutionsData, ListAgentExecutionsErrors, ListAgentExecutionsResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListApiKeysData, ListApiKeysErrors, ListApiKeysResponses, ListApiKeysSettingsData, ListApiKeysSettingsErrors, ListApiKeysSettingsResponses, ListArtifactAttachmentsData, ListArtifactAttachmentsErrors, ListArtifactAttachmentsResponses, ListArtifactsByProjectData, ListArtifactsByProjectErrors, ListArtifactsByProjectResponses, ListArtifactsData, ListArtifactsErrors, ListArtifactsResponses, ListArtifactVersionsData, ListArtifactVersionsErrors, ListArtifactVersionsResponses, ListAttachmentsData, ListAttachmentsErrors, ListAttachmentsResponses, ListBlueprintVersionsData, ListBlueprintVersionsErrors, ListBlueprintVersionsResponses, ListClaudeCodeHooksData, ListClaudeCodeHooksErrors, ListClaudeCodeHooksResponses, ListClaudeCodeRecentActivitiesData, ListClaudeCodeRecentActivitiesErrors, ListClaudeCodeRecentActivitiesResponses, ListClaudeCodeSessionsData, ListClaudeCodeSessionsErrors, ListClaudeCodeSessionsResponses, ListConversationExecutionsData, ListConversationExecutionsErrors, ListConversationExecutionsResponses, ListCursorIdeHooksData, ListCursorIdeHooksErrors, ListCursorIdeHooksResponses, ListCursorIdeRecentActivitiesData, ListCursorIdeRecentActivitiesErrors, ListCursorIdeRecentActivitiesResponses, ListCursorIdeSessionsData, ListCursorIdeSessionsErrors, ListCursorIdeSessionsResponses, ListEmbeddingProvidersData, ListEmbeddingProvidersErrors, ListEmbeddingProvidersResponses, ListEmbeddingProvidersSettingsData, ListEmbeddingProvidersSettingsErrors, ListEmbeddingProvidersSettingsResponses, ListFeedItemRepliesData, ListFeedItemRepliesErrors, ListFeedItemRepliesResponses, ListFeedItemsByFeedData, ListFeedItemsByFeedErrors, ListFeedItemsByFeedResponses, ListFeedItemsData, ListFeedItemsErrors, ListFeedItemsResponses, ListFeedsData, ListFeedsErrors, ListFeedsResponses, ListGitHubRepositoriesData, ListGitHubRepositoriesErrors, ListGitHubRepositoriesResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListMemoryVersionsData, ListMemoryVersionsErrors, ListMemoryVersionsResponses, ListNotificationsData, ListNotificationsErrors, ListNotificationsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListPromptGalleryPromptsData, ListPromptGalleryPromptsErrors, ListPromptGalleryPromptsResponses, ListPromptsData, ListPromptsErrors, ListPromptsResponses, ListPromptVersionsData, ListPromptVersionsErrors, ListPromptVersionsResponses, ListSpecLibrariesByProjectData, ListSpecLibrariesByProjectErrors, ListSpecLibrariesByProjectResponses, ListSpecLibrariesData, ListSpecLibrariesErrors, ListSpecLibrariesResponses, ListTeamInvitationsData, ListTeamInvitationsErrors, ListTeamInvitationsResponses, ListTeamsData, ListTeamsErrors, ListTeamsResponses, ListTypesData, ListTypesErrors, ListTypesResponses, LoginData, LoginErrors, LoginResponses, LogoutData, LogoutErrors, LogoutResponses, MarkAllNotificationsReadData, MarkAllNotificationsReadErrors, MarkAllNotificationsReadResponses, MarkNotificationReadData, MarkNotificationReadErrors, MarkNotificationReadResponses, MigrateProjectData, MigrateProjectErrors, MigrateProjectResponses, PingData, PingResponses, PreviewAgentCardData, PreviewAgentCardErrors, PreviewAgentCardResponses, RegisterDeviceTokenData, RegisterDeviceTokenErrors, RegisterDeviceTokenResponses, RejectInvitationData, RejectInvitationErrors, RejectInvitationResponses, RemoveTeamMemberData, RemoveTeamMemberErrors, RemoveTeamMemberResponses, RenderPromptData, RenderPromptErrors, RenderPromptResponses, RestoreArtifactVersionData, RestoreArtifactVersionErrors, RestoreArtifactVersionResponses, RestoreBlueprintVersionData, RestoreBlueprintVersionErrors, RestoreBlueprintVersionResponses, RestoreMemoryVersionData, RestoreMemoryVersionErrors, RestoreMemoryVersionResponses, RestorePromptVersionData, RestorePromptVersionErrors, RestorePromptVersionResponses, RevokeTeamInvitationData, RevokeTeamInvitationErrors, RevokeTeamInvitationResponses, SearchMemoriesByMetadataData, SearchMemoriesByMetadataErrors, SearchMemoriesByMetadataResponses, SearchTeamResourcesData, SearchTeamResourcesErrors, SearchTeamResourcesResponses, SendContactMessageData, SendContactMessageErrors, SendContactMessageResponses, SendTeamInvitationsData, SendTeamInvitationsErrors, SendTeamInvitationsResponses, StartAgentExecutionData, StartAgentExecutionErrors, StartAgentExecutionResponses, SubmitSupportRequestData, SubmitSupportRequestErrors, SubmitSupportRequestResponses, TrackPromptGalleryUsageData, TrackPromptGalleryUsageErrors, TrackPromptGalleryUsageResponses, UnarchiveFeedItemData, UnarchiveFeedItemErrors, UnarchiveFeedItemResponses, UpdateAgentCredentialsData, UpdateAgentCredentialsErrors, UpdateAgentCredentialsResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateArtifactData, UpdateArtifactErrors, UpdateArtifactResponses, UpdateBlueprintData, UpdateBlueprintErrors, UpdateBlueprintResponses, UpdateEmbeddingProviderData, UpdateEmbeddingProviderErrors, UpdateEmbeddingProviderResponses, UpdateEmbeddingProviderSettingsData, UpdateEmbeddingProviderSettingsErrors, UpdateEmbeddingProviderSettingsResponses, UpdateFeedData, UpdateFeedErrors, UpdateFeedResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdatePreferencesData, UpdatePreferencesErrors, UpdatePreferencesResponses, UpdateProjectData, UpdateProjectErrors, UpdateProjectResponses, UpdatePromptData, UpdatePromptErrors, UpdatePromptResponses, UpdateTeamData, UpdateTeamErrors, UpdateTeamResponses, UploadArtifactAttachmentData, UploadArtifactAttachmentErrors, UploadArtifactAttachmentResponses, UploadAttachmentData, UploadAttachmentErrors, UploadAttachmentResponses, ValidateEmbeddingProviderData, ValidateEmbeddingProviderErrors, ValidateEmbeddingProviderResponses, ValidateEmbeddingProviderSettingsData, ValidateEmbeddingProviderSettingsErrors, ValidateEmbeddingProviderSettingsResponses } 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
|
+
/**
|
|
17
|
+
* Health ping endpoint
|
|
18
|
+
*
|
|
19
|
+
* Simple endpoint to check if the service is running
|
|
20
|
+
*/
|
|
21
|
+
export declare const ping: <ThrowOnError extends boolean = false>(options?: Options<PingData, ThrowOnError>) => RequestResult<PingResponses, unknown, ThrowOnError>;
|
|
22
|
+
/**
|
|
23
|
+
* Detailed health check
|
|
24
|
+
*
|
|
25
|
+
* Returns detailed health status of the service
|
|
26
|
+
*/
|
|
27
|
+
export declare const health: <ThrowOnError extends boolean = false>(options?: Options<HealthData, ThrowOnError>) => RequestResult<HealthResponses, unknown, ThrowOnError>;
|
|
28
|
+
/**
|
|
29
|
+
* Initiate WorkOS login
|
|
30
|
+
*
|
|
31
|
+
* Generates a CSRF state, stores it in a signed `vx_state` cookie, and returns the
|
|
32
|
+
* WorkOS AuthKit authorization URL. The client should redirect the user to this URL
|
|
33
|
+
* to begin the authentication flow.
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare const login: <ThrowOnError extends boolean = false>(options?: Options<LoginData, ThrowOnError>) => RequestResult<LoginResponses, LoginErrors, ThrowOnError>;
|
|
37
|
+
/**
|
|
38
|
+
* Handle WorkOS OAuth callback
|
|
39
|
+
*
|
|
40
|
+
* Validates the CSRF `vx_state` cookie, exchanges the authorization code with WorkOS,
|
|
41
|
+
* looks up or creates the user, writes a session cookie, and issues a 302 redirect
|
|
42
|
+
* to the frontend home page. This endpoint is called by the browser after the user
|
|
43
|
+
* authenticates with WorkOS — it does not return a JSON body on success.
|
|
44
|
+
*
|
|
45
|
+
*/
|
|
46
|
+
export declare const authCallback: <ThrowOnError extends boolean = false>(options: Options<AuthCallbackData, ThrowOnError>) => RequestResult<unknown, AuthCallbackErrors, ThrowOnError>;
|
|
47
|
+
/**
|
|
48
|
+
* Log out current user
|
|
49
|
+
*
|
|
50
|
+
* Clears the session cookie and returns a JSON confirmation. After calling this
|
|
51
|
+
* endpoint the client should discard any cached user state and redirect to the
|
|
52
|
+
* login page.
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
export declare const logout: <ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>) => RequestResult<LogoutResponses, LogoutErrors, ThrowOnError>;
|
|
56
|
+
/**
|
|
57
|
+
* Dev login (development only)
|
|
58
|
+
*
|
|
59
|
+
* Creates or retrieves a user by email address and sets a session cookie without
|
|
60
|
+
* going through WorkOS. Only available when the server is running in development
|
|
61
|
+
* mode (`DEV_LOGIN_ENABLED=true`). Returns 404 in all other environments.
|
|
62
|
+
*
|
|
63
|
+
*/
|
|
64
|
+
export declare const devLogin: <ThrowOnError extends boolean = false>(options: Options<DevLoginData, ThrowOnError>) => RequestResult<DevLoginResponses, DevLoginErrors, ThrowOnError>;
|
|
65
|
+
/**
|
|
66
|
+
* Get current user information
|
|
67
|
+
*
|
|
68
|
+
* Returns information about the currently authenticated user. Authentication is
|
|
69
|
+
* verified via the encrypted session cookie (`vx_session`) set during the WorkOS
|
|
70
|
+
* OAuth flow or dev login.
|
|
71
|
+
*
|
|
72
|
+
*/
|
|
73
|
+
export declare const getMe: <ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>) => RequestResult<GetMeResponses, GetMeErrors, ThrowOnError>;
|
|
74
|
+
/**
|
|
75
|
+
* List API keys
|
|
76
|
+
*
|
|
77
|
+
* Retrieves all API keys for the authenticated user
|
|
78
|
+
*/
|
|
79
|
+
export declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListApiKeysData, ThrowOnError>) => RequestResult<ListApiKeysResponses, ListApiKeysErrors, ThrowOnError>;
|
|
80
|
+
/**
|
|
81
|
+
* Create new API key
|
|
82
|
+
*
|
|
83
|
+
* Creates a new API key for the authenticated user
|
|
84
|
+
*/
|
|
85
|
+
export declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
86
|
+
/**
|
|
87
|
+
* Delete API key
|
|
88
|
+
*
|
|
89
|
+
* Deletes an API key by ID
|
|
90
|
+
*/
|
|
91
|
+
export declare const deleteApiKey: <ThrowOnError extends boolean = false>(options: Options<DeleteApiKeyData, ThrowOnError>) => RequestResult<DeleteApiKeyResponses, DeleteApiKeyErrors, ThrowOnError>;
|
|
92
|
+
/**
|
|
93
|
+
* List API keys (Settings)
|
|
94
|
+
*
|
|
95
|
+
* Retrieves all API keys for the authenticated user (settings route)
|
|
96
|
+
*/
|
|
97
|
+
export declare const listApiKeysSettings: <ThrowOnError extends boolean = false>(options?: Options<ListApiKeysSettingsData, ThrowOnError>) => RequestResult<ListApiKeysSettingsResponses, ListApiKeysSettingsErrors, ThrowOnError>;
|
|
98
|
+
/**
|
|
99
|
+
* Create new API key (Settings)
|
|
100
|
+
*
|
|
101
|
+
* Creates a new API key for the authenticated user (settings route)
|
|
102
|
+
*/
|
|
103
|
+
export declare const createApiKeySettings: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeySettingsData, ThrowOnError>) => RequestResult<CreateApiKeySettingsResponses, CreateApiKeySettingsErrors, ThrowOnError>;
|
|
104
|
+
/**
|
|
105
|
+
* Delete API key (Settings)
|
|
106
|
+
*
|
|
107
|
+
* Deletes an API key by ID (settings route)
|
|
108
|
+
*/
|
|
109
|
+
export declare const deleteApiKeySettings: <ThrowOnError extends boolean = false>(options: Options<DeleteApiKeySettingsData, ThrowOnError>) => RequestResult<DeleteApiKeySettingsResponses, DeleteApiKeySettingsErrors, ThrowOnError>;
|
|
110
|
+
/**
|
|
111
|
+
* Submit support request
|
|
112
|
+
*
|
|
113
|
+
* Submit a support request from an authenticated user. The request is sent to the VibeXP support team
|
|
114
|
+
* via email. Optionally, an acknowledgement email can be sent to the user.
|
|
115
|
+
*
|
|
116
|
+
*/
|
|
117
|
+
export declare const submitSupportRequest: <ThrowOnError extends boolean = false>(options: Options<SubmitSupportRequestData, ThrowOnError>) => RequestResult<SubmitSupportRequestResponses, SubmitSupportRequestErrors, ThrowOnError>;
|
|
118
|
+
/**
|
|
119
|
+
* List artifacts
|
|
120
|
+
*
|
|
121
|
+
* Retrieves all artifacts for the specified team with optional filtering
|
|
122
|
+
*/
|
|
123
|
+
export declare const listArtifacts: <ThrowOnError extends boolean = false>(options: Options<ListArtifactsData, ThrowOnError>) => RequestResult<ListArtifactsResponses, ListArtifactsErrors, ThrowOnError>;
|
|
124
|
+
/**
|
|
125
|
+
* Create new artifact
|
|
126
|
+
*
|
|
127
|
+
* Creates a new artifact for the authenticated user within the specified team
|
|
128
|
+
*/
|
|
129
|
+
export declare const createArtifact: <ThrowOnError extends boolean = false>(options: Options<CreateArtifactData, ThrowOnError>) => RequestResult<CreateArtifactResponses, CreateArtifactErrors, ThrowOnError>;
|
|
130
|
+
/**
|
|
131
|
+
* Get artifact statistics
|
|
132
|
+
*
|
|
133
|
+
* Returns statistics about artifacts for the specified team
|
|
134
|
+
*/
|
|
135
|
+
export declare const getArtifactStats: <ThrowOnError extends boolean = false>(options: Options<GetArtifactStatsData, ThrowOnError>) => RequestResult<GetArtifactStatsResponses, GetArtifactStatsErrors, ThrowOnError>;
|
|
136
|
+
/**
|
|
137
|
+
* List artifacts by project
|
|
138
|
+
*
|
|
139
|
+
* Retrieves artifacts for a specific project within the specified team
|
|
140
|
+
*/
|
|
141
|
+
export declare const listArtifactsByProject: <ThrowOnError extends boolean = false>(options: Options<ListArtifactsByProjectData, ThrowOnError>) => RequestResult<ListArtifactsByProjectResponses, ListArtifactsByProjectErrors, ThrowOnError>;
|
|
142
|
+
/**
|
|
143
|
+
* Delete artifact by project and slug
|
|
144
|
+
*
|
|
145
|
+
* Deletes a specific artifact by project ID and slug within the specified team
|
|
146
|
+
*/
|
|
147
|
+
export declare const deleteArtifact: <ThrowOnError extends boolean = false>(options: Options<DeleteArtifactData, ThrowOnError>) => RequestResult<DeleteArtifactResponses, DeleteArtifactErrors, ThrowOnError>;
|
|
148
|
+
/**
|
|
149
|
+
* Get artifact by project and slug
|
|
150
|
+
*
|
|
151
|
+
* Retrieves a specific artifact by project ID and slug within the specified team
|
|
152
|
+
*/
|
|
153
|
+
export declare const getArtifact: <ThrowOnError extends boolean = false>(options: Options<GetArtifactData, ThrowOnError>) => RequestResult<GetArtifactResponses, GetArtifactErrors, ThrowOnError>;
|
|
154
|
+
/**
|
|
155
|
+
* Update artifact by project and slug
|
|
156
|
+
*
|
|
157
|
+
* Updates a specific artifact by project ID and slug within the specified team
|
|
158
|
+
*/
|
|
159
|
+
export declare const updateArtifact: <ThrowOnError extends boolean = false>(options: Options<UpdateArtifactData, ThrowOnError>) => RequestResult<UpdateArtifactResponses, UpdateArtifactErrors, ThrowOnError>;
|
|
160
|
+
/**
|
|
161
|
+
* List attachments for an owner
|
|
162
|
+
*
|
|
163
|
+
* Returns all attachments for the resource identified by the `owner_type` and `owner_id` query parameters, newest first, plus their combined size.
|
|
164
|
+
*
|
|
165
|
+
*/
|
|
166
|
+
export declare const listAttachments: <ThrowOnError extends boolean = false>(options: Options<ListAttachmentsData, ThrowOnError>) => RequestResult<ListAttachmentsResponses, ListAttachmentsErrors, ThrowOnError>;
|
|
167
|
+
/**
|
|
168
|
+
* Upload an attachment
|
|
169
|
+
*
|
|
170
|
+
* Uploads a single file (multipart field `file`) as an attachment on the resource identified by `owner_type` + `owner_id`. The owner_type must have a registered authorizer (currently `artifact`, `prompt`, `blueprint`); an unsupported owner_type returns 404. Enforces a 5 MB per-file limit, a 10 MB cumulative limit per owner, and a safe file-type allowlist.
|
|
171
|
+
*
|
|
172
|
+
*/
|
|
173
|
+
export declare const uploadAttachment: <ThrowOnError extends boolean = false>(options: Options<UploadAttachmentData, ThrowOnError>) => RequestResult<UploadAttachmentResponses, UploadAttachmentErrors, ThrowOnError>;
|
|
174
|
+
/**
|
|
175
|
+
* Delete an attachment
|
|
176
|
+
*
|
|
177
|
+
* Deletes the attachment metadata row and the stored object. The attachment id is sufficient; its owner is read from the stored row and authorized via the owner authorizer registry.
|
|
178
|
+
*
|
|
179
|
+
*/
|
|
180
|
+
export declare const deleteAttachment: <ThrowOnError extends boolean = false>(options: Options<DeleteAttachmentData, ThrowOnError>) => RequestResult<DeleteAttachmentResponses, DeleteAttachmentErrors, ThrowOnError>;
|
|
181
|
+
/**
|
|
182
|
+
* Download an attachment
|
|
183
|
+
*
|
|
184
|
+
* Streams the attachment file as a download (Content-Disposition: attachment). The attachment id is sufficient; its owner is read from the stored row and authorized via the owner authorizer registry.
|
|
185
|
+
*
|
|
186
|
+
*/
|
|
187
|
+
export declare const downloadAttachment: <ThrowOnError extends boolean = false>(options: Options<DownloadAttachmentData, ThrowOnError>) => RequestResult<DownloadAttachmentResponses, DownloadAttachmentErrors, ThrowOnError>;
|
|
188
|
+
/**
|
|
189
|
+
* List attachments for an artifact
|
|
190
|
+
*
|
|
191
|
+
* Returns all attachments on the artifact, newest first, plus their combined size.
|
|
192
|
+
*
|
|
193
|
+
* @deprecated
|
|
194
|
+
*/
|
|
195
|
+
export declare const listArtifactAttachments: <ThrowOnError extends boolean = false>(options: Options<ListArtifactAttachmentsData, ThrowOnError>) => RequestResult<ListArtifactAttachmentsResponses, ListArtifactAttachmentsErrors, ThrowOnError>;
|
|
196
|
+
/**
|
|
197
|
+
* Upload an attachment to an artifact
|
|
198
|
+
*
|
|
199
|
+
* Uploads a single file (multipart field `file`) as an attachment on the artifact. Enforces a 5 MB per-file limit, a 10 MB cumulative limit per artifact, and a safe file-type allowlist.
|
|
200
|
+
*
|
|
201
|
+
*
|
|
202
|
+
* @deprecated
|
|
203
|
+
*/
|
|
204
|
+
export declare const uploadArtifactAttachment: <ThrowOnError extends boolean = false>(options: Options<UploadArtifactAttachmentData, ThrowOnError>) => RequestResult<UploadArtifactAttachmentResponses, UploadArtifactAttachmentErrors, ThrowOnError>;
|
|
205
|
+
/**
|
|
206
|
+
* Delete an artifact attachment
|
|
207
|
+
*
|
|
208
|
+
* Deletes the attachment metadata row and the stored object.
|
|
209
|
+
*
|
|
210
|
+
* @deprecated
|
|
211
|
+
*/
|
|
212
|
+
export declare const deleteArtifactAttachment: <ThrowOnError extends boolean = false>(options: Options<DeleteArtifactAttachmentData, ThrowOnError>) => RequestResult<DeleteArtifactAttachmentResponses, DeleteArtifactAttachmentErrors, ThrowOnError>;
|
|
213
|
+
/**
|
|
214
|
+
* Download an artifact attachment
|
|
215
|
+
*
|
|
216
|
+
* Streams the attachment file as a download (Content-Disposition attachment).
|
|
217
|
+
*
|
|
218
|
+
* @deprecated
|
|
219
|
+
*/
|
|
220
|
+
export declare const downloadArtifactAttachment: <ThrowOnError extends boolean = false>(options: Options<DownloadArtifactAttachmentData, ThrowOnError>) => RequestResult<DownloadArtifactAttachmentResponses, DownloadArtifactAttachmentErrors, ThrowOnError>;
|
|
221
|
+
/**
|
|
222
|
+
* List artifact content versions
|
|
223
|
+
*
|
|
224
|
+
* Returns the content-version history (newest first) for an artifact
|
|
225
|
+
*/
|
|
226
|
+
export declare const listArtifactVersions: <ThrowOnError extends boolean = false>(options: Options<ListArtifactVersionsData, ThrowOnError>) => RequestResult<ListArtifactVersionsResponses, ListArtifactVersionsErrors, ThrowOnError>;
|
|
227
|
+
/**
|
|
228
|
+
* Get a specific artifact content version
|
|
229
|
+
*
|
|
230
|
+
* Returns a single content-version snapshot of an artifact by version number
|
|
231
|
+
*/
|
|
232
|
+
export declare const getArtifactVersion: <ThrowOnError extends boolean = false>(options: Options<GetArtifactVersionData, ThrowOnError>) => RequestResult<GetArtifactVersionResponses, GetArtifactVersionErrors, ThrowOnError>;
|
|
233
|
+
/**
|
|
234
|
+
* Restore an artifact to a content version
|
|
235
|
+
*
|
|
236
|
+
* Restores the artifact's content to the given version. The pre-restore content is snapshotted as a new version. Returns the updated artifact.
|
|
237
|
+
*/
|
|
238
|
+
export declare const restoreArtifactVersion: <ThrowOnError extends boolean = false>(options: Options<RestoreArtifactVersionData, ThrowOnError>) => RequestResult<RestoreArtifactVersionResponses, RestoreArtifactVersionErrors, ThrowOnError>;
|
|
239
|
+
/**
|
|
240
|
+
* Semantic search across team resources
|
|
241
|
+
*
|
|
242
|
+
* Performs a pgvector cosine-similarity semantic search over the team's prompts, artifacts, blueprints and memories, returning relevance-ranked chunk excerpts for RAG retrieval. One result is returned per matching embedding chunk.
|
|
243
|
+
*/
|
|
244
|
+
export declare const searchTeamResources: <ThrowOnError extends boolean = false>(options: Options<SearchTeamResourcesData, ThrowOnError>) => RequestResult<SearchTeamResourcesResponses, SearchTeamResourcesErrors, ThrowOnError>;
|
|
245
|
+
/**
|
|
246
|
+
* Per-resource daily access metrics
|
|
247
|
+
*
|
|
248
|
+
* Returns a zero-filled daily access timeseries for a single resource, grouped by source (web, cli, mcp, api), for the resource detail-page chart. Every day in the requested range appears even when its count is zero. Free-tier accessible to team members.
|
|
249
|
+
*/
|
|
250
|
+
export declare const getResourceAccessMetrics: <ThrowOnError extends boolean = false>(options: Options<GetResourceAccessMetricsData, ThrowOnError>) => RequestResult<GetResourceAccessMetricsResponses, GetResourceAccessMetricsErrors, ThrowOnError>;
|
|
251
|
+
/**
|
|
252
|
+
* List memories
|
|
253
|
+
*
|
|
254
|
+
* Retrieves all memories for the authenticated user within the specified team with optional filtering
|
|
255
|
+
*/
|
|
256
|
+
export declare const listMemories: <ThrowOnError extends boolean = false>(options: Options<ListMemoriesData, ThrowOnError>) => RequestResult<ListMemoriesResponses, ListMemoriesErrors, ThrowOnError>;
|
|
257
|
+
/**
|
|
258
|
+
* Create new memory
|
|
259
|
+
*
|
|
260
|
+
* Creates a new memory for the authenticated user within the specified team
|
|
261
|
+
*/
|
|
262
|
+
export declare const createMemory: <ThrowOnError extends boolean = false>(options: Options<CreateMemoryData, ThrowOnError>) => RequestResult<CreateMemoryResponses, CreateMemoryErrors, ThrowOnError>;
|
|
263
|
+
/**
|
|
264
|
+
* Search memories by metadata
|
|
265
|
+
*
|
|
266
|
+
* Searches memories by specific metadata key-value pairs within the specified team
|
|
267
|
+
*/
|
|
268
|
+
export declare const searchMemoriesByMetadata: <ThrowOnError extends boolean = false>(options: Options<SearchMemoriesByMetadataData, ThrowOnError>) => RequestResult<SearchMemoriesByMetadataResponses, SearchMemoriesByMetadataErrors, ThrowOnError>;
|
|
269
|
+
/**
|
|
270
|
+
* Delete memory by ID
|
|
271
|
+
*
|
|
272
|
+
* Deletes a specific memory by its ID within the specified team
|
|
273
|
+
*/
|
|
274
|
+
export declare const deleteMemory: <ThrowOnError extends boolean = false>(options: Options<DeleteMemoryData, ThrowOnError>) => RequestResult<DeleteMemoryResponses, DeleteMemoryErrors, ThrowOnError>;
|
|
275
|
+
/**
|
|
276
|
+
* Get memory by ID
|
|
277
|
+
*
|
|
278
|
+
* Retrieves a specific memory by its ID within the specified team
|
|
279
|
+
*/
|
|
280
|
+
export declare const getMemory: <ThrowOnError extends boolean = false>(options: Options<GetMemoryData, ThrowOnError>) => RequestResult<GetMemoryResponses, GetMemoryErrors, ThrowOnError>;
|
|
281
|
+
/**
|
|
282
|
+
* Update memory by ID
|
|
283
|
+
*
|
|
284
|
+
* Updates a specific memory by its ID within the specified team
|
|
285
|
+
*/
|
|
286
|
+
export declare const updateMemory: <ThrowOnError extends boolean = false>(options: Options<UpdateMemoryData, ThrowOnError>) => RequestResult<UpdateMemoryResponses, UpdateMemoryErrors, ThrowOnError>;
|
|
287
|
+
/**
|
|
288
|
+
* List memory content versions
|
|
289
|
+
*
|
|
290
|
+
* Returns the content-version history (newest first) for a memory
|
|
291
|
+
*/
|
|
292
|
+
export declare const listMemoryVersions: <ThrowOnError extends boolean = false>(options: Options<ListMemoryVersionsData, ThrowOnError>) => RequestResult<ListMemoryVersionsResponses, ListMemoryVersionsErrors, ThrowOnError>;
|
|
293
|
+
/**
|
|
294
|
+
* Get a specific memory content version
|
|
295
|
+
*
|
|
296
|
+
* Returns a single content-version snapshot of a memory by version number
|
|
297
|
+
*/
|
|
298
|
+
export declare const getMemoryVersion: <ThrowOnError extends boolean = false>(options: Options<GetMemoryVersionData, ThrowOnError>) => RequestResult<GetMemoryVersionResponses, GetMemoryVersionErrors, ThrowOnError>;
|
|
299
|
+
/**
|
|
300
|
+
* Restore a memory to a content version
|
|
301
|
+
*
|
|
302
|
+
* Restores the memory's text to the given version. The pre-restore text is snapshotted as a new version. Returns the updated memory.
|
|
303
|
+
*/
|
|
304
|
+
export declare const restoreMemoryVersion: <ThrowOnError extends boolean = false>(options: Options<RestoreMemoryVersionData, ThrowOnError>) => RequestResult<RestoreMemoryVersionResponses, RestoreMemoryVersionErrors, ThrowOnError>;
|
|
305
|
+
/**
|
|
306
|
+
* Get project statistics
|
|
307
|
+
*
|
|
308
|
+
* Returns resource counts for a specific project within the specified team.
|
|
309
|
+
*/
|
|
310
|
+
export declare const getProjectStats: <ThrowOnError extends boolean = false>(options: Options<GetProjectStatsData, ThrowOnError>) => RequestResult<GetProjectStatsResponses, GetProjectStatsErrors, ThrowOnError>;
|
|
311
|
+
/**
|
|
312
|
+
* Per-project daily resource-creation metrics
|
|
313
|
+
*
|
|
314
|
+
* Returns a zero-filled daily creation timeseries for a single project, counting prompts, artifacts, blueprints, and memories created on each day, for the project detail-page chart. Every day in the requested range appears even when its count is zero. Authorized via team ownership/membership (same boundary as the project stats endpoint).
|
|
315
|
+
*/
|
|
316
|
+
export declare const getProjectResourceCreationMetrics: <ThrowOnError extends boolean = false>(options: Options<GetProjectResourceCreationMetricsData, ThrowOnError>) => RequestResult<GetProjectResourceCreationMetricsResponses, GetProjectResourceCreationMetricsErrors, ThrowOnError>;
|
|
317
|
+
/**
|
|
318
|
+
* List spec libraries
|
|
319
|
+
*
|
|
320
|
+
* Retrieves all spec libraries for the authenticated user with optional filtering and pagination
|
|
321
|
+
*/
|
|
322
|
+
export declare const listSpecLibraries: <ThrowOnError extends boolean = false>(options: Options<ListSpecLibrariesData, ThrowOnError>) => RequestResult<ListSpecLibrariesResponses, ListSpecLibrariesErrors, ThrowOnError>;
|
|
323
|
+
/**
|
|
324
|
+
* Create new spec library
|
|
325
|
+
*
|
|
326
|
+
* Creates a new spec library for the authenticated user. Spec libraries are used to store API specifications (OpenAPI, AsyncAPI, etc.) and other technical documentation.
|
|
327
|
+
*/
|
|
328
|
+
export declare const createBlueprint: <ThrowOnError extends boolean = false>(options: Options<CreateBlueprintData, ThrowOnError>) => RequestResult<CreateBlueprintResponses, CreateBlueprintErrors, ThrowOnError>;
|
|
329
|
+
/**
|
|
330
|
+
* Get spec library statistics
|
|
331
|
+
*
|
|
332
|
+
* Returns statistics about user's spec libraries including counts by type, status, and recent additions
|
|
333
|
+
*/
|
|
334
|
+
export declare const getBlueprintStats: <ThrowOnError extends boolean = false>(options: Options<GetBlueprintStatsData, ThrowOnError>) => RequestResult<GetBlueprintStatsResponses, GetBlueprintStatsErrors, ThrowOnError>;
|
|
335
|
+
/**
|
|
336
|
+
* List spec libraries by project
|
|
337
|
+
*
|
|
338
|
+
* Retrieves spec libraries for a specific project with optional filtering
|
|
339
|
+
*/
|
|
340
|
+
export declare const listSpecLibrariesByProject: <ThrowOnError extends boolean = false>(options: Options<ListSpecLibrariesByProjectData, ThrowOnError>) => RequestResult<ListSpecLibrariesByProjectResponses, ListSpecLibrariesByProjectErrors, ThrowOnError>;
|
|
341
|
+
/**
|
|
342
|
+
* Delete spec library by project and slug
|
|
343
|
+
*
|
|
344
|
+
* Deletes a specific spec library by project name and slug. This also deletes associated embeddings.
|
|
345
|
+
*/
|
|
346
|
+
export declare const deleteBlueprint: <ThrowOnError extends boolean = false>(options: Options<DeleteBlueprintData, ThrowOnError>) => RequestResult<DeleteBlueprintResponses, DeleteBlueprintErrors, ThrowOnError>;
|
|
347
|
+
/**
|
|
348
|
+
* Get spec library by project and slug
|
|
349
|
+
*
|
|
350
|
+
* Retrieves a specific spec library by project name and slug
|
|
351
|
+
*/
|
|
352
|
+
export declare const getBlueprint: <ThrowOnError extends boolean = false>(options: Options<GetBlueprintData, ThrowOnError>) => RequestResult<GetBlueprintResponses, GetBlueprintErrors, ThrowOnError>;
|
|
353
|
+
/**
|
|
354
|
+
* Update spec library by project and slug
|
|
355
|
+
*
|
|
356
|
+
* Updates a specific spec library by project name and slug. All fields in the request body are optional - only provided fields will be updated.
|
|
357
|
+
*/
|
|
358
|
+
export declare const updateBlueprint: <ThrowOnError extends boolean = false>(options: Options<UpdateBlueprintData, ThrowOnError>) => RequestResult<UpdateBlueprintResponses, UpdateBlueprintErrors, ThrowOnError>;
|
|
359
|
+
/**
|
|
360
|
+
* List blueprint content versions
|
|
361
|
+
*
|
|
362
|
+
* Returns the content-version history (newest first) for a blueprint
|
|
363
|
+
*/
|
|
364
|
+
export declare const listBlueprintVersions: <ThrowOnError extends boolean = false>(options: Options<ListBlueprintVersionsData, ThrowOnError>) => RequestResult<ListBlueprintVersionsResponses, ListBlueprintVersionsErrors, ThrowOnError>;
|
|
365
|
+
/**
|
|
366
|
+
* Get a specific blueprint content version
|
|
367
|
+
*
|
|
368
|
+
* Returns a single content-version snapshot of a blueprint by version number
|
|
369
|
+
*/
|
|
370
|
+
export declare const getBlueprintVersion: <ThrowOnError extends boolean = false>(options: Options<GetBlueprintVersionData, ThrowOnError>) => RequestResult<GetBlueprintVersionResponses, GetBlueprintVersionErrors, ThrowOnError>;
|
|
371
|
+
/**
|
|
372
|
+
* Restore a blueprint to a content version
|
|
373
|
+
*
|
|
374
|
+
* Restores the blueprint's content to the given version. The pre-restore content is snapshotted as a new version. Returns the updated blueprint.
|
|
375
|
+
*/
|
|
376
|
+
export declare const restoreBlueprintVersion: <ThrowOnError extends boolean = false>(options: Options<RestoreBlueprintVersionData, ThrowOnError>) => RequestResult<RestoreBlueprintVersionResponses, RestoreBlueprintVersionErrors, ThrowOnError>;
|
|
377
|
+
/**
|
|
378
|
+
* Delete Claude Code session
|
|
379
|
+
*
|
|
380
|
+
* Deletes a specific Claude Code session and all associated hook data
|
|
381
|
+
*/
|
|
382
|
+
export declare const deleteClaudeCodeSession: <ThrowOnError extends boolean = false>(options: Options<DeleteClaudeCodeSessionData, ThrowOnError>) => RequestResult<DeleteClaudeCodeSessionResponses, DeleteClaudeCodeSessionErrors, ThrowOnError>;
|
|
383
|
+
/**
|
|
384
|
+
* Delete Cursor IDE session
|
|
385
|
+
*
|
|
386
|
+
* Deletes a specific Cursor IDE session and all associated hook data
|
|
387
|
+
*/
|
|
388
|
+
export declare const deleteCursorIdeSession: <ThrowOnError extends boolean = false>(options: Options<DeleteCursorIdeSessionData, ThrowOnError>) => RequestResult<DeleteCursorIdeSessionResponses, DeleteCursorIdeSessionErrors, ThrowOnError>;
|
|
389
|
+
/**
|
|
390
|
+
* Get resource usage statistics
|
|
391
|
+
*
|
|
392
|
+
* Returns resource usage information for the authenticated user
|
|
393
|
+
*/
|
|
394
|
+
export declare const getResourceUsage: <ThrowOnError extends boolean = false>(options?: Options<GetResourceUsageData, ThrowOnError>) => RequestResult<GetResourceUsageResponses, GetResourceUsageErrors, ThrowOnError>;
|
|
395
|
+
/**
|
|
396
|
+
* List prompts
|
|
397
|
+
*
|
|
398
|
+
* Retrieves a paginated list of prompts for the specified team with optional filtering.
|
|
399
|
+
*
|
|
400
|
+
*/
|
|
401
|
+
export declare const listPrompts: <ThrowOnError extends boolean = false>(options: Options<ListPromptsData, ThrowOnError>) => RequestResult<ListPromptsResponses, ListPromptsErrors, ThrowOnError>;
|
|
402
|
+
/**
|
|
403
|
+
* Create a new prompt
|
|
404
|
+
*
|
|
405
|
+
* Creates a new prompt template for the specified team. The prompt can be used to store
|
|
406
|
+
* reusable AI instructions with placeholders and references.
|
|
407
|
+
*
|
|
408
|
+
*/
|
|
409
|
+
export declare const createPrompt: <ThrowOnError extends boolean = false>(options: Options<CreatePromptData, ThrowOnError>) => RequestResult<CreatePromptResponses, CreatePromptErrors, ThrowOnError>;
|
|
410
|
+
/**
|
|
411
|
+
* Get prompt labels
|
|
412
|
+
*
|
|
413
|
+
* Retrieves all unique labels used across prompts for the specified team.
|
|
414
|
+
*
|
|
415
|
+
*/
|
|
416
|
+
export declare const getPromptLabels: <ThrowOnError extends boolean = false>(options: Options<GetPromptLabelsData, ThrowOnError>) => RequestResult<GetPromptLabelsResponses, GetPromptLabelsErrors, ThrowOnError>;
|
|
417
|
+
/**
|
|
418
|
+
* Delete a prompt
|
|
419
|
+
*
|
|
420
|
+
* Deletes a prompt and its associated embeddings for the specified team.
|
|
421
|
+
*
|
|
422
|
+
*/
|
|
423
|
+
export declare const deletePrompt: <ThrowOnError extends boolean = false>(options: Options<DeletePromptData, ThrowOnError>) => RequestResult<DeletePromptResponses, DeletePromptErrors, ThrowOnError>;
|
|
424
|
+
/**
|
|
425
|
+
* Get a prompt by slug
|
|
426
|
+
*
|
|
427
|
+
* Retrieves a specific prompt by its slug identifier for the specified team.
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
430
|
+
export declare const getPrompt: <ThrowOnError extends boolean = false>(options: Options<GetPromptData, ThrowOnError>) => RequestResult<GetPromptResponses, GetPromptErrors, ThrowOnError>;
|
|
431
|
+
/**
|
|
432
|
+
* Update a prompt
|
|
433
|
+
*
|
|
434
|
+
* Updates an existing prompt for the specified team. All fields are optional.
|
|
435
|
+
*
|
|
436
|
+
*/
|
|
437
|
+
export declare const updatePrompt: <ThrowOnError extends boolean = false>(options: Options<UpdatePromptData, ThrowOnError>) => RequestResult<UpdatePromptResponses, UpdatePromptErrors, ThrowOnError>;
|
|
438
|
+
/**
|
|
439
|
+
* Get prompt placeholders
|
|
440
|
+
*
|
|
441
|
+
* Extracts and returns all placeholders (e.g., {{variable}}) found in the prompt body.
|
|
442
|
+
*
|
|
443
|
+
*/
|
|
444
|
+
export declare const getPromptPlaceholders: <ThrowOnError extends boolean = false>(options: Options<GetPromptPlaceholdersData, ThrowOnError>) => RequestResult<GetPromptPlaceholdersResponses, GetPromptPlaceholdersErrors, ThrowOnError>;
|
|
445
|
+
/**
|
|
446
|
+
* Get prompt dependencies
|
|
447
|
+
*
|
|
448
|
+
* Returns prompts that reference this prompt using @references syntax.
|
|
449
|
+
*
|
|
450
|
+
*/
|
|
451
|
+
export declare const getPromptDependencies: <ThrowOnError extends boolean = false>(options: Options<GetPromptDependenciesData, ThrowOnError>) => RequestResult<GetPromptDependenciesResponses, GetPromptDependenciesErrors, ThrowOnError>;
|
|
452
|
+
/**
|
|
453
|
+
* Render a prompt
|
|
454
|
+
*
|
|
455
|
+
* Renders a prompt by resolving @references and substituting placeholders with provided values.
|
|
456
|
+
*
|
|
457
|
+
*/
|
|
458
|
+
export declare const renderPrompt: <ThrowOnError extends boolean = false>(options: Options<RenderPromptData, ThrowOnError>) => RequestResult<RenderPromptResponses, RenderPromptErrors, ThrowOnError>;
|
|
459
|
+
/**
|
|
460
|
+
* Delete prompt share
|
|
461
|
+
*
|
|
462
|
+
* Removes the share for a prompt, making it no longer accessible via the shared link
|
|
463
|
+
*/
|
|
464
|
+
export declare const deletePromptShare: <ThrowOnError extends boolean = false>(options: Options<DeletePromptShareData, ThrowOnError>) => RequestResult<DeletePromptShareResponses, DeletePromptShareErrors, ThrowOnError>;
|
|
465
|
+
/**
|
|
466
|
+
* Get prompt share details
|
|
467
|
+
*
|
|
468
|
+
* Retrieves the share configuration for a prompt
|
|
469
|
+
*/
|
|
470
|
+
export declare const getPromptShare: <ThrowOnError extends boolean = false>(options: Options<GetPromptShareData, ThrowOnError>) => RequestResult<GetPromptShareResponses, GetPromptShareErrors, ThrowOnError>;
|
|
471
|
+
/**
|
|
472
|
+
* Create or update prompt share
|
|
473
|
+
*
|
|
474
|
+
* Creates or updates a share for a prompt. Supports two share types:
|
|
475
|
+
* - `public`: Anyone with the link can access the prompt
|
|
476
|
+
* - `restricted`: Only specific email addresses can access the prompt
|
|
477
|
+
*
|
|
478
|
+
*/
|
|
479
|
+
export declare const createPromptShare: <ThrowOnError extends boolean = false>(options: Options<CreatePromptShareData, ThrowOnError>) => RequestResult<CreatePromptShareResponses, CreatePromptShareErrors, ThrowOnError>;
|
|
480
|
+
/**
|
|
481
|
+
* List prompt content versions
|
|
482
|
+
*
|
|
483
|
+
* Returns the content-version history (newest first) for a prompt. Each snapshot holds the raw prompt Body template (placeholders and @slug references), not any rendered output.
|
|
484
|
+
*/
|
|
485
|
+
export declare const listPromptVersions: <ThrowOnError extends boolean = false>(options: Options<ListPromptVersionsData, ThrowOnError>) => RequestResult<ListPromptVersionsResponses, ListPromptVersionsErrors, ThrowOnError>;
|
|
486
|
+
/**
|
|
487
|
+
* Get a specific prompt content version
|
|
488
|
+
*
|
|
489
|
+
* Returns a single content-version snapshot of a prompt by version number
|
|
490
|
+
*/
|
|
491
|
+
export declare const getPromptVersion: <ThrowOnError extends boolean = false>(options: Options<GetPromptVersionData, ThrowOnError>) => RequestResult<GetPromptVersionResponses, GetPromptVersionErrors, ThrowOnError>;
|
|
492
|
+
/**
|
|
493
|
+
* Restore a prompt to a content version
|
|
494
|
+
*
|
|
495
|
+
* Restores the prompt's raw Body template to the given version. The pre-restore body is snapshotted as a new version, so restore is non-destructive and preserves placeholders and @slug references. Returns the updated prompt.
|
|
496
|
+
*/
|
|
497
|
+
export declare const restorePromptVersion: <ThrowOnError extends boolean = false>(options: Options<RestorePromptVersionData, ThrowOnError>) => RequestResult<RestorePromptVersionResponses, RestorePromptVersionErrors, ThrowOnError>;
|
|
498
|
+
/**
|
|
499
|
+
* Get prompt gallery categories
|
|
500
|
+
*
|
|
501
|
+
* Retrieves all prompt categories with counts
|
|
502
|
+
*/
|
|
503
|
+
export declare const getPromptGalleryCategories: <ThrowOnError extends boolean = false>(options?: Options<GetPromptGalleryCategoriesData, ThrowOnError>) => RequestResult<GetPromptGalleryCategoriesResponses, GetPromptGalleryCategoriesErrors, ThrowOnError>;
|
|
504
|
+
/**
|
|
505
|
+
* List prompt gallery prompts
|
|
506
|
+
*
|
|
507
|
+
* Retrieves prompts from the gallery with optional filtering
|
|
508
|
+
*/
|
|
509
|
+
export declare const listPromptGalleryPrompts: <ThrowOnError extends boolean = false>(options?: Options<ListPromptGalleryPromptsData, ThrowOnError>) => RequestResult<ListPromptGalleryPromptsResponses, ListPromptGalleryPromptsErrors, ThrowOnError>;
|
|
510
|
+
/**
|
|
511
|
+
* Get prompt gallery prompt by ID
|
|
512
|
+
*
|
|
513
|
+
* Retrieves a specific prompt from the gallery
|
|
514
|
+
*/
|
|
515
|
+
export declare const getPromptGalleryPrompt: <ThrowOnError extends boolean = false>(options: Options<GetPromptGalleryPromptData, ThrowOnError>) => RequestResult<GetPromptGalleryPromptResponses, GetPromptGalleryPromptErrors, ThrowOnError>;
|
|
516
|
+
/**
|
|
517
|
+
* Track prompt gallery usage
|
|
518
|
+
*
|
|
519
|
+
* Tracks when a user uses a prompt from the gallery
|
|
520
|
+
*/
|
|
521
|
+
export declare const trackPromptGalleryUsage: <ThrowOnError extends boolean = false>(options: Options<TrackPromptGalleryUsageData, ThrowOnError>) => RequestResult<TrackPromptGalleryUsageResponses, TrackPromptGalleryUsageErrors, ThrowOnError>;
|
|
522
|
+
/**
|
|
523
|
+
* Access shared prompt
|
|
524
|
+
*
|
|
525
|
+
* Public endpoint to access a shared prompt via its share token.
|
|
526
|
+
* - For `public` shares: No authentication required
|
|
527
|
+
* - For `restricted` shares: JWT authentication required and email must be in the access list
|
|
528
|
+
*
|
|
529
|
+
* Returns the prompt with @references resolved but {{placeholders}} preserved for client-side substitution.
|
|
530
|
+
*
|
|
531
|
+
*/
|
|
532
|
+
export declare const getSharedPrompt: <ThrowOnError extends boolean = false>(options: Options<GetSharedPromptData, ThrowOnError>) => RequestResult<GetSharedPromptResponses, GetSharedPromptErrors, ThrowOnError>;
|
|
533
|
+
/**
|
|
534
|
+
* Get usage and growth data
|
|
535
|
+
*
|
|
536
|
+
* Retrieves platform-wide usage metrics and per-user activity data.
|
|
537
|
+
* This endpoint is for administrative purposes only and requires the back office admin API key.
|
|
538
|
+
* It is NOT accessible via JWT tokens or regular API keys.
|
|
539
|
+
*
|
|
540
|
+
*/
|
|
541
|
+
export declare const getUsageAndGrowth: <ThrowOnError extends boolean = false>(options?: Options<GetUsageAndGrowthData, ThrowOnError>) => RequestResult<GetUsageAndGrowthResponses, GetUsageAndGrowthErrors, ThrowOnError>;
|
|
542
|
+
/**
|
|
543
|
+
* Regenerate embeddings
|
|
544
|
+
*
|
|
545
|
+
* Republishes the `.created` event for embeddable entities (prompts,
|
|
546
|
+
* artifacts, memories, blueprints, and feed items) so the embedding pipeline
|
|
547
|
+
* regenerates vectors under the currently configured embedding model. This is
|
|
548
|
+
* the operational step after an embedding model or dimension change. The
|
|
549
|
+
* operation is idempotent (the pipeline uses delete-then-insert per entity).
|
|
550
|
+
*
|
|
551
|
+
* The scope is explicit: the request body must set exactly one of `all` or a
|
|
552
|
+
* non-empty `entity_types`. Set `missing_only` to limit the run to entities
|
|
553
|
+
* that lack an embedding for the configured model. This endpoint is for
|
|
554
|
+
* administrative purposes only and requires the back office admin API key.
|
|
555
|
+
*
|
|
556
|
+
*/
|
|
557
|
+
export declare const backfillEmbeddings: <ThrowOnError extends boolean = false>(options: Options<BackfillEmbeddingsData, ThrowOnError>) => RequestResult<BackfillEmbeddingsResponses, BackfillEmbeddingsErrors, ThrowOnError>;
|
|
558
|
+
/**
|
|
559
|
+
* Get GitHub App installation status
|
|
560
|
+
*
|
|
561
|
+
* Returns the GitHub App installation status for the specified team. Requires an active subscription.
|
|
562
|
+
*/
|
|
563
|
+
export declare const getGitHubStatus: <ThrowOnError extends boolean = false>(options: Options<GetGitHubStatusData, ThrowOnError>) => RequestResult<GetGitHubStatusResponses, GetGitHubStatusErrors, ThrowOnError>;
|
|
564
|
+
/**
|
|
565
|
+
* Get GitHub App installation URL
|
|
566
|
+
*
|
|
567
|
+
* Returns a signed GitHub App installation URL with CSRF protection. Requires an active subscription.
|
|
568
|
+
*/
|
|
569
|
+
export declare const getGitHubInstallUrl: <ThrowOnError extends boolean = false>(options: Options<GetGitHubInstallUrlData, ThrowOnError>) => RequestResult<GetGitHubInstallUrlResponses, GetGitHubInstallUrlErrors, ThrowOnError>;
|
|
570
|
+
/**
|
|
571
|
+
* Handle GitHub App installation callback
|
|
572
|
+
*
|
|
573
|
+
* Completes the GitHub App installation flow after the user authorizes the app on GitHub.
|
|
574
|
+
* The request must include the `installation_id` returned by GitHub and the signed `state`
|
|
575
|
+
* parameter from the install URL to prevent CSRF attacks. Requires an active subscription.
|
|
576
|
+
*
|
|
577
|
+
*/
|
|
578
|
+
export declare const handleGitHubCallback: <ThrowOnError extends boolean = false>(options: Options<HandleGitHubCallbackData, ThrowOnError>) => RequestResult<HandleGitHubCallbackResponses, HandleGitHubCallbackErrors, ThrowOnError>;
|
|
579
|
+
/**
|
|
580
|
+
* List GitHub repositories
|
|
581
|
+
*
|
|
582
|
+
* Lists GitHub repositories accessible by the team's GitHub App installation with pagination. Requires an active subscription.
|
|
583
|
+
*/
|
|
584
|
+
export declare const listGitHubRepositories: <ThrowOnError extends boolean = false>(options: Options<ListGitHubRepositoriesData, ThrowOnError>) => RequestResult<ListGitHubRepositoriesResponses, ListGitHubRepositoriesErrors, ThrowOnError>;
|
|
585
|
+
/**
|
|
586
|
+
* Import GitHub repository as a project
|
|
587
|
+
*
|
|
588
|
+
* Imports a GitHub repository as a VibeXP project for the team. If a project already exists
|
|
589
|
+
* for the repository URL it returns the existing project (idempotent). Requires an active subscription.
|
|
590
|
+
*
|
|
591
|
+
*/
|
|
592
|
+
export declare const importGitHubProject: <ThrowOnError extends boolean = false>(options: Options<ImportGitHubProjectData, ThrowOnError>) => RequestResult<ImportGitHubProjectResponses, ImportGitHubProjectErrors, ThrowOnError>;
|
|
593
|
+
/**
|
|
594
|
+
* Import AI assistant configurations as blueprints
|
|
595
|
+
*
|
|
596
|
+
* Scans the specified GitHub repository for AI assistant configuration files
|
|
597
|
+
* (`.claude/`, `.cursor/`, `.codex/`, `.agents/`, `CLAUDE.md`, `CURSOR.md`, `AGENTS.md`)
|
|
598
|
+
* and imports each markdown file as a blueprint. A project must already exist for the
|
|
599
|
+
* repository — use the import-project endpoint first. Requires an active subscription.
|
|
600
|
+
*
|
|
601
|
+
*/
|
|
602
|
+
export declare const importGitHubBlueprints: <ThrowOnError extends boolean = false>(options: Options<ImportGitHubBlueprintsData, ThrowOnError>) => RequestResult<ImportGitHubBlueprintsResponses, ImportGitHubBlueprintsErrors, ThrowOnError>;
|
|
603
|
+
/**
|
|
604
|
+
* Disconnect GitHub App installation
|
|
605
|
+
*
|
|
606
|
+
* Removes the GitHub App installation link for the team. Requires an active subscription.
|
|
607
|
+
*/
|
|
608
|
+
export declare const disconnectGitHub: <ThrowOnError extends boolean = false>(options: Options<DisconnectGitHubData, ThrowOnError>) => RequestResult<DisconnectGitHubResponses, DisconnectGitHubErrors, ThrowOnError>;
|
|
609
|
+
/**
|
|
610
|
+
* Handle GitHub webhook events
|
|
611
|
+
*
|
|
612
|
+
* Receives and processes GitHub webhook events (e.g., push, installation changes).
|
|
613
|
+
* This endpoint validates the webhook signature using the configured GitHub webhook secret.
|
|
614
|
+
* This is a public endpoint — no authentication header is required; GitHub signs the payload.
|
|
615
|
+
*
|
|
616
|
+
*/
|
|
617
|
+
export declare const handleGitHubWebhook: <ThrowOnError extends boolean = false>(options: Options<HandleGitHubWebhookData, ThrowOnError>) => RequestResult<HandleGitHubWebhookResponses, HandleGitHubWebhookErrors, ThrowOnError>;
|
|
618
|
+
/**
|
|
619
|
+
* List feeds
|
|
620
|
+
*
|
|
621
|
+
* Returns all feeds for the specified team with optional pagination
|
|
622
|
+
*/
|
|
623
|
+
export declare const listFeeds: <ThrowOnError extends boolean = false>(options: Options<ListFeedsData, ThrowOnError>) => RequestResult<ListFeedsResponses, ListFeedsErrors, ThrowOnError>;
|
|
624
|
+
/**
|
|
625
|
+
* Create a new feed
|
|
626
|
+
*
|
|
627
|
+
* Creates a new AI feed channel for the specified team (free-tier accessible)
|
|
628
|
+
*/
|
|
629
|
+
export declare const createFeed: <ThrowOnError extends boolean = false>(options: Options<CreateFeedData, ThrowOnError>) => RequestResult<CreateFeedResponses, CreateFeedErrors, ThrowOnError>;
|
|
630
|
+
/**
|
|
631
|
+
* Delete a feed
|
|
632
|
+
*
|
|
633
|
+
* Permanently deletes a feed and cascades deletion to all its items
|
|
634
|
+
*/
|
|
635
|
+
export declare const deleteFeed: <ThrowOnError extends boolean = false>(options: Options<DeleteFeedData, ThrowOnError>) => RequestResult<DeleteFeedResponses, DeleteFeedErrors, ThrowOnError>;
|
|
636
|
+
/**
|
|
637
|
+
* Get a feed
|
|
638
|
+
*
|
|
639
|
+
* Retrieves a specific feed by ID
|
|
640
|
+
*/
|
|
641
|
+
export declare const getFeed: <ThrowOnError extends boolean = false>(options: Options<GetFeedData, ThrowOnError>) => RequestResult<GetFeedResponses, GetFeedErrors, ThrowOnError>;
|
|
642
|
+
/**
|
|
643
|
+
* Update a feed
|
|
644
|
+
*
|
|
645
|
+
* Updates the name and/or description of an existing feed
|
|
646
|
+
*/
|
|
647
|
+
export declare const updateFeed: <ThrowOnError extends boolean = false>(options: Options<UpdateFeedData, ThrowOnError>) => RequestResult<UpdateFeedResponses, UpdateFeedErrors, ThrowOnError>;
|
|
648
|
+
/**
|
|
649
|
+
* List items in a feed
|
|
650
|
+
*
|
|
651
|
+
* Returns paginated items for a specific feed
|
|
652
|
+
*/
|
|
653
|
+
export declare const listFeedItemsByFeed: <ThrowOnError extends boolean = false>(options: Options<ListFeedItemsByFeedData, ThrowOnError>) => RequestResult<ListFeedItemsByFeedResponses, ListFeedItemsByFeedErrors, ThrowOnError>;
|
|
654
|
+
/**
|
|
655
|
+
* Create a feed item
|
|
656
|
+
*
|
|
657
|
+
* Posts a new AI-generated item to a specific feed
|
|
658
|
+
*/
|
|
659
|
+
export declare const createFeedItem: <ThrowOnError extends boolean = false>(options: Options<CreateFeedItemData, ThrowOnError>) => RequestResult<CreateFeedItemResponses, CreateFeedItemErrors, ThrowOnError>;
|
|
660
|
+
/**
|
|
661
|
+
* List all feed items (cross-feed)
|
|
662
|
+
*
|
|
663
|
+
* Returns paginated feed items across all feeds for the team, with optional filters
|
|
664
|
+
*/
|
|
665
|
+
export declare const listFeedItems: <ThrowOnError extends boolean = false>(options: Options<ListFeedItemsData, ThrowOnError>) => RequestResult<ListFeedItemsResponses, ListFeedItemsErrors, ThrowOnError>;
|
|
666
|
+
/**
|
|
667
|
+
* Delete a feed item
|
|
668
|
+
*
|
|
669
|
+
* Permanently deletes a feed item (hard delete)
|
|
670
|
+
*/
|
|
671
|
+
export declare const deleteFeedItem: <ThrowOnError extends boolean = false>(options: Options<DeleteFeedItemData, ThrowOnError>) => RequestResult<DeleteFeedItemResponses, DeleteFeedItemErrors, ThrowOnError>;
|
|
672
|
+
/**
|
|
673
|
+
* Get a feed item
|
|
674
|
+
*
|
|
675
|
+
* Retrieves a specific feed item by ID (detail page)
|
|
676
|
+
*/
|
|
677
|
+
export declare const getFeedItem: <ThrowOnError extends boolean = false>(options: Options<GetFeedItemData, ThrowOnError>) => RequestResult<GetFeedItemResponses, GetFeedItemErrors, ThrowOnError>;
|
|
678
|
+
/**
|
|
679
|
+
* Archive a feed item
|
|
680
|
+
*
|
|
681
|
+
* Sets archived_at to the current server time for the specified feed item
|
|
682
|
+
*/
|
|
683
|
+
export declare const archiveFeedItem: <ThrowOnError extends boolean = false>(options: Options<ArchiveFeedItemData, ThrowOnError>) => RequestResult<ArchiveFeedItemResponses, ArchiveFeedItemErrors, ThrowOnError>;
|
|
684
|
+
/**
|
|
685
|
+
* Unarchive a feed item
|
|
686
|
+
*
|
|
687
|
+
* Clears archived_at (sets to NULL) for the specified feed item
|
|
688
|
+
*/
|
|
689
|
+
export declare const unarchiveFeedItem: <ThrowOnError extends boolean = false>(options: Options<UnarchiveFeedItemData, ThrowOnError>) => RequestResult<UnarchiveFeedItemResponses, UnarchiveFeedItemErrors, ThrowOnError>;
|
|
690
|
+
/**
|
|
691
|
+
* Get invitation details by token
|
|
692
|
+
*
|
|
693
|
+
* Returns enriched invitation details (team name, inviter info, role, status, expiry)
|
|
694
|
+
* for the email-link landing page so the user can review the invitation before
|
|
695
|
+
* accepting or rejecting it.
|
|
696
|
+
*
|
|
697
|
+
* Returns honest, distinct HTTP statuses for the lifecycle:
|
|
698
|
+
* - `200` — valid pending invitation
|
|
699
|
+
* - `404` — unknown / not found token
|
|
700
|
+
* - `410 Gone` — invitation pending but past `expires_at`
|
|
701
|
+
* - `409 Conflict` — invitation already accepted, rejected, or revoked
|
|
702
|
+
*
|
|
703
|
+
*/
|
|
704
|
+
export declare const getInvitationByToken: <ThrowOnError extends boolean = false>(options: Options<GetInvitationByTokenData, ThrowOnError>) => RequestResult<GetInvitationByTokenResponses, GetInvitationByTokenErrors, ThrowOnError>;
|
|
705
|
+
/**
|
|
706
|
+
* List agents
|
|
707
|
+
*
|
|
708
|
+
* Returns the agents of the specified team with optional filtering, sorting, and pagination
|
|
709
|
+
*/
|
|
710
|
+
export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError>;
|
|
711
|
+
/**
|
|
712
|
+
* Create new agent
|
|
713
|
+
*
|
|
714
|
+
* Registers a new A2A agent for the specified team. The agent card is fetched
|
|
715
|
+
* from `card_url` at creation time; name and description default to the card
|
|
716
|
+
* values when omitted.
|
|
717
|
+
*
|
|
718
|
+
*/
|
|
719
|
+
export declare const createAgent: <ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>) => RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError>;
|
|
720
|
+
/**
|
|
721
|
+
* Preview agent card
|
|
722
|
+
*
|
|
723
|
+
* Fetches and returns an A2A agent card from the given URL without creating an agent
|
|
724
|
+
*/
|
|
725
|
+
export declare const previewAgentCard: <ThrowOnError extends boolean = false>(options: Options<PreviewAgentCardData, ThrowOnError>) => RequestResult<PreviewAgentCardResponses, PreviewAgentCardErrors, ThrowOnError>;
|
|
726
|
+
/**
|
|
727
|
+
* Get agent statistics
|
|
728
|
+
*
|
|
729
|
+
* Returns aggregate agent statistics and recent activity for the specified team
|
|
730
|
+
*/
|
|
731
|
+
export declare const getAgentStats: <ThrowOnError extends boolean = false>(options: Options<GetAgentStatsData, ThrowOnError>) => RequestResult<GetAgentStatsResponses, GetAgentStatsErrors, ThrowOnError>;
|
|
732
|
+
/**
|
|
733
|
+
* Delete agent
|
|
734
|
+
*
|
|
735
|
+
* Permanently deletes an agent
|
|
736
|
+
*/
|
|
737
|
+
export declare const deleteAgent: <ThrowOnError extends boolean = false>(options: Options<DeleteAgentData, ThrowOnError>) => RequestResult<DeleteAgentResponses, DeleteAgentErrors, ThrowOnError>;
|
|
738
|
+
/**
|
|
739
|
+
* Get agent
|
|
740
|
+
*
|
|
741
|
+
* Retrieves a specific agent by ID
|
|
742
|
+
*/
|
|
743
|
+
export declare const getAgent: <ThrowOnError extends boolean = false>(options: Options<GetAgentData, ThrowOnError>) => RequestResult<GetAgentResponses, GetAgentErrors, ThrowOnError>;
|
|
744
|
+
/**
|
|
745
|
+
* Update agent
|
|
746
|
+
*
|
|
747
|
+
* Updates an existing agent. When `card_url` is provided the agent card is
|
|
748
|
+
* re-fetched. Agents cannot be moved between teams once created.
|
|
749
|
+
*
|
|
750
|
+
*/
|
|
751
|
+
export declare const updateAgent: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>) => RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
|
|
752
|
+
/**
|
|
753
|
+
* Update agent credentials
|
|
754
|
+
*
|
|
755
|
+
* Replaces the stored credentials for an agent. Values are encrypted at rest and never returned.
|
|
756
|
+
*/
|
|
757
|
+
export declare const updateAgentCredentials: <ThrowOnError extends boolean = false>(options: Options<UpdateAgentCredentialsData, ThrowOnError>) => RequestResult<UpdateAgentCredentialsResponses, UpdateAgentCredentialsErrors, ThrowOnError>;
|
|
758
|
+
/**
|
|
759
|
+
* Execute agent
|
|
760
|
+
*
|
|
761
|
+
* Invokes an agent via the A2A protocol. For streaming-capable agents the call
|
|
762
|
+
* returns immediately with status `pending` or `submitted`; poll
|
|
763
|
+
* `GET /agents/executions/{id}/status` and fetch
|
|
764
|
+
* `GET /agents/executions/{id}/events` for progress. For non-streaming agents
|
|
765
|
+
* the call blocks until the execution finishes with status `success` or `error`.
|
|
766
|
+
*
|
|
767
|
+
*/
|
|
768
|
+
export declare const executeAgent: <ThrowOnError extends boolean = false>(options: Options<ExecuteAgentData, ThrowOnError>) => RequestResult<ExecuteAgentResponses, ExecuteAgentErrors, ThrowOnError>;
|
|
769
|
+
/**
|
|
770
|
+
* List agent executions
|
|
771
|
+
*
|
|
772
|
+
* Returns executions for an agent with optional filtering and pagination
|
|
773
|
+
*/
|
|
774
|
+
export declare const listAgentExecutions: <ThrowOnError extends boolean = false>(options: Options<ListAgentExecutionsData, ThrowOnError>) => RequestResult<ListAgentExecutionsResponses, ListAgentExecutionsErrors, ThrowOnError>;
|
|
775
|
+
/**
|
|
776
|
+
* Start agent execution
|
|
777
|
+
*
|
|
778
|
+
* Creates a new execution record for an agent (manual execution tracking)
|
|
779
|
+
*/
|
|
780
|
+
export declare const startAgentExecution: <ThrowOnError extends boolean = false>(options: Options<StartAgentExecutionData, ThrowOnError>) => RequestResult<StartAgentExecutionResponses, StartAgentExecutionErrors, ThrowOnError>;
|
|
781
|
+
/**
|
|
782
|
+
* List agent conversations
|
|
783
|
+
*
|
|
784
|
+
* Returns paginated conversation summaries for an agent
|
|
785
|
+
*/
|
|
786
|
+
export declare const listAgentConversations: <ThrowOnError extends boolean = false>(options: Options<ListAgentConversationsData, ThrowOnError>) => RequestResult<ListAgentConversationsResponses, ListAgentConversationsErrors, ThrowOnError>;
|
|
787
|
+
/**
|
|
788
|
+
* Get agent execution
|
|
789
|
+
*
|
|
790
|
+
* Retrieves a specific agent execution by ID
|
|
791
|
+
*/
|
|
792
|
+
export declare const getAgentExecution: <ThrowOnError extends boolean = false>(options: Options<GetAgentExecutionData, ThrowOnError>) => RequestResult<GetAgentExecutionResponses, GetAgentExecutionErrors, ThrowOnError>;
|
|
793
|
+
/**
|
|
794
|
+
* Complete agent execution
|
|
795
|
+
*
|
|
796
|
+
* Updates an execution with its final status, output, and optional error (manual execution tracking)
|
|
797
|
+
*/
|
|
798
|
+
export declare const completeAgentExecution: <ThrowOnError extends boolean = false>(options: Options<CompleteAgentExecutionData, ThrowOnError>) => RequestResult<CompleteAgentExecutionResponses, CompleteAgentExecutionErrors, ThrowOnError>;
|
|
799
|
+
/**
|
|
800
|
+
* Get execution status
|
|
801
|
+
*
|
|
802
|
+
* Returns the current status and A2A state of an agent execution, including
|
|
803
|
+
* artifacts. The execution's agent must belong to the specified team.
|
|
804
|
+
*
|
|
805
|
+
*/
|
|
806
|
+
export declare const getAgentExecutionStatus: <ThrowOnError extends boolean = false>(options: Options<GetAgentExecutionStatusData, ThrowOnError>) => RequestResult<GetAgentExecutionStatusResponses, GetAgentExecutionStatusErrors, ThrowOnError>;
|
|
807
|
+
/**
|
|
808
|
+
* Get execution events
|
|
809
|
+
*
|
|
810
|
+
* Returns streaming events for an execution. Supports two modes: cursor-based
|
|
811
|
+
* polling via `?since={sequence}` (returns execution status plus events after
|
|
812
|
+
* that sequence number) and page-based pagination via `?page`/`?limit` for
|
|
813
|
+
* historical viewing.
|
|
814
|
+
*
|
|
815
|
+
*/
|
|
816
|
+
export declare const getAgentExecutionEvents: <ThrowOnError extends boolean = false>(options: Options<GetAgentExecutionEventsData, ThrowOnError>) => RequestResult<GetAgentExecutionEventsResponses, GetAgentExecutionEventsErrors, ThrowOnError>;
|
|
817
|
+
/**
|
|
818
|
+
* List conversation executions
|
|
819
|
+
*
|
|
820
|
+
* Returns the executions belonging to a conversation with cursor-based pagination (newest first, use `before` to page backwards)
|
|
821
|
+
*/
|
|
822
|
+
export declare const listConversationExecutions: <ThrowOnError extends boolean = false>(options: Options<ListConversationExecutionsData, ThrowOnError>) => RequestResult<ListConversationExecutionsResponses, ListConversationExecutionsErrors, ThrowOnError>;
|
|
823
|
+
/**
|
|
824
|
+
* List Claude Code hook payloads
|
|
825
|
+
*
|
|
826
|
+
* Returns the authenticated user's stored Claude Code hook payloads with pagination and optional filters
|
|
827
|
+
*/
|
|
828
|
+
export declare const listClaudeCodeHooks: <ThrowOnError extends boolean = false>(options?: Options<ListClaudeCodeHooksData, ThrowOnError>) => RequestResult<ListClaudeCodeHooksResponses, ListClaudeCodeHooksErrors, ThrowOnError>;
|
|
829
|
+
/**
|
|
830
|
+
* List Claude Code sessions
|
|
831
|
+
*
|
|
832
|
+
* Returns the authenticated user's Claude Code session summaries with pagination
|
|
833
|
+
*/
|
|
834
|
+
export declare const listClaudeCodeSessions: <ThrowOnError extends boolean = false>(options?: Options<ListClaudeCodeSessionsData, ThrowOnError>) => RequestResult<ListClaudeCodeSessionsResponses, ListClaudeCodeSessionsErrors, ThrowOnError>;
|
|
835
|
+
/**
|
|
836
|
+
* Get Claude Code session counts
|
|
837
|
+
*
|
|
838
|
+
* Returns the authenticated user's Claude Code session counts per day for the requested range
|
|
839
|
+
*/
|
|
840
|
+
export declare const getClaudeCodeSessionCounts: <ThrowOnError extends boolean = false>(options?: Options<GetClaudeCodeSessionCountsData, ThrowOnError>) => RequestResult<GetClaudeCodeSessionCountsResponses, GetClaudeCodeSessionCountsErrors, ThrowOnError>;
|
|
841
|
+
/**
|
|
842
|
+
* Get Claude Code overview statistics
|
|
843
|
+
*
|
|
844
|
+
* Returns aggregated Claude Code usage statistics for the authenticated user's overview dashboard
|
|
845
|
+
*/
|
|
846
|
+
export declare const getClaudeCodeOverviewStats: <ThrowOnError extends boolean = false>(options?: Options<GetClaudeCodeOverviewStatsData, ThrowOnError>) => RequestResult<GetClaudeCodeOverviewStatsResponses, GetClaudeCodeOverviewStatsErrors, ThrowOnError>;
|
|
847
|
+
/**
|
|
848
|
+
* List recent Claude Code activities
|
|
849
|
+
*
|
|
850
|
+
* Returns the authenticated user's recent Claude Code activities with pagination and optional filters
|
|
851
|
+
*/
|
|
852
|
+
export declare const listClaudeCodeRecentActivities: <ThrowOnError extends boolean = false>(options?: Options<ListClaudeCodeRecentActivitiesData, ThrowOnError>) => RequestResult<ListClaudeCodeRecentActivitiesResponses, ListClaudeCodeRecentActivitiesErrors, ThrowOnError>;
|
|
853
|
+
/**
|
|
854
|
+
* List Cursor IDE hook payloads
|
|
855
|
+
*
|
|
856
|
+
* Returns the authenticated user's stored Cursor IDE hook payloads with pagination and optional filters
|
|
857
|
+
*/
|
|
858
|
+
export declare const listCursorIdeHooks: <ThrowOnError extends boolean = false>(options?: Options<ListCursorIdeHooksData, ThrowOnError>) => RequestResult<ListCursorIdeHooksResponses, ListCursorIdeHooksErrors, ThrowOnError>;
|
|
859
|
+
/**
|
|
860
|
+
* List Cursor IDE sessions
|
|
861
|
+
*
|
|
862
|
+
* Returns the authenticated user's Cursor IDE session summaries with pagination
|
|
863
|
+
*/
|
|
864
|
+
export declare const listCursorIdeSessions: <ThrowOnError extends boolean = false>(options?: Options<ListCursorIdeSessionsData, ThrowOnError>) => RequestResult<ListCursorIdeSessionsResponses, ListCursorIdeSessionsErrors, ThrowOnError>;
|
|
865
|
+
/**
|
|
866
|
+
* Get Cursor IDE session counts
|
|
867
|
+
*
|
|
868
|
+
* Returns the authenticated user's Cursor IDE session counts per day for the requested range
|
|
869
|
+
*/
|
|
870
|
+
export declare const getCursorIdeSessionCounts: <ThrowOnError extends boolean = false>(options?: Options<GetCursorIdeSessionCountsData, ThrowOnError>) => RequestResult<GetCursorIdeSessionCountsResponses, GetCursorIdeSessionCountsErrors, ThrowOnError>;
|
|
871
|
+
/**
|
|
872
|
+
* Get Cursor IDE overview statistics
|
|
873
|
+
*
|
|
874
|
+
* Returns aggregated Cursor IDE usage statistics for the authenticated user's overview dashboard
|
|
875
|
+
*/
|
|
876
|
+
export declare const getCursorIdeOverviewStats: <ThrowOnError extends boolean = false>(options?: Options<GetCursorIdeOverviewStatsData, ThrowOnError>) => RequestResult<GetCursorIdeOverviewStatsResponses, GetCursorIdeOverviewStatsErrors, ThrowOnError>;
|
|
877
|
+
/**
|
|
878
|
+
* List recent Cursor IDE activities
|
|
879
|
+
*
|
|
880
|
+
* Returns the authenticated user's recent Cursor IDE activities with pagination and optional filters
|
|
881
|
+
*/
|
|
882
|
+
export declare const listCursorIdeRecentActivities: <ThrowOnError extends boolean = false>(options?: Options<ListCursorIdeRecentActivitiesData, ThrowOnError>) => RequestResult<ListCursorIdeRecentActivitiesResponses, ListCursorIdeRecentActivitiesErrors, ThrowOnError>;
|
|
883
|
+
/**
|
|
884
|
+
* Ingest Claude Code hook payload
|
|
885
|
+
*
|
|
886
|
+
* Stores a hook payload fired by the Claude Code CLI during an active coding session. Authenticated via API key (bearer) or session cookie; not IP-rate-limited. Responses use the legacy CLI-compatible `{status, message}` shape rather than the standard envelope. New sessions are checked against the user's `ai_session` resource limit (and `ai_tool` limit for the first-ever session), returning 403 when exceeded.
|
|
887
|
+
*/
|
|
888
|
+
export declare const ingestClaudeCodeHook: <ThrowOnError extends boolean = false>(options: Options<IngestClaudeCodeHookData, ThrowOnError>) => RequestResult<IngestClaudeCodeHookResponses, IngestClaudeCodeHookErrors, ThrowOnError>;
|
|
889
|
+
/**
|
|
890
|
+
* Ingest Cursor IDE hook payload
|
|
891
|
+
*
|
|
892
|
+
* Stores a hook payload fired by Cursor IDE hooks. Authenticated via API key (bearer) or session cookie; not IP-rate-limited. When `session_id` is absent, `conversation_id` is used as the session identifier (one of the two is required). Responses use the legacy CLI-compatible `{status, message}` shape rather than the standard envelope. New sessions are checked against the user's `ai_session` resource limit (and `ai_tool` limit for the first-ever session), returning 403 when exceeded.
|
|
893
|
+
*/
|
|
894
|
+
export declare const ingestCursorIdeHook: <ThrowOnError extends boolean = false>(options: Options<IngestCursorIdeHookData, ThrowOnError>) => RequestResult<IngestCursorIdeHookResponses, IngestCursorIdeHookErrors, ThrowOnError>;
|
|
895
|
+
/**
|
|
896
|
+
* List teams
|
|
897
|
+
*
|
|
898
|
+
* Returns the paginated list of teams the current user belongs to. Invalid
|
|
899
|
+
* `page`/`page_size` values silently fall back to the defaults.
|
|
900
|
+
*
|
|
901
|
+
*/
|
|
902
|
+
export declare const listTeams: <ThrowOnError extends boolean = false>(options?: Options<ListTeamsData, ThrowOnError>) => RequestResult<ListTeamsResponses, ListTeamsErrors, ThrowOnError>;
|
|
903
|
+
/**
|
|
904
|
+
* Create a new team
|
|
905
|
+
*
|
|
906
|
+
* Creates a new team owned by the current user and synchronously bootstraps a
|
|
907
|
+
* default "Project 1" project inside it so resources created immediately
|
|
908
|
+
* afterwards are correctly scoped.
|
|
909
|
+
*
|
|
910
|
+
* Team creation is subject to the plan's team resource limit; exceeding it
|
|
911
|
+
* returns `403` with code `RESOURCE_LIMIT_EXCEEDED`.
|
|
912
|
+
*
|
|
913
|
+
*/
|
|
914
|
+
export declare const createTeam: <ThrowOnError extends boolean = false>(options: Options<CreateTeamData, ThrowOnError>) => RequestResult<CreateTeamResponses, CreateTeamErrors, ThrowOnError>;
|
|
915
|
+
/**
|
|
916
|
+
* Delete a team
|
|
917
|
+
*
|
|
918
|
+
* Deletes a team. Only team owners can delete a team; personal workspaces and
|
|
919
|
+
* the default team cannot be deleted.
|
|
920
|
+
*
|
|
921
|
+
* Deletion conflicts return `409` with RFC 9457 problem details carrying an
|
|
922
|
+
* UPPERCASE `code` and string-valued `metadata`:
|
|
923
|
+
* - `ACTIVE_SUBSCRIPTION_EXISTS` — the team still has an active subscription
|
|
924
|
+
* - `SUBSCRIPTION_CANCELING` — the subscription is scheduled to cancel; retry after `metadata.cancel_at`
|
|
925
|
+
* - `TEAM_HAS_MEMBERS` — remove all members first (`metadata.member_count`)
|
|
926
|
+
*
|
|
927
|
+
*/
|
|
928
|
+
export declare const deleteTeam: <ThrowOnError extends boolean = false>(options: Options<DeleteTeamData, ThrowOnError>) => RequestResult<DeleteTeamResponses, DeleteTeamErrors, ThrowOnError>;
|
|
929
|
+
/**
|
|
930
|
+
* Get a team
|
|
931
|
+
*
|
|
932
|
+
* Returns the team with the requesting user's role populated (member_count is only populated on list responses and is 0 here).
|
|
933
|
+
*/
|
|
934
|
+
export declare const getTeam: <ThrowOnError extends boolean = false>(options: Options<GetTeamData, ThrowOnError>) => RequestResult<GetTeamResponses, GetTeamErrors, ThrowOnError>;
|
|
935
|
+
/**
|
|
936
|
+
* Update a team
|
|
937
|
+
*
|
|
938
|
+
* Updates the team's name and/or description. Only team owners can update a
|
|
939
|
+
* team. At least one of `name` or `description` must be provided.
|
|
940
|
+
*
|
|
941
|
+
*/
|
|
942
|
+
export declare const updateTeam: <ThrowOnError extends boolean = false>(options: Options<UpdateTeamData, ThrowOnError>) => RequestResult<UpdateTeamResponses, UpdateTeamErrors, ThrowOnError>;
|
|
943
|
+
/**
|
|
944
|
+
* List team members
|
|
945
|
+
*
|
|
946
|
+
* Returns the paginated list of team members with user details and invitation
|
|
947
|
+
* status. Invalid `page`/`page_size` values silently fall back to the defaults.
|
|
948
|
+
*
|
|
949
|
+
*/
|
|
950
|
+
export declare const getTeamMembers: <ThrowOnError extends boolean = false>(options: Options<GetTeamMembersData, ThrowOnError>) => RequestResult<GetTeamMembersResponses, GetTeamMembersErrors, ThrowOnError>;
|
|
951
|
+
/**
|
|
952
|
+
* Remove a team member
|
|
953
|
+
*
|
|
954
|
+
* Removes a member from the team. Only team owners can remove members, and the
|
|
955
|
+
* team owner cannot be removed.
|
|
956
|
+
*
|
|
957
|
+
*/
|
|
958
|
+
export declare const removeTeamMember: <ThrowOnError extends boolean = false>(options: Options<RemoveTeamMemberData, ThrowOnError>) => RequestResult<RemoveTeamMemberResponses, RemoveTeamMemberErrors, ThrowOnError>;
|
|
959
|
+
/**
|
|
960
|
+
* List team invitations
|
|
961
|
+
*
|
|
962
|
+
* Returns all invitations for the team. The `token`, `team_name` and
|
|
963
|
+
* `invited_by` fields are not populated on this listing.
|
|
964
|
+
*
|
|
965
|
+
*/
|
|
966
|
+
export declare const listTeamInvitations: <ThrowOnError extends boolean = false>(options: Options<ListTeamInvitationsData, ThrowOnError>) => RequestResult<ListTeamInvitationsResponses, ListTeamInvitationsErrors, ThrowOnError>;
|
|
967
|
+
/**
|
|
968
|
+
* Send team invitations
|
|
969
|
+
*
|
|
970
|
+
* Sends invitations to join the team to up to 50 email addresses with the given
|
|
971
|
+
* role. Requires an eligible team (not a personal workspace), an active team
|
|
972
|
+
* subscription, and enough available seats.
|
|
973
|
+
*
|
|
974
|
+
* Limit failures return `403` with code `RESOURCE_LIMIT_EXCEEDED` and a
|
|
975
|
+
* `metadata` object: for missing subscriptions it carries `team_id`, `feature`
|
|
976
|
+
* and `upgrade_url`; for seat limits it carries `team_id` plus seat accounting fields
|
|
977
|
+
* (`total_seats`, `occupied_seats`, `current_members`, `pending_invitations`,
|
|
978
|
+
* `requested_invitations`, `available_seats`, `additional_seats_needed`,
|
|
979
|
+
* `upgrade_url`).
|
|
980
|
+
*
|
|
981
|
+
* Inviting users who are already team members returns `409` with code
|
|
982
|
+
* `DUPLICATE_MEMBERS` and a top-level `duplicate_emails` string array.
|
|
983
|
+
*
|
|
984
|
+
*/
|
|
985
|
+
export declare const sendTeamInvitations: <ThrowOnError extends boolean = false>(options: Options<SendTeamInvitationsData, ThrowOnError>) => RequestResult<SendTeamInvitationsResponses, SendTeamInvitationsErrors, ThrowOnError>;
|
|
986
|
+
/**
|
|
987
|
+
* Revoke a team invitation
|
|
988
|
+
*
|
|
989
|
+
* Revokes a pending team invitation so its token can no longer be accepted.
|
|
990
|
+
*/
|
|
991
|
+
export declare const revokeTeamInvitation: <ThrowOnError extends boolean = false>(options: Options<RevokeTeamInvitationData, ThrowOnError>) => RequestResult<RevokeTeamInvitationResponses, RevokeTeamInvitationErrors, ThrowOnError>;
|
|
992
|
+
/**
|
|
993
|
+
* Get team statistics
|
|
994
|
+
*
|
|
995
|
+
* Returns team-wide resource counts (projects, prompts, artifacts, blueprints, memories, feed items) for the team analytics page. Authorized via team membership.
|
|
996
|
+
*/
|
|
997
|
+
export declare const getTeamStats: <ThrowOnError extends boolean = false>(options: Options<GetTeamStatsData, ThrowOnError>) => RequestResult<GetTeamStatsResponses, GetTeamStatsErrors, ThrowOnError>;
|
|
998
|
+
/**
|
|
999
|
+
* Per-team daily resource-creation metrics
|
|
1000
|
+
*
|
|
1001
|
+
* Returns a zero-filled daily creation timeseries for a team, counting prompts, artifacts, blueprints, memories, and projects created on each day, for the team analytics-page chart. Every day in the requested range appears even when its count is zero. Authorized via team membership.
|
|
1002
|
+
*/
|
|
1003
|
+
export declare const getTeamResourceCreationMetrics: <ThrowOnError extends boolean = false>(options: Options<GetTeamResourceCreationMetricsData, ThrowOnError>) => RequestResult<GetTeamResourceCreationMetricsResponses, GetTeamResourceCreationMetricsErrors, ThrowOnError>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Per-team daily access metrics
|
|
1006
|
+
*
|
|
1007
|
+
* Returns a zero-filled daily access timeseries for a team, grouped by source (web, cli, mcp, api), aggregated across every resource in the team, for the team analytics-page chart. Every day in the requested range appears even when its count is zero. Authorized via team membership.
|
|
1008
|
+
*/
|
|
1009
|
+
export declare const getTeamResourceAccessMetrics: <ThrowOnError extends boolean = false>(options: Options<GetTeamResourceAccessMetricsData, ThrowOnError>) => RequestResult<GetTeamResourceAccessMetricsResponses, GetTeamResourceAccessMetricsErrors, ThrowOnError>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Per-team daily feed-creation metrics
|
|
1012
|
+
*
|
|
1013
|
+
* Returns a zero-filled daily feed-creation timeseries for a team, counting feeds (channels, by creation date) and feed_items (AI updates posted, by posted date) on each day, for the team analytics-page "AI feeds created" chart. Every day in the requested range appears even when its count is zero. Authorized via team membership.
|
|
1014
|
+
*/
|
|
1015
|
+
export declare const getTeamFeedCreationMetrics: <ThrowOnError extends boolean = false>(options: Options<GetTeamFeedCreationMetricsData, ThrowOnError>) => RequestResult<GetTeamFeedCreationMetricsResponses, GetTeamFeedCreationMetricsErrors, ThrowOnError>;
|
|
1016
|
+
/**
|
|
1017
|
+
* Per-team most-accessed resources
|
|
1018
|
+
*
|
|
1019
|
+
* Returns the team's most-accessed resources over the requested window, ranked by access count descending and capped by the limit parameter, with each row's display name resolved so the frontend can render and deep-link it. Authorized via team membership.
|
|
1020
|
+
*/
|
|
1021
|
+
export declare const getTeamTopAccessedResources: <ThrowOnError extends boolean = false>(options: Options<GetTeamTopAccessedResourcesData, ThrowOnError>) => RequestResult<GetTeamTopAccessedResourcesResponses, GetTeamTopAccessedResourcesErrors, ThrowOnError>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Get pending invitations for the current user
|
|
1024
|
+
*
|
|
1025
|
+
* Returns the current user's pending team invitations (matched by the user's
|
|
1026
|
+
* email), enriched with team name and inviter details where available. The
|
|
1027
|
+
* response is not actually paginated: all pending invitations are returned and
|
|
1028
|
+
* `page`/`page_size` are fixed at `1`/`20`.
|
|
1029
|
+
*
|
|
1030
|
+
*/
|
|
1031
|
+
export declare const getPendingInvitations: <ThrowOnError extends boolean = false>(options?: Options<GetPendingInvitationsData, ThrowOnError>) => RequestResult<GetPendingInvitationsResponses, GetPendingInvitationsErrors, ThrowOnError>;
|
|
1032
|
+
/**
|
|
1033
|
+
* Accept a team invitation
|
|
1034
|
+
*
|
|
1035
|
+
* Accepts a pending team invitation by token and adds the current user to the
|
|
1036
|
+
* team. The invitation must have been sent to the authenticated user's email
|
|
1037
|
+
* address.
|
|
1038
|
+
*
|
|
1039
|
+
*/
|
|
1040
|
+
export declare const acceptInvitation: <ThrowOnError extends boolean = false>(options: Options<AcceptInvitationData, ThrowOnError>) => RequestResult<AcceptInvitationResponses, AcceptInvitationErrors, ThrowOnError>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Reject a team invitation
|
|
1043
|
+
*
|
|
1044
|
+
* Rejects a pending team invitation by token. Only the invited user can reject it.
|
|
1045
|
+
*/
|
|
1046
|
+
export declare const rejectInvitation: <ThrowOnError extends boolean = false>(options: Options<RejectInvitationData, ThrowOnError>) => RequestResult<RejectInvitationResponses, RejectInvitationErrors, ThrowOnError>;
|
|
1047
|
+
/**
|
|
1048
|
+
* List notifications
|
|
1049
|
+
*
|
|
1050
|
+
* Returns the authenticated user's in-app notifications, newest first, with
|
|
1051
|
+
* offset-based pagination. `count` is the number of items in this page (≤ `limit`),
|
|
1052
|
+
* not the global total — use the unread-count endpoint for unread totals.
|
|
1053
|
+
*
|
|
1054
|
+
*/
|
|
1055
|
+
export declare const listNotifications: <ThrowOnError extends boolean = false>(options?: Options<ListNotificationsData, ThrowOnError>) => RequestResult<ListNotificationsResponses, ListNotificationsErrors, ThrowOnError>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Get unread notification count
|
|
1058
|
+
*
|
|
1059
|
+
* Returns the total number of unread notifications for the authenticated user.
|
|
1060
|
+
*/
|
|
1061
|
+
export declare const getUnreadNotificationCount: <ThrowOnError extends boolean = false>(options?: Options<GetUnreadNotificationCountData, ThrowOnError>) => RequestResult<GetUnreadNotificationCountResponses, GetUnreadNotificationCountErrors, ThrowOnError>;
|
|
1062
|
+
/**
|
|
1063
|
+
* Mark notification as read
|
|
1064
|
+
*
|
|
1065
|
+
* Marks a single notification as read for the authenticated user. Idempotent —
|
|
1066
|
+
* succeeds with 204 even if the notification is already read or does not belong
|
|
1067
|
+
* to the user (no 404 is returned).
|
|
1068
|
+
*
|
|
1069
|
+
*/
|
|
1070
|
+
export declare const markNotificationRead: <ThrowOnError extends boolean = false>(options: Options<MarkNotificationReadData, ThrowOnError>) => RequestResult<MarkNotificationReadResponses, MarkNotificationReadErrors, ThrowOnError>;
|
|
1071
|
+
/**
|
|
1072
|
+
* Mark all notifications as read
|
|
1073
|
+
*
|
|
1074
|
+
* Marks all of the authenticated user's notifications as read. No request body is required.
|
|
1075
|
+
*/
|
|
1076
|
+
export declare const markAllNotificationsRead: <ThrowOnError extends boolean = false>(options?: Options<MarkAllNotificationsReadData, ThrowOnError>) => RequestResult<MarkAllNotificationsReadResponses, MarkAllNotificationsReadErrors, ThrowOnError>;
|
|
1077
|
+
/**
|
|
1078
|
+
* List types for a resource
|
|
1079
|
+
*
|
|
1080
|
+
* Returns every type visible to the team for the given `resource_type`: the global system defaults plus the team's own custom types, system defaults first.
|
|
1081
|
+
*
|
|
1082
|
+
*/
|
|
1083
|
+
export declare const listTypes: <ThrowOnError extends boolean = false>(options: Options<ListTypesData, ThrowOnError>) => RequestResult<ListTypesResponses, ListTypesErrors, ThrowOnError>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Create a custom type
|
|
1086
|
+
*
|
|
1087
|
+
* Creates a team-owned custom type for the given resource. The slug must be URL-safe (lowercase letters, numbers, hyphens) and unique within the team for the resource — a collision with a global default or an existing team type returns 409.
|
|
1088
|
+
*
|
|
1089
|
+
*/
|
|
1090
|
+
export declare const createType: <ThrowOnError extends boolean = false>(options: Options<CreateTypeData, ThrowOnError>) => RequestResult<CreateTypeResponses, CreateTypeErrors, ThrowOnError>;
|
|
1091
|
+
/**
|
|
1092
|
+
* Delete a custom type
|
|
1093
|
+
*
|
|
1094
|
+
* Deletes a team-owned custom type. System defaults cannot be deleted (a delete targeting one — or another team's type — returns 404). Any resources still referencing the deleted type are reassigned to the resource's system default in the same transaction.
|
|
1095
|
+
*
|
|
1096
|
+
*/
|
|
1097
|
+
export declare const deleteType: <ThrowOnError extends boolean = false>(options: Options<DeleteTypeData, ThrowOnError>) => RequestResult<DeleteTypeResponses, DeleteTypeErrors, ThrowOnError>;
|
|
1098
|
+
/**
|
|
1099
|
+
* List embedding providers
|
|
1100
|
+
*
|
|
1101
|
+
* Retrieves all embedding providers belonging to the authenticated user.
|
|
1102
|
+
* Returns a bare JSON array (no pagination envelope). Encrypted API keys
|
|
1103
|
+
* are never included; each item carries a `has_api_key` boolean instead.
|
|
1104
|
+
*
|
|
1105
|
+
*/
|
|
1106
|
+
export declare const listEmbeddingProviders: <ThrowOnError extends boolean = false>(options?: Options<ListEmbeddingProvidersData, ThrowOnError>) => RequestResult<ListEmbeddingProvidersResponses, ListEmbeddingProvidersErrors, ThrowOnError>;
|
|
1107
|
+
/**
|
|
1108
|
+
* Create embedding provider
|
|
1109
|
+
*
|
|
1110
|
+
* Creates a new embedding provider configuration for the authenticated user.
|
|
1111
|
+
* The `api_key` supplied in the request is encrypted at rest and is never
|
|
1112
|
+
* returned by the API — responses expose only a `has_api_key` boolean.
|
|
1113
|
+
* Returns 200 (not 201) on success.
|
|
1114
|
+
*
|
|
1115
|
+
*/
|
|
1116
|
+
export declare const createEmbeddingProvider: <ThrowOnError extends boolean = false>(options: Options<CreateEmbeddingProviderData, ThrowOnError>) => RequestResult<CreateEmbeddingProviderResponses, CreateEmbeddingProviderErrors, ThrowOnError>;
|
|
1117
|
+
/**
|
|
1118
|
+
* Delete embedding provider
|
|
1119
|
+
*
|
|
1120
|
+
* Deletes an embedding provider owned by the authenticated user. Deleting
|
|
1121
|
+
* the user's last remaining provider is blocked with a 400
|
|
1122
|
+
* `PROVIDER_LAST_DELETE_BLOCKED` error.
|
|
1123
|
+
*
|
|
1124
|
+
*/
|
|
1125
|
+
export declare const deleteEmbeddingProvider: <ThrowOnError extends boolean = false>(options: Options<DeleteEmbeddingProviderData, ThrowOnError>) => RequestResult<DeleteEmbeddingProviderResponses, DeleteEmbeddingProviderErrors, ThrowOnError>;
|
|
1126
|
+
/**
|
|
1127
|
+
* Get embedding provider
|
|
1128
|
+
*
|
|
1129
|
+
* Retrieves a single embedding provider owned by the authenticated user.
|
|
1130
|
+
* The encrypted API key is never returned; `has_api_key` indicates whether
|
|
1131
|
+
* one is stored.
|
|
1132
|
+
*
|
|
1133
|
+
*/
|
|
1134
|
+
export declare const getEmbeddingProvider: <ThrowOnError extends boolean = false>(options: Options<GetEmbeddingProviderData, ThrowOnError>) => RequestResult<GetEmbeddingProviderResponses, GetEmbeddingProviderErrors, ThrowOnError>;
|
|
1135
|
+
/**
|
|
1136
|
+
* Update embedding provider
|
|
1137
|
+
*
|
|
1138
|
+
* Updates an existing embedding provider. All fields are optional; only
|
|
1139
|
+
* provided fields are changed. A supplied `api_key` replaces the stored
|
|
1140
|
+
* (encrypted) key and is never echoed back in the response.
|
|
1141
|
+
*
|
|
1142
|
+
*/
|
|
1143
|
+
export declare const updateEmbeddingProvider: <ThrowOnError extends boolean = false>(options: Options<UpdateEmbeddingProviderData, ThrowOnError>) => RequestResult<UpdateEmbeddingProviderResponses, UpdateEmbeddingProviderErrors, ThrowOnError>;
|
|
1144
|
+
/**
|
|
1145
|
+
* Validate embedding provider configuration
|
|
1146
|
+
*
|
|
1147
|
+
* Validates an embedding provider configuration (connectivity/credentials)
|
|
1148
|
+
* without persisting anything. Validation outcome — including an invalid
|
|
1149
|
+
* configuration — is reported in the 200 response body (`is_valid`,
|
|
1150
|
+
* `message`, `details`); 500 is returned only for internal service errors.
|
|
1151
|
+
*
|
|
1152
|
+
*/
|
|
1153
|
+
export declare const validateEmbeddingProvider: <ThrowOnError extends boolean = false>(options: Options<ValidateEmbeddingProviderData, ThrowOnError>) => RequestResult<ValidateEmbeddingProviderResponses, ValidateEmbeddingProviderErrors, ThrowOnError>;
|
|
1154
|
+
/**
|
|
1155
|
+
* List embedding providers (Settings)
|
|
1156
|
+
*
|
|
1157
|
+
* Retrieves all embedding providers belonging to the authenticated user (settings route).
|
|
1158
|
+
* Returns a bare JSON array (no pagination envelope). Encrypted API keys
|
|
1159
|
+
* are never included; each item carries a `has_api_key` boolean instead.
|
|
1160
|
+
*
|
|
1161
|
+
*/
|
|
1162
|
+
export declare const listEmbeddingProvidersSettings: <ThrowOnError extends boolean = false>(options?: Options<ListEmbeddingProvidersSettingsData, ThrowOnError>) => RequestResult<ListEmbeddingProvidersSettingsResponses, ListEmbeddingProvidersSettingsErrors, ThrowOnError>;
|
|
1163
|
+
/**
|
|
1164
|
+
* Create embedding provider (Settings)
|
|
1165
|
+
*
|
|
1166
|
+
* Creates a new embedding provider configuration for the authenticated user (settings route).
|
|
1167
|
+
* The `api_key` supplied in the request is encrypted at rest and is never
|
|
1168
|
+
* returned by the API — responses expose only a `has_api_key` boolean.
|
|
1169
|
+
* Returns 200 (not 201) on success.
|
|
1170
|
+
*
|
|
1171
|
+
*/
|
|
1172
|
+
export declare const createEmbeddingProviderSettings: <ThrowOnError extends boolean = false>(options: Options<CreateEmbeddingProviderSettingsData, ThrowOnError>) => RequestResult<CreateEmbeddingProviderSettingsResponses, CreateEmbeddingProviderSettingsErrors, ThrowOnError>;
|
|
1173
|
+
/**
|
|
1174
|
+
* Delete embedding provider (Settings)
|
|
1175
|
+
*
|
|
1176
|
+
* Deletes an embedding provider owned by the authenticated user (settings route).
|
|
1177
|
+
* Deleting the user's last remaining provider is blocked with a 400
|
|
1178
|
+
* `PROVIDER_LAST_DELETE_BLOCKED` error.
|
|
1179
|
+
*
|
|
1180
|
+
*/
|
|
1181
|
+
export declare const deleteEmbeddingProviderSettings: <ThrowOnError extends boolean = false>(options: Options<DeleteEmbeddingProviderSettingsData, ThrowOnError>) => RequestResult<DeleteEmbeddingProviderSettingsResponses, DeleteEmbeddingProviderSettingsErrors, ThrowOnError>;
|
|
1182
|
+
/**
|
|
1183
|
+
* Get embedding provider (Settings)
|
|
1184
|
+
*
|
|
1185
|
+
* Retrieves a single embedding provider owned by the authenticated user (settings route).
|
|
1186
|
+
* The encrypted API key is never returned; `has_api_key` indicates whether
|
|
1187
|
+
* one is stored.
|
|
1188
|
+
*
|
|
1189
|
+
*/
|
|
1190
|
+
export declare const getEmbeddingProviderSettings: <ThrowOnError extends boolean = false>(options: Options<GetEmbeddingProviderSettingsData, ThrowOnError>) => RequestResult<GetEmbeddingProviderSettingsResponses, GetEmbeddingProviderSettingsErrors, ThrowOnError>;
|
|
1191
|
+
/**
|
|
1192
|
+
* Update embedding provider (Settings)
|
|
1193
|
+
*
|
|
1194
|
+
* Updates an existing embedding provider (settings route). All fields are
|
|
1195
|
+
* optional; only provided fields are changed. A supplied `api_key`
|
|
1196
|
+
* replaces the stored (encrypted) key and is never echoed back in the
|
|
1197
|
+
* response.
|
|
1198
|
+
*
|
|
1199
|
+
*/
|
|
1200
|
+
export declare const updateEmbeddingProviderSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateEmbeddingProviderSettingsData, ThrowOnError>) => RequestResult<UpdateEmbeddingProviderSettingsResponses, UpdateEmbeddingProviderSettingsErrors, ThrowOnError>;
|
|
1201
|
+
/**
|
|
1202
|
+
* Validate embedding provider configuration (Settings)
|
|
1203
|
+
*
|
|
1204
|
+
* Validates an embedding provider configuration (connectivity/credentials)
|
|
1205
|
+
* without persisting anything (settings route). Validation outcome —
|
|
1206
|
+
* including an invalid configuration — is reported in the 200 response
|
|
1207
|
+
* body (`is_valid`, `message`, `details`); 500 is returned only for
|
|
1208
|
+
* internal service errors.
|
|
1209
|
+
*
|
|
1210
|
+
*/
|
|
1211
|
+
export declare const validateEmbeddingProviderSettings: <ThrowOnError extends boolean = false>(options: Options<ValidateEmbeddingProviderSettingsData, ThrowOnError>) => RequestResult<ValidateEmbeddingProviderSettingsResponses, ValidateEmbeddingProviderSettingsErrors, ThrowOnError>;
|
|
1212
|
+
/**
|
|
1213
|
+
* List projects
|
|
1214
|
+
*
|
|
1215
|
+
* Returns a paginated list of projects within the specified team. Each
|
|
1216
|
+
* project is enriched with a `github_connected` flag indicating whether
|
|
1217
|
+
* its git URL matches a repository accessible via the team's GitHub App
|
|
1218
|
+
* installation.
|
|
1219
|
+
*
|
|
1220
|
+
*/
|
|
1221
|
+
export declare const listProjects: <ThrowOnError extends boolean = false>(options: Options<ListProjectsData, ThrowOnError>) => RequestResult<ListProjectsResponses, ListProjectsErrors, ThrowOnError>;
|
|
1222
|
+
/**
|
|
1223
|
+
* Create new project
|
|
1224
|
+
*
|
|
1225
|
+
* Creates a new project within the specified team. Project slugs must be
|
|
1226
|
+
* unique within the team. Requires team membership and an active subscription.
|
|
1227
|
+
*
|
|
1228
|
+
*/
|
|
1229
|
+
export declare const createProject: <ThrowOnError extends boolean = false>(options: Options<CreateProjectData, ThrowOnError>) => RequestResult<CreateProjectResponses, CreateProjectErrors, ThrowOnError>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Delete project
|
|
1232
|
+
*
|
|
1233
|
+
* Deletes a project identified by its slug. The last remaining project in
|
|
1234
|
+
* a team cannot be deleted (returns 400).
|
|
1235
|
+
*
|
|
1236
|
+
*/
|
|
1237
|
+
export declare const deleteProject: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>) => RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
|
|
1238
|
+
/**
|
|
1239
|
+
* Get project by slug
|
|
1240
|
+
*
|
|
1241
|
+
* Returns a single project identified by its URL-encoded slug within the specified team.
|
|
1242
|
+
*/
|
|
1243
|
+
export declare const getProject: <ThrowOnError extends boolean = false>(options: Options<GetProjectData, ThrowOnError>) => RequestResult<GetProjectResponses, GetProjectErrors, ThrowOnError>;
|
|
1244
|
+
/**
|
|
1245
|
+
* Update project
|
|
1246
|
+
*
|
|
1247
|
+
* Partially updates a project identified by its slug. Only fields present
|
|
1248
|
+
* in the request body are changed. Uses optimistic locking — a concurrent
|
|
1249
|
+
* modification returns 409. Projects cannot be moved between teams.
|
|
1250
|
+
*
|
|
1251
|
+
*/
|
|
1252
|
+
export declare const updateProject: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>) => RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
|
|
1253
|
+
/**
|
|
1254
|
+
* Get project migration inventory
|
|
1255
|
+
*
|
|
1256
|
+
* Returns a count and item list of all migratable resources (prompts,
|
|
1257
|
+
* artifacts, spec libraries, feed items) in the given project, used to
|
|
1258
|
+
* drive the migration UI.
|
|
1259
|
+
*
|
|
1260
|
+
*/
|
|
1261
|
+
export declare const getProjectMigrationInventory: <ThrowOnError extends boolean = false>(options: Options<GetProjectMigrationInventoryData, ThrowOnError>) => RequestResult<GetProjectMigrationInventoryResponses, GetProjectMigrationInventoryErrors, ThrowOnError>;
|
|
1262
|
+
/**
|
|
1263
|
+
* Migrate project resources
|
|
1264
|
+
*
|
|
1265
|
+
* Moves selected resources (prompts, artifacts, spec libraries, feed items)
|
|
1266
|
+
* from the source project to a destination project in the same team.
|
|
1267
|
+
* Slug collisions are handled per the requested conflict policy
|
|
1268
|
+
* (skip, rename, or overwrite; defaults to skip). Returns per-type
|
|
1269
|
+
* migrated counts plus skipped/failed outcomes with a 200 status.
|
|
1270
|
+
*
|
|
1271
|
+
*/
|
|
1272
|
+
export declare const migrateProject: <ThrowOnError extends boolean = false>(options: Options<MigrateProjectData, ThrowOnError>) => RequestResult<MigrateProjectResponses, MigrateProjectErrors, ThrowOnError>;
|
|
1273
|
+
/**
|
|
1274
|
+
* List activities
|
|
1275
|
+
*
|
|
1276
|
+
* Returns a paginated list of the authenticated user's activities, with
|
|
1277
|
+
* optional filtering by type, entity, session, free-text search, and date
|
|
1278
|
+
* range. Activities are user-scoped (not team-scoped). Invalid filter or
|
|
1279
|
+
* pagination values are silently ignored and defaults applied.
|
|
1280
|
+
*
|
|
1281
|
+
*/
|
|
1282
|
+
export declare const listActivities: <ThrowOnError extends boolean = false>(options?: Options<ListActivitiesData, ThrowOnError>) => RequestResult<ListActivitiesResponses, ListActivitiesErrors, ThrowOnError>;
|
|
1283
|
+
/**
|
|
1284
|
+
* Create activity
|
|
1285
|
+
*
|
|
1286
|
+
* Manually records an activity for the authenticated user. The server
|
|
1287
|
+
* enriches the activity metadata with manual_creation/created_via flags
|
|
1288
|
+
* and overwrites source_ip and user_agent from the request.
|
|
1289
|
+
*
|
|
1290
|
+
*/
|
|
1291
|
+
export declare const createActivity: <ThrowOnError extends boolean = false>(options: Options<CreateActivityData, ThrowOnError>) => RequestResult<CreateActivityResponses, CreateActivityErrors, ThrowOnError>;
|
|
1292
|
+
/**
|
|
1293
|
+
* Get activity statistics
|
|
1294
|
+
*
|
|
1295
|
+
* Returns aggregated activity statistics for the authenticated user,
|
|
1296
|
+
* including totals, top activity/entity types, recent activities, and a
|
|
1297
|
+
* per-day count for the current week.
|
|
1298
|
+
*
|
|
1299
|
+
*/
|
|
1300
|
+
export declare const getActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetActivityStatsData, ThrowOnError>) => RequestResult<GetActivityStatsResponses, GetActivityStatsErrors, ThrowOnError>;
|
|
1301
|
+
/**
|
|
1302
|
+
* Get activity and entity types
|
|
1303
|
+
*
|
|
1304
|
+
* Returns the catalog of activity types this endpoint exposes (a curated subset of all recorded types) and the entity types, in a single response.
|
|
1305
|
+
*/
|
|
1306
|
+
export declare const getActivityTypes: <ThrowOnError extends boolean = false>(options?: Options<GetActivityTypesData, ThrowOnError>) => RequestResult<GetActivityTypesResponses, GetActivityTypesErrors, ThrowOnError>;
|
|
1307
|
+
/**
|
|
1308
|
+
* Get entity types
|
|
1309
|
+
*
|
|
1310
|
+
* Returns the static catalog of known entity types as a plain string array.
|
|
1311
|
+
*/
|
|
1312
|
+
export declare const getActivityEntityTypes: <ThrowOnError extends boolean = false>(options?: Options<GetActivityEntityTypesData, ThrowOnError>) => RequestResult<GetActivityEntityTypesResponses, GetActivityEntityTypesErrors, ThrowOnError>;
|
|
1313
|
+
/**
|
|
1314
|
+
* Get activity by ID
|
|
1315
|
+
*
|
|
1316
|
+
* Returns a single activity owned by the authenticated user.
|
|
1317
|
+
*/
|
|
1318
|
+
export declare const getActivity: <ThrowOnError extends boolean = false>(options: Options<GetActivityData, ThrowOnError>) => RequestResult<GetActivityResponses, GetActivityErrors, ThrowOnError>;
|
|
1319
|
+
/**
|
|
1320
|
+
* Get user preferences
|
|
1321
|
+
*
|
|
1322
|
+
* Returns the authenticated user's preferences (email notification settings and
|
|
1323
|
+
* per-channel/per-type notification delivery preferences). Defaults are created
|
|
1324
|
+
* on first access if the user has no stored preferences.
|
|
1325
|
+
*
|
|
1326
|
+
*/
|
|
1327
|
+
export declare const getPreferences: <ThrowOnError extends boolean = false>(options?: Options<GetPreferencesData, ThrowOnError>) => RequestResult<GetPreferencesResponses, GetPreferencesErrors, ThrowOnError>;
|
|
1328
|
+
/**
|
|
1329
|
+
* Update user preferences
|
|
1330
|
+
*
|
|
1331
|
+
* Updates the authenticated user's preferences. Both top-level fields are optional;
|
|
1332
|
+
* only the categories present in the request body are updated.
|
|
1333
|
+
*
|
|
1334
|
+
*/
|
|
1335
|
+
export declare const updatePreferences: <ThrowOnError extends boolean = false>(options: Options<UpdatePreferencesData, ThrowOnError>) => RequestResult<UpdatePreferencesResponses, UpdatePreferencesErrors, ThrowOnError>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Delete a device token
|
|
1338
|
+
*
|
|
1339
|
+
* Removes a push notification device token for the authenticated user. The token to
|
|
1340
|
+
* delete is supplied in the JSON request body. Request body is capped at 4 KB.
|
|
1341
|
+
*
|
|
1342
|
+
*/
|
|
1343
|
+
export declare const deleteDeviceToken: <ThrowOnError extends boolean = false>(options: Options<DeleteDeviceTokenData, ThrowOnError>) => RequestResult<DeleteDeviceTokenResponses, DeleteDeviceTokenErrors, ThrowOnError>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Register a device token
|
|
1346
|
+
*
|
|
1347
|
+
* Upserts a push notification device token for the authenticated user. Currently
|
|
1348
|
+
* only the "web" platform (Web Push / FCM browser push) is supported. Re-registering
|
|
1349
|
+
* the same token for the same user is idempotent. Request body is capped at 4 KB.
|
|
1350
|
+
* Free-tier accessible — push notification registration is not a gated resource.
|
|
1351
|
+
*
|
|
1352
|
+
*/
|
|
1353
|
+
export declare const registerDeviceToken: <ThrowOnError extends boolean = false>(options: Options<RegisterDeviceTokenData, ThrowOnError>) => RequestResult<RegisterDeviceTokenResponses, RegisterDeviceTokenErrors, ThrowOnError>;
|
|
1354
|
+
/**
|
|
1355
|
+
* Mark onboarding as completed
|
|
1356
|
+
*
|
|
1357
|
+
* Marks the authenticated user's onboarding flow as completed and returns the
|
|
1358
|
+
* updated user object. Takes no request body.
|
|
1359
|
+
*
|
|
1360
|
+
*/
|
|
1361
|
+
export declare const completeOnboarding: <ThrowOnError extends boolean = false>(options?: Options<CompleteOnboardingData, ThrowOnError>) => RequestResult<CompleteOnboardingResponses, CompleteOnboardingErrors, ThrowOnError>;
|
|
1362
|
+
/**
|
|
1363
|
+
* Send a contact form message
|
|
1364
|
+
*
|
|
1365
|
+
* Submits a contact form message from the public marketing website and fans it out
|
|
1366
|
+
* to the email provider. This is a public endpoint (no authentication) with a very
|
|
1367
|
+
* strict per-IP rate limit; exceeding it returns 429. Request body is capped at 64 KB.
|
|
1368
|
+
* Note — error responses deviate from the standard `ErrorResponse` shape: validation
|
|
1369
|
+
* failures (400) and email-send failures (500) return a `ContactFormResponse` with
|
|
1370
|
+
* `success: false`, while malformed JSON (400) and oversized bodies (413) return a
|
|
1371
|
+
* plain-text message.
|
|
1372
|
+
*
|
|
1373
|
+
*/
|
|
1374
|
+
export declare const sendContactMessage: <ThrowOnError extends boolean = false>(options: Options<SendContactMessageData, ThrowOnError>) => RequestResult<SendContactMessageResponses, SendContactMessageErrors, ThrowOnError>;
|
|
1375
|
+
/**
|
|
1376
|
+
* List feed item replies
|
|
1377
|
+
*
|
|
1378
|
+
* Returns paginated threaded replies for the specified feed item, team-scoped
|
|
1379
|
+
* (free-tier accessible).
|
|
1380
|
+
*
|
|
1381
|
+
*/
|
|
1382
|
+
export declare const listFeedItemReplies: <ThrowOnError extends boolean = false>(options: Options<ListFeedItemRepliesData, ThrowOnError>) => RequestResult<ListFeedItemRepliesResponses, ListFeedItemRepliesErrors, ThrowOnError>;
|
|
1383
|
+
/**
|
|
1384
|
+
* Create a feed item reply
|
|
1385
|
+
*
|
|
1386
|
+
* Posts a threaded reply to the specified feed item, team-scoped (free-tier
|
|
1387
|
+
* accessible). Replies cannot be posted to archived feed items. Reply creation
|
|
1388
|
+
* counts against the user's feed item resource limit.
|
|
1389
|
+
*
|
|
1390
|
+
*/
|
|
1391
|
+
export declare const createFeedItemReply: <ThrowOnError extends boolean = false>(options: Options<CreateFeedItemReplyData, ThrowOnError>) => RequestResult<CreateFeedItemReplyResponses, CreateFeedItemReplyErrors, ThrowOnError>;
|