@vibexp/api-client 0.42.0 → 0.44.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/dist/axios/index.d.ts +2 -2
- package/dist/axios/index.js +1 -1
- package/dist/axios/sdk.gen.d.ts +315 -14
- package/dist/axios/sdk.gen.js +634 -21
- package/dist/axios/types.gen.d.ts +1162 -87
- package/dist/schema.d.ts +6066 -4060
- package/package.json +1 -1
package/dist/axios/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
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, CancelAgentExecutionData, CancelAgentExecutionErrors, CancelAgentExecutionResponses, ClearEmbeddingsSettingsData, ClearEmbeddingsSettingsErrors, ClearEmbeddingsSettingsResponses, CompleteAgentExecutionData, CompleteAgentExecutionErrors, CompleteAgentExecutionResponses, CompleteOnboardingData, CompleteOnboardingErrors, CompleteOnboardingResponses, ConfirmRelationData, ConfirmRelationErrors, ConfirmRelationResponses, CreateActivityData, CreateActivityErrors, CreateActivityResponses, CreateAdminUserData, CreateAdminUserErrors, CreateAdminUserResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateApiKeySettingsData, CreateApiKeySettingsErrors, CreateApiKeySettingsResponses, CreateArtifactData, CreateArtifactErrors, CreateArtifactResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateCommentData, CreateCommentErrors, CreateCommentResponses, CreateEmbeddingProviderData, CreateEmbeddingProviderErrors, CreateEmbeddingProviderResponses, CreateEmbeddingProviderSettingsData, CreateEmbeddingProviderSettingsErrors, CreateEmbeddingProviderSettingsResponses, CreateFeedData, CreateFeedErrors, CreateFeedItemData, CreateFeedItemErrors, CreateFeedItemReplyData, CreateFeedItemReplyErrors, CreateFeedItemReplyResponses, CreateFeedItemResponses, CreateFeedResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponses, CreateModelProviderData, CreateModelProviderErrors, CreateModelProviderResponses, CreateModelProviderSettingsData, CreateModelProviderSettingsErrors, CreateModelProviderSettingsResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreatePromptData, CreatePromptErrors, CreatePromptResponses, CreatePromptShareData, CreatePromptShareErrors, CreatePromptShareResponses, CreateRelationData, CreateRelationErrors, CreateRelationResponses, CreateTeamData, CreateTeamErrors, CreateTeamResponses, CreateTypeData, CreateTypeErrors, CreateTypeResponses, DeleteAdminUserData, DeleteAdminUserErrors, DeleteAdminUserResponses, DeleteAgentData, DeleteAgentErrors, DeleteAgentResponses, DeleteApiKeyData, DeleteApiKeyErrors, DeleteApiKeyResponses, DeleteApiKeySettingsData, DeleteApiKeySettingsErrors, DeleteApiKeySettingsResponses, DeleteArtifactAttachmentData, DeleteArtifactAttachmentErrors, DeleteArtifactAttachmentResponses, DeleteArtifactData, DeleteArtifactErrors, DeleteArtifactResponses, DeleteAttachmentData, DeleteAttachmentErrors, DeleteAttachmentResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteClaudeCodeSessionData, DeleteClaudeCodeSessionErrors, DeleteClaudeCodeSessionResponses, DeleteCommentData, DeleteCommentErrors, DeleteCommentResponses, DeleteCursorIdeSessionData, DeleteCursorIdeSessionErrors, DeleteCursorIdeSessionResponses, DeleteDeviceTokenData, DeleteDeviceTokenErrors, DeleteDeviceTokenResponses, DeleteEmbeddingProviderData, DeleteEmbeddingProviderErrors, DeleteEmbeddingProviderResponses, DeleteEmbeddingProviderSettingsData, DeleteEmbeddingProviderSettingsErrors, DeleteEmbeddingProviderSettingsResponses, DeleteFeedData, DeleteFeedErrors, DeleteFeedItemData, DeleteFeedItemErrors, DeleteFeedItemResponses, DeleteFeedResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponses, DeleteModelProviderData, DeleteModelProviderErrors, DeleteModelProviderResponses, DeleteModelProviderSettingsData, DeleteModelProviderSettingsErrors, DeleteModelProviderSettingsResponses, DeleteProjectData, DeleteProjectErrors, DeleteProjectResponses, DeletePromptData, DeletePromptErrors, DeletePromptResponses, DeletePromptShareData, DeletePromptShareErrors, DeletePromptShareResponses, DeleteRelationData, DeleteRelationErrors, DeleteRelationResponses, 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, GetAdminDashboardOverviewData, GetAdminDashboardOverviewErrors, GetAdminDashboardOverviewResponses, GetAdminDashboardTimeseriesData, GetAdminDashboardTimeseriesErrors, GetAdminDashboardTimeseriesResponses, GetAdminProjectData, GetAdminProjectErrors, GetAdminProjectResponses, GetAdminStatsData, GetAdminStatsErrors, GetAdminStatsResponses, GetAdminTeamData, GetAdminTeamErrors, GetAdminTeamResponses, GetAdminUserData, GetAdminUserErrors, GetAdminUserResponses, 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, GetEmbeddingCoverageData, GetEmbeddingCoverageErrors, GetEmbeddingCoverageResponses, GetEmbeddingCoverageSettingsData, GetEmbeddingCoverageSettingsErrors, GetEmbeddingCoverageSettingsResponses, 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, GetModelProviderData, GetModelProviderErrors, GetModelProviderResponses, GetModelProviderSettingsData, GetModelProviderSettingsErrors, GetModelProviderSettingsResponses, 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, GetTeamSearchSettingsData, GetTeamSearchSettingsErrors, GetTeamSearchSettingsResponses, 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, ListAdminProjectsData, ListAdminProjectsErrors, ListAdminProjectsResponses, ListAdminTeamsData, ListAdminTeamsErrors, ListAdminTeamsResponses, ListAdminUsersData, ListAdminUsersErrors, ListAdminUsersResponses, 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, ListAuthProvidersData, ListAuthProvidersErrors, ListAuthProvidersResponses, ListBlueprintVersionsData, ListBlueprintVersionsErrors, ListBlueprintVersionsResponses, ListClaudeCodeHooksData, ListClaudeCodeHooksErrors, ListClaudeCodeHooksResponses, ListClaudeCodeRecentActivitiesData, ListClaudeCodeRecentActivitiesErrors, ListClaudeCodeRecentActivitiesResponses, ListClaudeCodeSessionsData, ListClaudeCodeSessionsErrors, ListClaudeCodeSessionsResponses, ListCommentsData, ListCommentsErrors, ListCommentsResponses, 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, ListModelProvidersData, ListModelProvidersErrors, ListModelProvidersResponses, ListModelProvidersSettingsData, ListModelProvidersSettingsErrors, ListModelProvidersSettingsResponses, ListNotificationsData, ListNotificationsErrors, ListNotificationsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListPromptGalleryPromptsData, ListPromptGalleryPromptsErrors, ListPromptGalleryPromptsResponses, ListPromptsData, ListPromptsErrors, ListPromptsResponses, ListPromptVersionsData, ListPromptVersionsErrors, ListPromptVersionsResponses, ListRecentCommentsData, ListRecentCommentsErrors, ListRecentCommentsResponses, ListRelationsData, ListRelationsErrors, ListRelationsResponses, 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, ReactivateAdminUserData, ReactivateAdminUserErrors, ReactivateAdminUserResponses, RegisterDeviceTokenData, RegisterDeviceTokenErrors, RegisterDeviceTokenResponses, RejectInvitationData, RejectInvitationErrors, RejectInvitationResponses, RemoveTeamMemberData, RemoveTeamMemberErrors, RemoveTeamMemberResponses, RenderPromptData, RenderPromptErrors, RenderPromptResponses, ReprocessEmbeddingProviderData, ReprocessEmbeddingProviderErrors, ReprocessEmbeddingProviderResponses, ReprocessEmbeddingProviderSettingsData, ReprocessEmbeddingProviderSettingsErrors, ReprocessEmbeddingProviderSettingsResponses, ResetTeamSearchSettingsData, ResetTeamSearchSettingsErrors, ResetTeamSearchSettingsResponses, RestoreArtifactVersionData, RestoreArtifactVersionErrors, RestoreArtifactVersionResponses, RestoreBlueprintVersionData, RestoreBlueprintVersionErrors, RestoreBlueprintVersionResponses, RestoreMemoryVersionData, RestoreMemoryVersionErrors, RestoreMemoryVersionResponses, RestorePromptVersionData, RestorePromptVersionErrors, RestorePromptVersionResponses, RevokeTeamInvitationData, RevokeTeamInvitationErrors, RevokeTeamInvitationResponses, SearchMemoriesByMetadataData, SearchMemoriesByMetadataErrors, SearchMemoriesByMetadataResponses, SearchTeamResourcesData, SearchTeamResourcesErrors, SearchTeamResourcesResponses, SeedRelationsData, SeedRelationsErrors, SeedRelationsResponses, SendTeamInvitationsData, SendTeamInvitationsErrors, SendTeamInvitationsResponses, StartAgentExecutionData, StartAgentExecutionErrors, StartAgentExecutionResponses, SubmitSupportRequestData, SubmitSupportRequestErrors, SubmitSupportRequestResponses, SuspendAdminUserData, SuspendAdminUserErrors, SuspendAdminUserResponses, TrackPromptGalleryUsageData, TrackPromptGalleryUsageErrors, TrackPromptGalleryUsageResponses, TransferTeamOwnershipData, TransferTeamOwnershipErrors, TransferTeamOwnershipResponses, UnarchiveFeedItemData, UnarchiveFeedItemErrors, UnarchiveFeedItemResponses, UpdateAdminUserData, UpdateAdminUserErrors, UpdateAdminUserResponses, UpdateAgentCredentialsData, UpdateAgentCredentialsErrors, UpdateAgentCredentialsResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateArtifactData, UpdateArtifactErrors, UpdateArtifactResponses, UpdateBlueprintData, UpdateBlueprintErrors, UpdateBlueprintResponses, UpdateCommentData, UpdateCommentErrors, UpdateCommentResponses, UpdateEmbeddingProviderData, UpdateEmbeddingProviderErrors, UpdateEmbeddingProviderResponses, UpdateEmbeddingProviderSettingsData, UpdateEmbeddingProviderSettingsErrors, UpdateEmbeddingProviderSettingsResponses, UpdateFeedData, UpdateFeedErrors, UpdateFeedResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateModelProviderData, UpdateModelProviderErrors, UpdateModelProviderResponses, UpdateModelProviderSettingsData, UpdateModelProviderSettingsErrors, UpdateModelProviderSettingsResponses, UpdatePreferencesData, UpdatePreferencesErrors, UpdatePreferencesResponses, UpdateProjectData, UpdateProjectErrors, UpdateProjectResponses, UpdatePromptData, UpdatePromptErrors, UpdatePromptResponses, UpdateTeamData, UpdateTeamErrors, UpdateTeamMemberRoleData, UpdateTeamMemberRoleErrors, UpdateTeamMemberRoleResponses, UpdateTeamResponses, UpdateTeamSearchSettingsData, UpdateTeamSearchSettingsErrors, UpdateTeamSearchSettingsResponses, UploadArtifactAttachmentData, UploadArtifactAttachmentErrors, UploadArtifactAttachmentResponses, UploadAttachmentData, UploadAttachmentErrors, UploadAttachmentResponses, ValidateEmbeddingProviderData, ValidateEmbeddingProviderErrors, ValidateEmbeddingProviderResponses, ValidateEmbeddingProviderSettingsData, ValidateEmbeddingProviderSettingsErrors, ValidateEmbeddingProviderSettingsResponses, ValidateModelProviderData, ValidateModelProviderErrors, ValidateModelProviderResponses, ValidateModelProviderSettingsData, ValidateModelProviderSettingsErrors, ValidateModelProviderSettingsResponses } from './types.gen';
|
|
2
|
+
import type { AcceptInvitationData, AcceptInvitationErrors, AcceptInvitationResponses, ArchiveFeedItemData, ArchiveFeedItemErrors, ArchiveFeedItemResponses, AuthCallbackData, AuthCallbackErrors, CancelAgentExecutionData, CancelAgentExecutionErrors, CancelAgentExecutionResponses, ClearEmbeddingsSettingsData, ClearEmbeddingsSettingsErrors, ClearEmbeddingsSettingsResponses, CompleteAgentExecutionData, CompleteAgentExecutionErrors, CompleteAgentExecutionResponses, CompleteOnboardingData, CompleteOnboardingErrors, CompleteOnboardingResponses, ConfirmRelationData, ConfirmRelationErrors, ConfirmRelationResponses, CreateActivityData, CreateActivityErrors, CreateActivityResponses, CreateAdminUserData, CreateAdminUserErrors, CreateAdminUserResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateApiKeySettingsData, CreateApiKeySettingsErrors, CreateApiKeySettingsResponses, CreateArtifactData, CreateArtifactErrors, CreateArtifactResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateCommentData, CreateCommentErrors, CreateCommentResponses, CreateEmbeddingProviderData, CreateEmbeddingProviderErrors, CreateEmbeddingProviderResponses, CreateEmbeddingProviderSettingsData, CreateEmbeddingProviderSettingsErrors, CreateEmbeddingProviderSettingsResponses, CreateFeedData, CreateFeedErrors, CreateFeedItemData, CreateFeedItemErrors, CreateFeedItemReplyData, CreateFeedItemReplyErrors, CreateFeedItemReplyResponses, CreateFeedItemResponses, CreateFeedResponses, CreateGitHubAppConfigData, CreateGitHubAppConfigErrors, CreateGitHubAppConfigResponses, CreateGitHubAppConfigSettingsData, CreateGitHubAppConfigSettingsErrors, CreateGitHubAppConfigSettingsResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponses, CreateModelProviderData, CreateModelProviderErrors, CreateModelProviderResponses, CreateModelProviderSettingsData, CreateModelProviderSettingsErrors, CreateModelProviderSettingsResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreatePromptData, CreatePromptErrors, CreatePromptResponses, CreatePromptShareData, CreatePromptShareErrors, CreatePromptShareResponses, CreateRelationData, CreateRelationErrors, CreateRelationResponses, CreateTeamData, CreateTeamErrors, CreateTeamResponses, CreateTypeData, CreateTypeErrors, CreateTypeResponses, DeleteAdminUserData, DeleteAdminUserErrors, DeleteAdminUserResponses, DeleteAgentData, DeleteAgentErrors, DeleteAgentResponses, DeleteApiKeyData, DeleteApiKeyErrors, DeleteApiKeyResponses, DeleteApiKeySettingsData, DeleteApiKeySettingsErrors, DeleteApiKeySettingsResponses, DeleteArtifactAttachmentData, DeleteArtifactAttachmentErrors, DeleteArtifactAttachmentResponses, DeleteArtifactData, DeleteArtifactErrors, DeleteArtifactResponses, DeleteAttachmentData, DeleteAttachmentErrors, DeleteAttachmentResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteClaudeCodeSessionData, DeleteClaudeCodeSessionErrors, DeleteClaudeCodeSessionResponses, DeleteCommentData, DeleteCommentErrors, DeleteCommentResponses, DeleteCursorIdeSessionData, DeleteCursorIdeSessionErrors, DeleteCursorIdeSessionResponses, DeleteDeviceTokenData, DeleteDeviceTokenErrors, DeleteDeviceTokenResponses, DeleteEmbeddingProviderData, DeleteEmbeddingProviderErrors, DeleteEmbeddingProviderResponses, DeleteEmbeddingProviderSettingsData, DeleteEmbeddingProviderSettingsErrors, DeleteEmbeddingProviderSettingsResponses, DeleteFeedData, DeleteFeedErrors, DeleteFeedItemData, DeleteFeedItemErrors, DeleteFeedItemResponses, DeleteFeedResponses, DeleteGitHubAppConfigData, DeleteGitHubAppConfigErrors, DeleteGitHubAppConfigResponses, DeleteGitHubAppConfigSettingsData, DeleteGitHubAppConfigSettingsErrors, DeleteGitHubAppConfigSettingsResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponses, DeleteModelProviderData, DeleteModelProviderErrors, DeleteModelProviderResponses, DeleteModelProviderSettingsData, DeleteModelProviderSettingsErrors, DeleteModelProviderSettingsResponses, DeleteProjectData, DeleteProjectErrors, DeleteProjectResponses, DeletePromptData, DeletePromptErrors, DeletePromptResponses, DeletePromptShareData, DeletePromptShareErrors, DeletePromptShareResponses, DeleteRelationData, DeleteRelationErrors, DeleteRelationResponses, DeleteTeamData, DeleteTeamEmailProviderData, DeleteTeamEmailProviderErrors, DeleteTeamEmailProviderResponses, DeleteTeamEmailProviderSettingsData, DeleteTeamEmailProviderSettingsErrors, DeleteTeamEmailProviderSettingsResponses, 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, GetAdminDashboardOverviewData, GetAdminDashboardOverviewErrors, GetAdminDashboardOverviewResponses, GetAdminDashboardTimeseriesData, GetAdminDashboardTimeseriesErrors, GetAdminDashboardTimeseriesResponses, GetAdminProjectData, GetAdminProjectErrors, GetAdminProjectResponses, GetAdminStatsData, GetAdminStatsErrors, GetAdminStatsResponses, GetAdminTeamData, GetAdminTeamErrors, GetAdminTeamResponses, GetAdminUserData, GetAdminUserErrors, GetAdminUserResponses, 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, GetEmbeddingCoverageData, GetEmbeddingCoverageErrors, GetEmbeddingCoverageResponses, GetEmbeddingCoverageSettingsData, GetEmbeddingCoverageSettingsErrors, GetEmbeddingCoverageSettingsResponses, GetEmbeddingProviderData, GetEmbeddingProviderErrors, GetEmbeddingProviderResponses, GetEmbeddingProviderSettingsData, GetEmbeddingProviderSettingsErrors, GetEmbeddingProviderSettingsResponses, GetFeedData, GetFeedErrors, GetFeedItemData, GetFeedItemErrors, GetFeedItemResponses, GetFeedResponses, GetGitHubAppConfigData, GetGitHubAppConfigErrors, GetGitHubAppConfigResponses, GetGitHubAppConfigSettingsData, GetGitHubAppConfigSettingsErrors, GetGitHubAppConfigSettingsResponses, GetGitHubInstallUrlData, GetGitHubInstallUrlErrors, GetGitHubInstallUrlResponses, GetGitHubStatusData, GetGitHubStatusErrors, GetGitHubStatusResponses, GetInvitationByTokenData, GetInvitationByTokenErrors, GetInvitationByTokenResponses, GetMeData, GetMeErrors, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetMemoryVersionData, GetMemoryVersionErrors, GetMemoryVersionResponses, GetMeResponses, GetMetadataKeysData, GetMetadataKeysErrors, GetMetadataKeysResponses, GetMetadataValuesData, GetMetadataValuesErrors, GetMetadataValuesResponses, GetModelProviderData, GetModelProviderErrors, GetModelProviderResponses, GetModelProviderSettingsData, GetModelProviderSettingsErrors, GetModelProviderSettingsResponses, 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, GetTeamEmailProviderData, GetTeamEmailProviderErrors, GetTeamEmailProviderResponses, GetTeamEmailProviderSettingsData, GetTeamEmailProviderSettingsErrors, GetTeamEmailProviderSettingsResponses, GetTeamErrors, GetTeamFeedCreationMetricsData, GetTeamFeedCreationMetricsErrors, GetTeamFeedCreationMetricsResponses, GetTeamMembersData, GetTeamMembersErrors, GetTeamMembersResponses, GetTeamResourceAccessMetricsData, GetTeamResourceAccessMetricsErrors, GetTeamResourceAccessMetricsResponses, GetTeamResourceCreationMetricsData, GetTeamResourceCreationMetricsErrors, GetTeamResourceCreationMetricsResponses, GetTeamResponses, GetTeamSearchSettingsData, GetTeamSearchSettingsErrors, GetTeamSearchSettingsResponses, GetTeamStatsData, GetTeamStatsErrors, GetTeamStatsResponses, GetTeamTopAccessedResourcesData, GetTeamTopAccessedResourcesErrors, GetTeamTopAccessedResourcesResponses, GetUnreadNotificationCountData, GetUnreadNotificationCountErrors, GetUnreadNotificationCountResponses, GetUsageAndGrowthData, GetUsageAndGrowthErrors, GetUsageAndGrowthResponses, HandleGitHubCallbackData, HandleGitHubCallbackErrors, HandleGitHubCallbackResponses, HandleGitHubWebhookByTokenData, HandleGitHubWebhookByTokenErrors, HandleGitHubWebhookByTokenResponses, HandleGitHubWebhookData, HandleGitHubWebhookErrors, HealthData, HealthResponses, ImportGitHubBlueprintsData, ImportGitHubBlueprintsErrors, ImportGitHubBlueprintsResponses, ImportGitHubProjectData, ImportGitHubProjectErrors, ImportGitHubProjectResponses, IngestClaudeCodeHookData, IngestClaudeCodeHookErrors, IngestClaudeCodeHookResponses, IngestCursorIdeHookData, IngestCursorIdeHookErrors, IngestCursorIdeHookResponses, ListActivitiesData, ListActivitiesErrors, ListActivitiesResponses, ListAdminProjectsData, ListAdminProjectsErrors, ListAdminProjectsResponses, ListAdminTeamsData, ListAdminTeamsErrors, ListAdminTeamsResponses, ListAdminUsersData, ListAdminUsersErrors, ListAdminUsersResponses, 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, ListAuthProvidersData, ListAuthProvidersErrors, ListAuthProvidersResponses, ListBlueprintVersionsData, ListBlueprintVersionsErrors, ListBlueprintVersionsResponses, ListClaudeCodeHooksData, ListClaudeCodeHooksErrors, ListClaudeCodeHooksResponses, ListClaudeCodeRecentActivitiesData, ListClaudeCodeRecentActivitiesErrors, ListClaudeCodeRecentActivitiesResponses, ListClaudeCodeSessionsData, ListClaudeCodeSessionsErrors, ListClaudeCodeSessionsResponses, ListCommentsData, ListCommentsErrors, ListCommentsResponses, 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, ListModelProvidersData, ListModelProvidersErrors, ListModelProvidersResponses, ListModelProvidersSettingsData, ListModelProvidersSettingsErrors, ListModelProvidersSettingsResponses, ListNotificationsData, ListNotificationsErrors, ListNotificationsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListPromptGalleryPromptsData, ListPromptGalleryPromptsErrors, ListPromptGalleryPromptsResponses, ListPromptsData, ListPromptsErrors, ListPromptsResponses, ListPromptVersionsData, ListPromptVersionsErrors, ListPromptVersionsResponses, ListRecentCommentsData, ListRecentCommentsErrors, ListRecentCommentsResponses, ListRelationsData, ListRelationsErrors, ListRelationsResponses, 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, ReactivateAdminUserData, ReactivateAdminUserErrors, ReactivateAdminUserResponses, RegisterDeviceTokenData, RegisterDeviceTokenErrors, RegisterDeviceTokenResponses, RejectInvitationData, RejectInvitationErrors, RejectInvitationResponses, RemoveTeamMemberData, RemoveTeamMemberErrors, RemoveTeamMemberResponses, RenderPromptData, RenderPromptErrors, RenderPromptResponses, ReprocessEmbeddingProviderData, ReprocessEmbeddingProviderErrors, ReprocessEmbeddingProviderResponses, ReprocessEmbeddingProviderSettingsData, ReprocessEmbeddingProviderSettingsErrors, ReprocessEmbeddingProviderSettingsResponses, ResetTeamSearchSettingsData, ResetTeamSearchSettingsErrors, ResetTeamSearchSettingsResponses, RestoreArtifactVersionData, RestoreArtifactVersionErrors, RestoreArtifactVersionResponses, RestoreBlueprintVersionData, RestoreBlueprintVersionErrors, RestoreBlueprintVersionResponses, RestoreMemoryVersionData, RestoreMemoryVersionErrors, RestoreMemoryVersionResponses, RestorePromptVersionData, RestorePromptVersionErrors, RestorePromptVersionResponses, RevokeTeamInvitationData, RevokeTeamInvitationErrors, RevokeTeamInvitationResponses, RotateGitHubAppWebhookTokenData, RotateGitHubAppWebhookTokenErrors, RotateGitHubAppWebhookTokenResponses, RotateGitHubAppWebhookTokenSettingsData, RotateGitHubAppWebhookTokenSettingsErrors, RotateGitHubAppWebhookTokenSettingsResponses, SearchTeamResourcesData, SearchTeamResourcesErrors, SearchTeamResourcesResponses, SeedRelationsData, SeedRelationsErrors, SeedRelationsResponses, SendTeamInvitationsData, SendTeamInvitationsErrors, SendTeamInvitationsResponses, StartAgentExecutionData, StartAgentExecutionErrors, StartAgentExecutionResponses, SubmitSupportRequestData, SubmitSupportRequestErrors, SubmitSupportRequestResponses, SuspendAdminUserData, SuspendAdminUserErrors, SuspendAdminUserResponses, TestTeamEmailProviderData, TestTeamEmailProviderErrors, TestTeamEmailProviderResponses, TestTeamEmailProviderSettingsData, TestTeamEmailProviderSettingsErrors, TestTeamEmailProviderSettingsResponses, TrackPromptGalleryUsageData, TrackPromptGalleryUsageErrors, TrackPromptGalleryUsageResponses, TransferTeamOwnershipData, TransferTeamOwnershipErrors, TransferTeamOwnershipResponses, UnarchiveFeedItemData, UnarchiveFeedItemErrors, UnarchiveFeedItemResponses, UpdateAdminUserData, UpdateAdminUserErrors, UpdateAdminUserResponses, UpdateAgentCredentialsData, UpdateAgentCredentialsErrors, UpdateAgentCredentialsResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateArtifactData, UpdateArtifactErrors, UpdateArtifactResponses, UpdateBlueprintData, UpdateBlueprintErrors, UpdateBlueprintResponses, UpdateCommentData, UpdateCommentErrors, UpdateCommentResponses, UpdateEmbeddingProviderData, UpdateEmbeddingProviderErrors, UpdateEmbeddingProviderResponses, UpdateEmbeddingProviderSettingsData, UpdateEmbeddingProviderSettingsErrors, UpdateEmbeddingProviderSettingsResponses, UpdateFeedData, UpdateFeedErrors, UpdateFeedResponses, UpdateGitHubAppConfigData, UpdateGitHubAppConfigErrors, UpdateGitHubAppConfigResponses, UpdateGitHubAppConfigSettingsData, UpdateGitHubAppConfigSettingsErrors, UpdateGitHubAppConfigSettingsResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateModelProviderData, UpdateModelProviderErrors, UpdateModelProviderResponses, UpdateModelProviderSettingsData, UpdateModelProviderSettingsErrors, UpdateModelProviderSettingsResponses, UpdatePreferencesData, UpdatePreferencesErrors, UpdatePreferencesResponses, UpdateProjectData, UpdateProjectErrors, UpdateProjectResponses, UpdatePromptData, UpdatePromptErrors, UpdatePromptResponses, UpdateTeamData, UpdateTeamErrors, UpdateTeamMemberRoleData, UpdateTeamMemberRoleErrors, UpdateTeamMemberRoleResponses, UpdateTeamResponses, UpdateTeamSearchSettingsData, UpdateTeamSearchSettingsErrors, UpdateTeamSearchSettingsResponses, UploadArtifactAttachmentData, UploadArtifactAttachmentErrors, UploadArtifactAttachmentResponses, UploadAttachmentData, UploadAttachmentErrors, UploadAttachmentResponses, UpsertTeamEmailProviderData, UpsertTeamEmailProviderErrors, UpsertTeamEmailProviderResponses, UpsertTeamEmailProviderSettingsData, UpsertTeamEmailProviderSettingsErrors, UpsertTeamEmailProviderSettingsResponses, ValidateEmbeddingProviderData, ValidateEmbeddingProviderErrors, ValidateEmbeddingProviderResponses, ValidateEmbeddingProviderSettingsData, ValidateEmbeddingProviderSettingsErrors, ValidateEmbeddingProviderSettingsResponses, ValidateGitHubAppConfigData, ValidateGitHubAppConfigErrors, ValidateGitHubAppConfigResponses, ValidateGitHubAppConfigSettingsData, ValidateGitHubAppConfigSettingsErrors, ValidateGitHubAppConfigSettingsResponses, ValidateModelProviderData, ValidateModelProviderErrors, ValidateModelProviderResponses, ValidateModelProviderSettingsData, ValidateModelProviderSettingsErrors, ValidateModelProviderSettingsResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -281,12 +281,6 @@ export declare const listMemories: <ThrowOnError extends boolean = false>(option
|
|
|
281
281
|
* Creates a new memory for the authenticated user within the specified team
|
|
282
282
|
*/
|
|
283
283
|
export declare const createMemory: <ThrowOnError extends boolean = false>(options: Options<CreateMemoryData, ThrowOnError>) => RequestResult<CreateMemoryResponses, CreateMemoryErrors, ThrowOnError>;
|
|
284
|
-
/**
|
|
285
|
-
* Search memories by metadata
|
|
286
|
-
*
|
|
287
|
-
* Searches memories by specific metadata key-value pairs within the specified team
|
|
288
|
-
*/
|
|
289
|
-
export declare const searchMemoriesByMetadata: <ThrowOnError extends boolean = false>(options: Options<SearchMemoriesByMetadataData, ThrowOnError>) => RequestResult<SearchMemoriesByMetadataResponses, SearchMemoriesByMetadataErrors, ThrowOnError>;
|
|
290
284
|
/**
|
|
291
285
|
* Delete memory by ID
|
|
292
286
|
*
|
|
@@ -338,7 +332,7 @@ export declare const getProjectResourceCreationMetrics: <ThrowOnError extends bo
|
|
|
338
332
|
/**
|
|
339
333
|
* List spec libraries
|
|
340
334
|
*
|
|
341
|
-
* Retrieves all spec libraries for the authenticated user with optional filtering and pagination.
|
|
335
|
+
* Retrieves all spec libraries for the authenticated user with optional filtering and pagination. Use the `metadata` parameter to filter on metadata; the undocumented `metadata_<key>` prefix convention is deprecated and will be removed.
|
|
342
336
|
*/
|
|
343
337
|
export declare const listSpecLibraries: <ThrowOnError extends boolean = false>(options: Options<ListSpecLibrariesData, ThrowOnError>) => RequestResult<ListSpecLibrariesResponses, ListSpecLibrariesErrors, ThrowOnError>;
|
|
344
338
|
/**
|
|
@@ -356,7 +350,7 @@ export declare const getBlueprintStats: <ThrowOnError extends boolean = false>(o
|
|
|
356
350
|
/**
|
|
357
351
|
* List spec libraries by project
|
|
358
352
|
*
|
|
359
|
-
* Retrieves spec libraries for a specific project with optional filtering.
|
|
353
|
+
* Retrieves spec libraries for a specific project with optional filtering. Use the `metadata` parameter to filter on metadata; the undocumented `metadata_<key>` prefix convention is deprecated and will be removed.
|
|
360
354
|
*/
|
|
361
355
|
export declare const listSpecLibrariesByProject: <ThrowOnError extends boolean = false>(options: Options<ListSpecLibrariesByProjectData, ThrowOnError>) => RequestResult<ListSpecLibrariesByProjectResponses, ListSpecLibrariesByProjectErrors, ThrowOnError>;
|
|
362
356
|
/**
|
|
@@ -615,14 +609,37 @@ export declare const importGitHubBlueprints: <ThrowOnError extends boolean = fal
|
|
|
615
609
|
*/
|
|
616
610
|
export declare const disconnectGitHub: <ThrowOnError extends boolean = false>(options: Options<DisconnectGitHubData, ThrowOnError>) => RequestResult<DisconnectGitHubResponses, DisconnectGitHubErrors, ThrowOnError>;
|
|
617
611
|
/**
|
|
618
|
-
*
|
|
612
|
+
* Retired — use the per-App webhook URL
|
|
613
|
+
*
|
|
614
|
+
* **Retired (410 Gone).** This endpoint verified deliveries against a single
|
|
615
|
+
* instance-wide webhook secret. Each team now registers its own GitHub App
|
|
616
|
+
* with its own secret, so there is no single secret left to verify against
|
|
617
|
+
* and this path cannot be made to work.
|
|
618
|
+
*
|
|
619
|
+
* Each team's webhook URL is shown in its GitHub App settings; update it on
|
|
620
|
+
* GitHub. This path is kept for a release or two so misdirected deliveries
|
|
621
|
+
* get an explanation rather than a signature error.
|
|
622
|
+
*
|
|
623
|
+
*/
|
|
624
|
+
export declare const handleGitHubWebhook: <ThrowOnError extends boolean = false>(options: Options<HandleGitHubWebhookData, ThrowOnError>) => RequestResult<unknown, HandleGitHubWebhookErrors, ThrowOnError>;
|
|
625
|
+
/**
|
|
626
|
+
* Handle a GitHub webhook delivery for one team's App
|
|
619
627
|
*
|
|
620
|
-
* Receives
|
|
621
|
-
*
|
|
622
|
-
*
|
|
628
|
+
* Receives a GitHub webhook delivery for the App identified by the routing
|
|
629
|
+
* token in the path. Each team registers its own GitHub App with its own
|
|
630
|
+
* webhook secret, so the token is what selects which secret the
|
|
631
|
+
* `X-Hub-Signature-256` HMAC is verified against.
|
|
632
|
+
*
|
|
633
|
+
* Public and unauthenticated by necessity — GitHub posts with no session.
|
|
634
|
+
* The token routes the delivery; the webhook secret authenticates it. The
|
|
635
|
+
* payload is not parsed until the signature verifies, so no attacker-supplied
|
|
636
|
+
* byte influences which key it is checked with.
|
|
637
|
+
*
|
|
638
|
+
* An unknown or malformed token returns 404 with no detail, so the endpoint
|
|
639
|
+
* cannot be used to discover which tokens exist.
|
|
623
640
|
*
|
|
624
641
|
*/
|
|
625
|
-
export declare const
|
|
642
|
+
export declare const handleGitHubWebhookByToken: <ThrowOnError extends boolean = false>(options: Options<HandleGitHubWebhookByTokenData, ThrowOnError>) => RequestResult<HandleGitHubWebhookByTokenResponses, HandleGitHubWebhookByTokenErrors, ThrowOnError>;
|
|
626
643
|
/**
|
|
627
644
|
* List feeds
|
|
628
645
|
*
|
|
@@ -1493,6 +1510,18 @@ export declare const reprocessEmbeddingProvider: <ThrowOnError extends boolean =
|
|
|
1493
1510
|
*
|
|
1494
1511
|
*/
|
|
1495
1512
|
export declare const validateEmbeddingProvider: <ThrowOnError extends boolean = false>(options: Options<ValidateEmbeddingProviderData, ThrowOnError>) => RequestResult<ValidateEmbeddingProviderResponses, ValidateEmbeddingProviderErrors, ThrowOnError>;
|
|
1513
|
+
/**
|
|
1514
|
+
* List the metadata keys in use
|
|
1515
|
+
*
|
|
1516
|
+
* Returns the distinct metadata keys present on the caller's rows of the requested resource type, optionally narrowed to a single project. Use it to populate the key side of a metadata filter.
|
|
1517
|
+
*/
|
|
1518
|
+
export declare const getMetadataKeys: <ThrowOnError extends boolean = false>(options: Options<GetMetadataKeysData, ThrowOnError>) => RequestResult<GetMetadataKeysResponses, GetMetadataKeysErrors, ThrowOnError>;
|
|
1519
|
+
/**
|
|
1520
|
+
* List the values stored under a metadata key
|
|
1521
|
+
*
|
|
1522
|
+
* Returns the distinct values stored under one metadata key on the caller's rows of the requested resource type. Values held in an array are flattened and non-string scalars are rendered in their text form, so the result is directly usable as filter input. Supply `q` for typeahead.
|
|
1523
|
+
*/
|
|
1524
|
+
export declare const getMetadataValues: <ThrowOnError extends boolean = false>(options: Options<GetMetadataValuesData, ThrowOnError>) => RequestResult<GetMetadataValuesResponses, GetMetadataValuesErrors, ThrowOnError>;
|
|
1496
1525
|
/**
|
|
1497
1526
|
* Reset the team's search ranking settings to the instance defaults
|
|
1498
1527
|
*
|
|
@@ -1608,6 +1637,278 @@ export declare const validateEmbeddingProviderSettings: <ThrowOnError extends bo
|
|
|
1608
1637
|
*
|
|
1609
1638
|
*/
|
|
1610
1639
|
export declare const clearEmbeddingsSettings: <ThrowOnError extends boolean = false>(options: Options<ClearEmbeddingsSettingsData, ThrowOnError>) => RequestResult<ClearEmbeddingsSettingsResponses, ClearEmbeddingsSettingsErrors, ThrowOnError>;
|
|
1640
|
+
/**
|
|
1641
|
+
* Delete the team's GitHub App configuration
|
|
1642
|
+
*
|
|
1643
|
+
* Removes the team's GitHub App registration. This also disconnects every
|
|
1644
|
+
* installation made through that App, since installations are meaningful
|
|
1645
|
+
* only in the context of the App they were installed from.
|
|
1646
|
+
*
|
|
1647
|
+
*/
|
|
1648
|
+
export declare const deleteGitHubAppConfig: <ThrowOnError extends boolean = false>(options: Options<DeleteGitHubAppConfigData, ThrowOnError>) => RequestResult<DeleteGitHubAppConfigResponses, DeleteGitHubAppConfigErrors, ThrowOnError>;
|
|
1649
|
+
/**
|
|
1650
|
+
* Get the team's GitHub App configuration
|
|
1651
|
+
*
|
|
1652
|
+
* Returns the team's GitHub App registration. Secrets are never included —
|
|
1653
|
+
* the response carries `has_private_key`, `has_client_secret` and
|
|
1654
|
+
* `has_webhook_secret` booleans plus the `webhook_url` to paste into GitHub.
|
|
1655
|
+
*
|
|
1656
|
+
*/
|
|
1657
|
+
export declare const getGitHubAppConfig: <ThrowOnError extends boolean = false>(options: Options<GetGitHubAppConfigData, ThrowOnError>) => RequestResult<GetGitHubAppConfigResponses, GetGitHubAppConfigErrors, ThrowOnError>;
|
|
1658
|
+
/**
|
|
1659
|
+
* Register the team's GitHub App
|
|
1660
|
+
*
|
|
1661
|
+
* Registers a GitHub App for the team. The `private_key` and `client_secret`
|
|
1662
|
+
* are encrypted at rest and are never returned.
|
|
1663
|
+
*
|
|
1664
|
+
* The webhook secret is **generated by the server**, not supplied by the
|
|
1665
|
+
* caller, and is returned in this response **once only**. It cannot be read
|
|
1666
|
+
* back afterwards; a lost secret must be rotated. Returns 200 (not 201),
|
|
1667
|
+
* matching the provider convention.
|
|
1668
|
+
*
|
|
1669
|
+
*/
|
|
1670
|
+
export declare const createGitHubAppConfig: <ThrowOnError extends boolean = false>(options: Options<CreateGitHubAppConfigData, ThrowOnError>) => RequestResult<CreateGitHubAppConfigResponses, CreateGitHubAppConfigErrors, ThrowOnError>;
|
|
1671
|
+
/**
|
|
1672
|
+
* Update the team's GitHub App configuration
|
|
1673
|
+
*
|
|
1674
|
+
* Updates the team's GitHub App registration. Every field is optional: an
|
|
1675
|
+
* omitted field keeps the stored value, and an explicitly empty value is
|
|
1676
|
+
* rejected rather than clearing the stored one. Secrets are never returned.
|
|
1677
|
+
*
|
|
1678
|
+
* The webhook secret cannot be set here — it is server-generated and
|
|
1679
|
+
* replaced through rotation.
|
|
1680
|
+
*
|
|
1681
|
+
*/
|
|
1682
|
+
export declare const updateGitHubAppConfig: <ThrowOnError extends boolean = false>(options: Options<UpdateGitHubAppConfigData, ThrowOnError>) => RequestResult<UpdateGitHubAppConfigResponses, UpdateGitHubAppConfigErrors, ThrowOnError>;
|
|
1683
|
+
/**
|
|
1684
|
+
* Validate the team's GitHub App configuration
|
|
1685
|
+
*
|
|
1686
|
+
* Probes GitHub with the stored credentials and reports whether they work.
|
|
1687
|
+
* This proves the private key belongs to the configured `app_id`, that the
|
|
1688
|
+
* stored slug matches what GitHub reports (a typo there would otherwise
|
|
1689
|
+
* produce a broken install URL), and which permissions the App holds.
|
|
1690
|
+
*
|
|
1691
|
+
* A failed probe is reported in the body with `is_valid: false`, not as an
|
|
1692
|
+
* HTTP error. `error_details` is always one of a fixed set of categories;
|
|
1693
|
+
* the real upstream error is logged server-side only.
|
|
1694
|
+
*
|
|
1695
|
+
* Authorized as a mutation, because it makes the server perform an
|
|
1696
|
+
* authenticated outbound call on the team's behalf.
|
|
1697
|
+
*
|
|
1698
|
+
*/
|
|
1699
|
+
export declare const validateGitHubAppConfig: <ThrowOnError extends boolean = false>(options: Options<ValidateGitHubAppConfigData, ThrowOnError>) => RequestResult<ValidateGitHubAppConfigResponses, ValidateGitHubAppConfigErrors, ThrowOnError>;
|
|
1700
|
+
/**
|
|
1701
|
+
* Rotate the GitHub App webhook token
|
|
1702
|
+
*
|
|
1703
|
+
* Mints a new opaque routing token, which changes the App's `webhook_url`.
|
|
1704
|
+
* The previous URL stops resolving immediately, so the new one must be
|
|
1705
|
+
* pasted into the App's settings on GitHub or deliveries will stop.
|
|
1706
|
+
*
|
|
1707
|
+
* This rotates the routing token only, not the webhook secret.
|
|
1708
|
+
*
|
|
1709
|
+
*/
|
|
1710
|
+
export declare const rotateGitHubAppWebhookToken: <ThrowOnError extends boolean = false>(options: Options<RotateGitHubAppWebhookTokenData, ThrowOnError>) => RequestResult<RotateGitHubAppWebhookTokenResponses, RotateGitHubAppWebhookTokenErrors, ThrowOnError>;
|
|
1711
|
+
/**
|
|
1712
|
+
* Delete the team's GitHub App configuration
|
|
1713
|
+
*
|
|
1714
|
+
* Removes the team's GitHub App registration. This also disconnects every
|
|
1715
|
+
* installation made through that App, since installations are meaningful
|
|
1716
|
+
* only in the context of the App they were installed from.
|
|
1717
|
+
*
|
|
1718
|
+
*/
|
|
1719
|
+
export declare const deleteGitHubAppConfigSettings: <ThrowOnError extends boolean = false>(options: Options<DeleteGitHubAppConfigSettingsData, ThrowOnError>) => RequestResult<DeleteGitHubAppConfigSettingsResponses, DeleteGitHubAppConfigSettingsErrors, ThrowOnError>;
|
|
1720
|
+
/**
|
|
1721
|
+
* Get the team's GitHub App configuration
|
|
1722
|
+
*
|
|
1723
|
+
* Returns the team's GitHub App registration. Secrets are never included —
|
|
1724
|
+
* the response carries `has_private_key`, `has_client_secret` and
|
|
1725
|
+
* `has_webhook_secret` booleans plus the `webhook_url` to paste into GitHub.
|
|
1726
|
+
*
|
|
1727
|
+
*/
|
|
1728
|
+
export declare const getGitHubAppConfigSettings: <ThrowOnError extends boolean = false>(options: Options<GetGitHubAppConfigSettingsData, ThrowOnError>) => RequestResult<GetGitHubAppConfigSettingsResponses, GetGitHubAppConfigSettingsErrors, ThrowOnError>;
|
|
1729
|
+
/**
|
|
1730
|
+
* Register the team's GitHub App
|
|
1731
|
+
*
|
|
1732
|
+
* Registers a GitHub App for the team. The `private_key` and `client_secret`
|
|
1733
|
+
* are encrypted at rest and are never returned.
|
|
1734
|
+
*
|
|
1735
|
+
* The webhook secret is **generated by the server**, not supplied by the
|
|
1736
|
+
* caller, and is returned in this response **once only**. It cannot be read
|
|
1737
|
+
* back afterwards; a lost secret must be rotated. Returns 200 (not 201),
|
|
1738
|
+
* matching the provider convention.
|
|
1739
|
+
*
|
|
1740
|
+
*/
|
|
1741
|
+
export declare const createGitHubAppConfigSettings: <ThrowOnError extends boolean = false>(options: Options<CreateGitHubAppConfigSettingsData, ThrowOnError>) => RequestResult<CreateGitHubAppConfigSettingsResponses, CreateGitHubAppConfigSettingsErrors, ThrowOnError>;
|
|
1742
|
+
/**
|
|
1743
|
+
* Update the team's GitHub App configuration
|
|
1744
|
+
*
|
|
1745
|
+
* Updates the team's GitHub App registration. Every field is optional: an
|
|
1746
|
+
* omitted field keeps the stored value, and an explicitly empty value is
|
|
1747
|
+
* rejected rather than clearing the stored one. Secrets are never returned.
|
|
1748
|
+
*
|
|
1749
|
+
* The webhook secret cannot be set here — it is server-generated and
|
|
1750
|
+
* replaced through rotation.
|
|
1751
|
+
*
|
|
1752
|
+
*/
|
|
1753
|
+
export declare const updateGitHubAppConfigSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateGitHubAppConfigSettingsData, ThrowOnError>) => RequestResult<UpdateGitHubAppConfigSettingsResponses, UpdateGitHubAppConfigSettingsErrors, ThrowOnError>;
|
|
1754
|
+
/**
|
|
1755
|
+
* Validate the team's GitHub App configuration
|
|
1756
|
+
*
|
|
1757
|
+
* Probes GitHub with the stored credentials and reports whether they work.
|
|
1758
|
+
* This proves the private key belongs to the configured `app_id`, that the
|
|
1759
|
+
* stored slug matches what GitHub reports (a typo there would otherwise
|
|
1760
|
+
* produce a broken install URL), and which permissions the App holds.
|
|
1761
|
+
*
|
|
1762
|
+
* A failed probe is reported in the body with `is_valid: false`, not as an
|
|
1763
|
+
* HTTP error. `error_details` is always one of a fixed set of categories;
|
|
1764
|
+
* the real upstream error is logged server-side only.
|
|
1765
|
+
*
|
|
1766
|
+
* Authorized as a mutation, because it makes the server perform an
|
|
1767
|
+
* authenticated outbound call on the team's behalf.
|
|
1768
|
+
*
|
|
1769
|
+
*/
|
|
1770
|
+
export declare const validateGitHubAppConfigSettings: <ThrowOnError extends boolean = false>(options: Options<ValidateGitHubAppConfigSettingsData, ThrowOnError>) => RequestResult<ValidateGitHubAppConfigSettingsResponses, ValidateGitHubAppConfigSettingsErrors, ThrowOnError>;
|
|
1771
|
+
/**
|
|
1772
|
+
* Rotate the GitHub App webhook token
|
|
1773
|
+
*
|
|
1774
|
+
* Mints a new opaque routing token, which changes the App's `webhook_url`.
|
|
1775
|
+
* The previous URL stops resolving immediately, so the new one must be
|
|
1776
|
+
* pasted into the App's settings on GitHub or deliveries will stop.
|
|
1777
|
+
*
|
|
1778
|
+
* This rotates the routing token only, not the webhook secret.
|
|
1779
|
+
*
|
|
1780
|
+
*/
|
|
1781
|
+
export declare const rotateGitHubAppWebhookTokenSettings: <ThrowOnError extends boolean = false>(options: Options<RotateGitHubAppWebhookTokenSettingsData, ThrowOnError>) => RequestResult<RotateGitHubAppWebhookTokenSettingsResponses, RotateGitHubAppWebhookTokenSettingsErrors, ThrowOnError>;
|
|
1782
|
+
/**
|
|
1783
|
+
* Remove the team's email provider
|
|
1784
|
+
*
|
|
1785
|
+
* Deletes the team's provider, so the team reverts to the instance provider.
|
|
1786
|
+
* A subsequent GET reports `source: "instance"`.
|
|
1787
|
+
*
|
|
1788
|
+
* Deleting when the team has no provider of its own returns 409 rather than
|
|
1789
|
+
* 404: the endpoint exists and the team is addressable, it is simply not in a
|
|
1790
|
+
* state that can serve the request.
|
|
1791
|
+
*
|
|
1792
|
+
*/
|
|
1793
|
+
export declare const deleteTeamEmailProvider: <ThrowOnError extends boolean = false>(options: Options<DeleteTeamEmailProviderData, ThrowOnError>) => RequestResult<DeleteTeamEmailProviderResponses, DeleteTeamEmailProviderErrors, ThrowOnError>;
|
|
1794
|
+
/**
|
|
1795
|
+
* Get the team's effective email configuration
|
|
1796
|
+
*
|
|
1797
|
+
* Returns the email configuration in force for the team.
|
|
1798
|
+
*
|
|
1799
|
+
* This **always returns 200**, never 404. A team without its own provider is
|
|
1800
|
+
* inheriting the instance provider, which is a valid state the caller needs
|
|
1801
|
+
* described — it reports `configured: false`, `source: "instance"` and the
|
|
1802
|
+
* instance's `effective_from_address`.
|
|
1803
|
+
*
|
|
1804
|
+
* Readable by any team member: the response carries no credential, and
|
|
1805
|
+
* `effective_from_address` is already in the From: header of every mail those
|
|
1806
|
+
* members receive.
|
|
1807
|
+
*
|
|
1808
|
+
*/
|
|
1809
|
+
export declare const getTeamEmailProvider: <ThrowOnError extends boolean = false>(options: Options<GetTeamEmailProviderData, ThrowOnError>) => RequestResult<GetTeamEmailProviderResponses, GetTeamEmailProviderErrors, ThrowOnError>;
|
|
1810
|
+
/**
|
|
1811
|
+
* Configure the team's email provider
|
|
1812
|
+
*
|
|
1813
|
+
* Creates or replaces the team's email provider. Idempotent: the same body
|
|
1814
|
+
* applied twice leaves one row and returns 200 both times.
|
|
1815
|
+
*
|
|
1816
|
+
* `secret` is required the first time. On a team that already has a provider,
|
|
1817
|
+
* omit it to keep the stored credential; sending an empty string is rejected
|
|
1818
|
+
* rather than treated as "clear", because a provider without a credential
|
|
1819
|
+
* cannot send and silently disabling a team's mail is worse than an error.
|
|
1820
|
+
*
|
|
1821
|
+
* A team-supplied `settings.smtp.host` or `settings.mailgun.base_url` that
|
|
1822
|
+
* resolves into a reserved network range is rejected before anything is
|
|
1823
|
+
* stored or dialled.
|
|
1824
|
+
*
|
|
1825
|
+
*/
|
|
1826
|
+
export declare const upsertTeamEmailProvider: <ThrowOnError extends boolean = false>(options: Options<UpsertTeamEmailProviderData, ThrowOnError>) => RequestResult<UpsertTeamEmailProviderResponses, UpsertTeamEmailProviderErrors, ThrowOnError>;
|
|
1827
|
+
/**
|
|
1828
|
+
* Send a test email with a candidate configuration
|
|
1829
|
+
*
|
|
1830
|
+
* Sends a real message using the configuration **in this request body**, not
|
|
1831
|
+
* the stored one, so credentials can be verified before they are saved. The
|
|
1832
|
+
* body therefore always requires `secret`.
|
|
1833
|
+
*
|
|
1834
|
+
* The recipient is **always the acting user's own account email**. It cannot
|
|
1835
|
+
* be supplied by the caller, so this endpoint cannot be used to send mail to
|
|
1836
|
+
* third parties.
|
|
1837
|
+
*
|
|
1838
|
+
* A failed send is reported in the body with `is_valid: false` and a fixed
|
|
1839
|
+
* `details.error_details` category, not as an HTTP error. A 500 means an
|
|
1840
|
+
* internal fault, not a bad configuration.
|
|
1841
|
+
*
|
|
1842
|
+
* Authorized as a mutation, because it makes the server perform an outbound
|
|
1843
|
+
* send with team-supplied credentials.
|
|
1844
|
+
*
|
|
1845
|
+
*/
|
|
1846
|
+
export declare const testTeamEmailProvider: <ThrowOnError extends boolean = false>(options: Options<TestTeamEmailProviderData, ThrowOnError>) => RequestResult<TestTeamEmailProviderResponses, TestTeamEmailProviderErrors, ThrowOnError>;
|
|
1847
|
+
/**
|
|
1848
|
+
* Remove the team's email provider
|
|
1849
|
+
*
|
|
1850
|
+
* Deletes the team's provider, so the team reverts to the instance provider.
|
|
1851
|
+
* A subsequent GET reports `source: "instance"`.
|
|
1852
|
+
*
|
|
1853
|
+
* Deleting when the team has no provider of its own returns 409 rather than
|
|
1854
|
+
* 404: the endpoint exists and the team is addressable, it is simply not in a
|
|
1855
|
+
* state that can serve the request.
|
|
1856
|
+
*
|
|
1857
|
+
*/
|
|
1858
|
+
export declare const deleteTeamEmailProviderSettings: <ThrowOnError extends boolean = false>(options: Options<DeleteTeamEmailProviderSettingsData, ThrowOnError>) => RequestResult<DeleteTeamEmailProviderSettingsResponses, DeleteTeamEmailProviderSettingsErrors, ThrowOnError>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Get the team's effective email configuration
|
|
1861
|
+
*
|
|
1862
|
+
* Returns the email configuration in force for the team.
|
|
1863
|
+
*
|
|
1864
|
+
* This **always returns 200**, never 404. A team without its own provider is
|
|
1865
|
+
* inheriting the instance provider, which is a valid state the caller needs
|
|
1866
|
+
* described — it reports `configured: false`, `source: "instance"` and the
|
|
1867
|
+
* instance's `effective_from_address`.
|
|
1868
|
+
*
|
|
1869
|
+
* Readable by any team member: the response carries no credential, and
|
|
1870
|
+
* `effective_from_address` is already in the From: header of every mail those
|
|
1871
|
+
* members receive.
|
|
1872
|
+
*
|
|
1873
|
+
*/
|
|
1874
|
+
export declare const getTeamEmailProviderSettings: <ThrowOnError extends boolean = false>(options: Options<GetTeamEmailProviderSettingsData, ThrowOnError>) => RequestResult<GetTeamEmailProviderSettingsResponses, GetTeamEmailProviderSettingsErrors, ThrowOnError>;
|
|
1875
|
+
/**
|
|
1876
|
+
* Configure the team's email provider
|
|
1877
|
+
*
|
|
1878
|
+
* Creates or replaces the team's email provider. Idempotent: the same body
|
|
1879
|
+
* applied twice leaves one row and returns 200 both times.
|
|
1880
|
+
*
|
|
1881
|
+
* `secret` is required the first time. On a team that already has a provider,
|
|
1882
|
+
* omit it to keep the stored credential; sending an empty string is rejected
|
|
1883
|
+
* rather than treated as "clear", because a provider without a credential
|
|
1884
|
+
* cannot send and silently disabling a team's mail is worse than an error.
|
|
1885
|
+
*
|
|
1886
|
+
* A team-supplied `settings.smtp.host` or `settings.mailgun.base_url` that
|
|
1887
|
+
* resolves into a reserved network range is rejected before anything is
|
|
1888
|
+
* stored or dialled.
|
|
1889
|
+
*
|
|
1890
|
+
*/
|
|
1891
|
+
export declare const upsertTeamEmailProviderSettings: <ThrowOnError extends boolean = false>(options: Options<UpsertTeamEmailProviderSettingsData, ThrowOnError>) => RequestResult<UpsertTeamEmailProviderSettingsResponses, UpsertTeamEmailProviderSettingsErrors, ThrowOnError>;
|
|
1892
|
+
/**
|
|
1893
|
+
* Send a test email with a candidate configuration
|
|
1894
|
+
*
|
|
1895
|
+
* Sends a real message using the configuration **in this request body**, not
|
|
1896
|
+
* the stored one, so credentials can be verified before they are saved. The
|
|
1897
|
+
* body therefore always requires `secret`.
|
|
1898
|
+
*
|
|
1899
|
+
* The recipient is **always the acting user's own account email**. It cannot
|
|
1900
|
+
* be supplied by the caller, so this endpoint cannot be used to send mail to
|
|
1901
|
+
* third parties.
|
|
1902
|
+
*
|
|
1903
|
+
* A failed send is reported in the body with `is_valid: false` and a fixed
|
|
1904
|
+
* `details.error_details` category, not as an HTTP error. A 500 means an
|
|
1905
|
+
* internal fault, not a bad configuration.
|
|
1906
|
+
*
|
|
1907
|
+
* Authorized as a mutation, because it makes the server perform an outbound
|
|
1908
|
+
* send with team-supplied credentials.
|
|
1909
|
+
*
|
|
1910
|
+
*/
|
|
1911
|
+
export declare const testTeamEmailProviderSettings: <ThrowOnError extends boolean = false>(options: Options<TestTeamEmailProviderSettingsData, ThrowOnError>) => RequestResult<TestTeamEmailProviderSettingsResponses, TestTeamEmailProviderSettingsErrors, ThrowOnError>;
|
|
1611
1912
|
/**
|
|
1612
1913
|
* List model providers
|
|
1613
1914
|
*
|