@scalix-world/sdk 1.4.0 → 1.5.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/cjs/generated/client.gen.d.ts.map +1 -1
- package/dist/cjs/generated/client.gen.js +1 -1
- package/dist/cjs/generated/client.gen.js.map +1 -1
- package/dist/cjs/generated/index.d.ts +2 -2
- package/dist/cjs/generated/index.d.ts.map +1 -1
- package/dist/cjs/generated/index.js +9 -162
- package/dist/cjs/generated/index.js.map +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +21 -969
- package/dist/cjs/generated/sdk.gen.d.ts.map +1 -1
- package/dist/cjs/generated/sdk.gen.js +450 -2259
- package/dist/cjs/generated/sdk.gen.js.map +1 -1
- package/dist/cjs/generated/types.gen.d.ts +1697 -5667
- package/dist/cjs/generated/types.gen.d.ts.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/generated/client.gen.d.ts.map +1 -1
- package/dist/esm/generated/client.gen.js +1 -1
- package/dist/esm/generated/client.gen.js.map +1 -1
- package/dist/esm/generated/index.d.ts +2 -2
- package/dist/esm/generated/index.d.ts.map +1 -1
- package/dist/esm/generated/index.js +1 -1
- package/dist/esm/generated/index.js.map +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +21 -969
- package/dist/esm/generated/sdk.gen.d.ts.map +1 -1
- package/dist/esm/generated/sdk.gen.js +436 -2092
- package/dist/esm/generated/sdk.gen.js.map +1 -1
- package/dist/esm/generated/types.gen.d.ts +1697 -5667
- package/dist/esm/generated/types.gen.d.ts.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +4 -4
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client/index.js';
|
|
2
|
-
import type { AddDomainData, AddDomainErrors, AddDomainResponses, AddLoadBalancerBackendData, AddLoadBalancerBackendErrors, AddLoadBalancerBackendResponses, AddVpcPeerData, AddVpcPeerErrors, AddVpcPeerResponses, AnalyzeSentimentData, AnalyzeSentimentErrors, AnalyzeSentimentResponses, AuthorizeOauthData, AuthorizeOauthErrors, AuthorizeOauthResponses, AutocompleteTextData, AutocompleteTextErrors, AutocompleteTextResponses, BatchSqlData, BatchSqlErrors, BatchSqlResponses, BatchUpsertVectorsData, BatchUpsertVectorsErrors, BatchUpsertVectorsResponses, BranchTimelineData, BranchTimelineErrors, BranchTimelineResponses, BulkImportEnvVarsData, BulkImportEnvVarsErrors, BulkImportEnvVarsResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelBuildData, CancelBuildErrors, CancelBuildResponses, ChallengeMfaData, ChallengeMfaErrors, ChallengeMfaResponses, ChatCompletionData, ChatCompletionErrors, ChatCompletionResponses, CheckGrammarData, CheckGrammarErrors, CheckGrammarResponses, ClearShieldCrawlerPolicyData, ClearShieldCrawlerPolicyErrors, ClearShieldCrawlerPolicyResponses, ComputerCreateData, ComputerCreateErrors, ComputerCreateResponses, ComputerDeleteData, ComputerDeleteErrors, ComputerDeleteResponses, ComputerExecData, ComputerExecErrors, ComputerExecResponses, ComputerGetData, ComputerGetErrors, ComputerGetOrCreateByNameData, ComputerGetOrCreateByNameErrors, ComputerGetOrCreateByNameResponses, ComputerGetResponses, ComputerListData, ComputerListErrors, ComputerListResponses, ComputerReadFileData, ComputerReadFileErrors, ComputerReadFileResponses, ComputerSetSshKeysData, ComputerSetSshKeysErrors, ComputerSetSshKeysResponses, ComputerStartData, ComputerStartErrors, ComputerStartResponses, ComputerStopData, ComputerStopErrors, ComputerStopResponses, ComputerWriteFilesData, ComputerWriteFilesErrors, ComputerWriteFilesResponses, CreateBucketData, CreateBucketErrors, CreateBucketResponses, CreateBuildData, CreateBuildErrors, CreateBuildResponses, CreateCronScheduleData, CreateCronScheduleErrors, CreateCronScheduleResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabaseResponses, CreateDeploymentData, CreateDeploymentErrors, CreateDeploymentResponses, CreateDocgenData, CreateDocgenErrors, CreateDocgenResponses, CreateEmbeddingsData, CreateEmbeddingsErrors, CreateEmbeddingsResponses, CreateEventSubscriptionData, CreateEventSubscriptionErrors, CreateEventSubscriptionResponses, CreateEventTopicData, CreateEventTopicErrors, CreateEventTopicResponses, CreateFunctionData, CreateFunctionErrors, CreateFunctionResponses, CreateGdprRequestData, CreateGdprRequestErrors, CreateGdprRequestResponses, CreateGithubInstallationTokenData, CreateGithubInstallationTokenErrors, CreateGithubInstallationTokenResponses, CreateIntegrationData, CreateIntegrationErrors, CreateIntegrationResponses, CreateLoadBalancerData, CreateLoadBalancerErrors, CreateLoadBalancerResponses, CreateServiceData, CreateServiceErrors, CreateServiceResponses, CreateShieldCustomRuleData, CreateShieldCustomRuleErrors, CreateShieldCustomRuleResponses, CreateVectorCollectionData, CreateVectorCollectionErrors, CreateVectorCollectionResponses, CreateVpcData, CreateVpcErrors, CreateVpcResponses, CreateWafRuleData, CreateWafRuleErrors, CreateWafRuleResponses, DecryptDataData, DecryptDataErrors, DecryptDataResponses, DeleteBucketData, DeleteBucketErrors, DeleteBucketResponses, DeleteCronScheduleData, DeleteCronScheduleErrors, DeleteCronScheduleResponses, DeleteDatabaseData, DeleteDatabaseErrors, DeleteDatabaseResponses, DeleteDeploymentData, DeleteDeploymentErrors, DeleteDeploymentResponses, DeleteDomainData, DeleteDomainErrors, DeleteDomainResponses, DeleteEnvVarData, DeleteEnvVarErrors, DeleteEnvVarResponses, DeleteEventSubscriptionData, DeleteEventSubscriptionErrors, DeleteEventSubscriptionResponses, DeleteEventTopicData, DeleteEventTopicErrors, DeleteEventTopicResponses, DeleteFunctionData, DeleteFunctionErrors, DeleteFunctionResponses, DeleteIntegrationData, DeleteIntegrationErrors, DeleteIntegrationResponses, DeleteLoadBalancerData, DeleteLoadBalancerErrors, DeleteLoadBalancerResponses, DeleteMfaFactorData, DeleteMfaFactorErrors, DeleteMfaFactorResponses, DeleteObjectData, DeleteObjectErrors, DeleteObjectResponses, DeleteRagDocumentData, DeleteRagDocumentErrors, DeleteRagDocumentResponses, DeleteRegistryManifestData, DeleteRegistryManifestErrors, DeleteRegistryManifestResponses, DeleteServiceData, DeleteServiceErrors, DeleteServiceResponses, DeleteShieldCustomRuleData, DeleteShieldCustomRuleErrors, DeleteShieldCustomRuleResponses, DeleteVpcData, DeleteVpcErrors, DeleteVpcResponses, DeleteWafRuleData, DeleteWafRuleErrors, DeleteWafRuleResponses, DetectAnomaliesData, DetectAnomaliesErrors, DetectAnomaliesResponses, DownloadDocgenData, DownloadDocgenErrors, DownloadDocgenResponses, EncryptDataData, EncryptDataErrors, EncryptDataResponses, EnrollMfaData, EnrollMfaErrors, EnrollMfaResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportAuditLogData, ExportAuditLogErrors, ExportAuditLogResponses, ExportAuthUserData, ExportAuthUserErrors, ExportAuthUserResponses, GenerateImageData, GenerateImageErrors, GenerateImageResponses, GenerateSpeechData, GenerateSpeechErrors, GenerateSpeechResponses, GetAiProvidersStatusData, GetAiProvidersStatusErrors, GetAiProvidersStatusResponses, GetAuthUserData, GetAuthUserErrors, GetAuthUserResponses, GetBuildData, GetBuildErrors, GetBuildLogsData, GetBuildLogsErrors, GetBuildLogsResponses, GetBuildResponses, GetComplianceStatusData, GetComplianceStatusErrors, GetComplianceStatusResponses, GetCronScheduleData, GetCronScheduleErrors, GetCronScheduleResponses, GetDatabaseData, GetDatabaseErrors, GetDatabaseResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentLogsData, GetDeploymentLogsErrors, GetDeploymentLogsResponses, GetDeploymentResponses, GetDocgenHistoryData, GetDocgenHistoryErrors, GetDocgenHistoryResponses, GetDocgenStatusData, GetDocgenStatusErrors, GetDocgenStatusResponses, GetDomainData, GetDomainErrors, GetDomainResponses, GetEventSubscriptionData, GetEventSubscriptionErrors, GetEventSubscriptionResponses, GetEventTopicData, GetEventTopicErrors, GetEventTopicResponses, GetFunctionData, GetFunctionErrors, GetFunctionLogsData, GetFunctionLogsErrors, GetFunctionLogsResponses, GetFunctionResponses, GetGdprRequestData, GetGdprRequestErrors, GetGdprRequestResponses, GetIntegrationData, GetIntegrationErrors, GetIntegrationResponses, GetKeysUsageData, GetKeysUsageErrors, GetKeysUsageResponses, GetKeyUsageData, GetKeyUsageErrors, GetKeyUsageResponses, GetLoadBalancerData, GetLoadBalancerErrors, GetLoadBalancerResponses, GetMeData, GetMeErrors, GetMeResponses, GetMigrationPlanData, GetMigrationPlanErrors, GetMigrationPlanResponses, GetObjectData, GetObjectErrors, GetObjectResponses, GetOpenapiSpecData, GetOpenapiSpecResponses, GetRagStatusData, GetRagStatusErrors, GetRagStatusResponses, GetRegistryBlobData, GetRegistryBlobErrors, GetRegistryBlobResponses, GetRegistryCatalogData, GetRegistryCatalogErrors, GetRegistryCatalogResponses, GetRegistryManifestData, GetRegistryManifestErrors, GetRegistryManifestResponses, GetResearchStatusData, GetResearchStatusErrors, GetResearchStatusResponses, GetScalingSuggestionsData, GetScalingSuggestionsErrors, GetScalingSuggestionsResponses, GetSchemaData, GetSchemaErrors, GetSchemaRelationshipsData, GetSchemaRelationshipsErrors, GetSchemaRelationshipsResponses, GetSchemaResponses, GetSearchStatsData, GetSearchStatsErrors, GetSearchStatsResponses, GetServiceData, GetServiceErrors, GetServiceMetricsData, GetServiceMetricsErrors, GetServiceMetricsResponses, GetServiceResponses, GetServicesStatusData, GetServicesStatusErrors, GetServicesStatusResponses, GetShieldConfigData, GetShieldConfigErrors, GetShieldConfigResponses, GetShieldRobotsTxtData, GetShieldRobotsTxtErrors, GetShieldRobotsTxtResponses, GetShieldStatsData, GetShieldStatsErrors, GetShieldStatsResponses, GetTableSchemaData, GetTableSchemaErrors, GetTableSchemaResponses, GetUsageSummaryData, GetUsageSummaryErrors, GetUsageSummaryResponses, GetUserBudgetData, GetUserBudgetErrors, GetUserBudgetResponses, GetUserInfoData, GetUserInfoErrors, GetUserInfoResponses, GetUserStatsData, GetUserStatsErrors, GetUserStatsResponses, GetVpcConfigData, GetVpcConfigErrors, GetVpcConfigResponses, GetVpcData, GetVpcErrors, GetVpcResponses, GetWafStatsData, GetWafStatsErrors, GetWafStatsResponses, HeadObjectData, HeadObjectErrors, HeadObjectResponses, HeadRegistryBlobData, HeadRegistryBlobErrors, HeadRegistryBlobResponses, HeadRegistryManifestData, HeadRegistryManifestErrors, HeadRegistryManifestResponses, HealthzData, HealthzResponses, InvokeFunctionData, InvokeFunctionErrors, InvokeFunctionResponses, KvDelData, KvDelErrors, KvDelResponses, KvExistsData, KvExistsErrors, KvExistsResponses, KvGetData, KvGetErrors, KvGetResponses, KvKeysData, KvKeysErrors, KvKeysResponses, KvSetData, KvSetErrors, KvSetResponses, LinkIdentityData, LinkIdentityErrors, LinkIdentityResponses, ListAuthUserConsentData, ListAuthUserConsentErrors, ListAuthUserConsentResponses, ListBucketsData, ListBucketsErrors, ListBucketsResponses, ListBuildsData, ListBuildsErrors, ListBuildsResponses, ListCronExecutionsData, ListCronExecutionsErrors, ListCronExecutionsResponses, ListCronSchedulesData, ListCronSchedulesErrors, ListCronSchedulesResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDeploymentInstancesData, ListDeploymentInstancesErrors, ListDeploymentInstancesResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListDeploymentVersionsData, ListDeploymentVersionsErrors, ListDeploymentVersionsResponses, ListDocgenFormatsData, ListDocgenFormatsErrors, ListDocgenFormatsResponses, ListDocgenTemplatesData, ListDocgenTemplatesErrors, ListDocgenTemplatesResponses, ListDocgenVersionsData, ListDocgenVersionsErrors, ListDocgenVersionsResponses, ListDomainsData, ListDomainsErrors, ListDomainsResponses, ListEnvVarsData, ListEnvVarsErrors, ListEnvVarsResponses, ListEventTopicsData, ListEventTopicsErrors, ListEventTopicsResponses, ListFunctionInvocationsData, ListFunctionInvocationsErrors, ListFunctionInvocationsResponses, ListFunctionsData, ListFunctionsErrors, ListFunctionsResponses, ListGdprRequestsData, ListGdprRequestsErrors, ListGdprRequestsResponses, ListGithubInstallationsData, ListGithubInstallationsErrors, ListGithubInstallationsResponses, ListGithubReposData, ListGithubReposErrors, ListGithubReposResponses, ListIntegrationsData, ListIntegrationsErrors, ListIntegrationsResponses, ListLoadBalancersData, ListLoadBalancersErrors, ListLoadBalancersResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListMfaFactorsData, ListMfaFactorsErrors, ListMfaFactorsResponses, ListModelsData, ListModelsErrors, ListModelsResponses, ListObjectsData, ListObjectsErrors, ListObjectsResponses, ListPiiColumnsData, ListPiiColumnsErrors, ListPiiColumnsResponses, ListQueryLogsData, ListQueryLogsErrors, ListQueryLogsResponses, ListRagDocumentsData, ListRagDocumentsErrors, ListRagDocumentsResponses, ListRegistryTagsData, ListRegistryTagsErrors, ListRegistryTagsResponses, ListSearchSourcesData, ListSearchSourcesErrors, ListSearchSourcesResponses, ListServiceInstancesData, ListServiceInstancesErrors, ListServiceInstancesResponses, ListServiceRevisionsData, ListServiceRevisionsErrors, ListServiceRevisionsResponses, ListServicesData, ListServicesErrors, ListServicesResponses, ListSessionsData, ListSessionsErrors, ListSessionsResponses, ListShieldCrawlersData, ListShieldCrawlersErrors, ListShieldCrawlersResponses, ListShieldEventsData, ListShieldEventsErrors, ListShieldEventsResponses, ListSubscriptionDeliveriesData, ListSubscriptionDeliveriesErrors, ListSubscriptionDeliveriesResponses, ListTopicEventsData, ListTopicEventsErrors, ListTopicEventsResponses, ListTopicSubscriptionsData, ListTopicSubscriptionsErrors, ListTopicSubscriptionsResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, ListVectorCollectionsData, ListVectorCollectionsErrors, ListVectorCollectionsResponses, ListVpcPeersData, ListVpcPeersErrors, ListVpcPeersResponses, ListVpcsData, ListVpcsErrors, ListVpcsResponses, ListWafEventsData, ListWafEventsErrors, ListWafEventsResponses, ListWafRulesData, ListWafRulesErrors, ListWafRulesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, LoginData, LoginErrors, LoginResponses, LogoutData, LogoutErrors, LogoutResponses, NaturalLanguageToSqlData, NaturalLanguageToSqlErrors, NaturalLanguageToSqlResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OptimizeQueryData, OptimizeQueryErrors, OptimizeQueryResponses, PresignObjectData, PresignObjectErrors, PresignObjectResponses, PreviewDocgenData, PreviewDocgenErrors, PreviewDocgenResponses, ProvisionDatabaseData, ProvisionDatabaseErrors, ProvisionDatabaseResponses, ProvisionDomainSslData, ProvisionDomainSslErrors, ProvisionDomainSslResponses, PublishEventData, PublishEventErrors, PublishEventResponses, PutObjectData, PutObjectErrors, PutObjectResponses, PutRegistryManifestData, PutRegistryManifestErrors, PutRegistryManifestResponses, QueryAuditLogData, QueryAuditLogErrors, QueryAuditLogResponses, QueryRagData, QueryRagErrors, QueryRagResponses, ReadyzData, ReadyzResponses, RealtimeWebsocketData, RealtimeWebsocketErrors, RecordAuthUserConsentData, RecordAuthUserConsentErrors, RecordAuthUserConsentResponses, RefreshTokenData, RefreshTokenErrors, RefreshTokenResponses, RegisterMigrationData, RegisterMigrationErrors, RegisterMigrationResponses, RegisterWebhookData, RegisterWebhookErrors, RegisterWebhookResponses, RegistryVersionCheckData, RegistryVersionCheckErrors, RegistryVersionCheckResponses, RemoveLoadBalancerBackendData, RemoveLoadBalancerBackendErrors, RemoveLoadBalancerBackendResponses, RemoveVpcPeerData, RemoveVpcPeerErrors, RemoveVpcPeerResponses, RequestPasswordResetData, RequestPasswordResetErrors, RequestPasswordResetResponses, ResendVerificationData, ResendVerificationErrors, ResendVerificationResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestartDeploymentData, RestartDeploymentErrors, RestartDeploymentResponses, RestoreDatabaseData, RestoreDatabaseErrors, RestoreDatabaseResponses, RestorePitrData, RestorePitrErrors, RestorePitrResponses, ReviseDocgenData, ReviseDocgenErrors, ReviseDocgenResponses, RevokeSessionData, RevokeSessionErrors, RevokeSessionResponses, RollbackDeploymentData, RollbackDeploymentErrors, RollbackDeploymentResponses, RollbackServiceData, RollbackServiceErrors, RollbackServiceResponses, RotateEncryptionKeyData, RotateEncryptionKeyErrors, RotateEncryptionKeyResponses, RunDeepResearchData, RunDeepResearchErrors, RunDeepResearchResponses, RunResearchData, RunResearchErrors, RunResearchResponses, RunSearchIngestData, RunSearchIngestErrors, RunSearchIngestResponses, SandboxCreateData, SandboxCreateErrors, SandboxCreateResponses, SandboxDeleteData, SandboxDeleteErrors, SandboxDeleteResponses, SandboxExtendData, SandboxExtendErrors, SandboxExtendResponses, SandboxGetData, SandboxGetErrors, SandboxGetResponses, SandboxListData, SandboxListErrors, SandboxListResponses, SandboxReadFileData, SandboxReadFileErrors, SandboxReadFileResponses, SandboxRunCommandData, SandboxRunCommandErrors, SandboxRunCommandResponses, SandboxSnapshotData, SandboxSnapshotErrors, SandboxWriteFilesData, SandboxWriteFilesErrors, SandboxWriteFilesResponses, ScaleDeploymentData, ScaleDeploymentErrors, ScaleDeploymentResponses, SearchIndexData, SearchIndexErrors, SearchIndexResponses, SearchResearchData, SearchResearchErrors, SearchResearchResponses, SearchSchemaColumnsData, SearchSchemaColumnsErrors, SearchSchemaColumnsResponses, SearchVectorsData, SearchVectorsErrors, SearchVectorsResponses, SendMagicLinkData, SendMagicLinkErrors, SendMagicLinkResponses, SendOtpData, SendOtpErrors, SendOtpResponses, SetEnvVarData, SetEnvVarErrors, SetEnvVarResponses, SetShieldCrawlerIpRangesData, SetShieldCrawlerIpRangesErrors, SetShieldCrawlerIpRangesResponses, SetShieldCrawlerPolicyData, SetShieldCrawlerPolicyErrors, SetShieldCrawlerPolicyResponses, SignUpAnonymousData, SignUpAnonymousErrors, SignUpAnonymousResponses, SignUpData, SignUpErrors, SignUpResponses, StartRegistryBlobUploadData, StartRegistryBlobUploadErrors, StartRegistryBlobUploadResponses, StreamChatCompletionData, StreamChatCompletionErrors, StreamChatCompletionResponses, SubscribeRealtimeData, SubscribeRealtimeErrors, SubscribeRealtimeResponses, SummarizeTextData, SummarizeTextErrors, SummarizeTextResponses, TextVectorSearchData, TextVectorSearchErrors, TextVectorSearchResponses, TranscribeAudioData, TranscribeAudioErrors, TranscribeAudioResponses, TranslateTextData, TranslateTextErrors, TranslateTextResponses, TriggerCronScheduleData, TriggerCronScheduleErrors, TriggerCronScheduleResponses, UpdateAuthUserData, UpdateAuthUserErrors, UpdateAuthUserResponses, UpdateCronScheduleData, UpdateCronScheduleErrors, UpdateCronScheduleResponses, UpdateFunctionData, UpdateFunctionErrors, UpdateFunctionResponses, UpdateGdprRequestStatusData, UpdateGdprRequestStatusErrors, UpdateGdprRequestStatusResponses, UpdateIntegrationData, UpdateIntegrationErrors, UpdateIntegrationResponses, UpdateServiceData, UpdateServiceErrors, UpdateServiceResponses, UpdateShieldConfigData, UpdateShieldConfigErrors, UpdateShieldConfigResponses, UpdateShieldCustomRuleData, UpdateShieldCustomRuleErrors, UpdateShieldCustomRuleResponses, UpdateWafRuleData, UpdateWafRuleErrors, UpdateWafRuleResponses, UploadRagDocumentData, UploadRagDocumentErrors, UploadRagDocumentResponses, UpsertSearchSourceData, UpsertSearchSourceErrors, UpsertSearchSourceResponses, UpsertVectorsData, UpsertVectorsErrors, UpsertVectorsResponses, VerifyDomainData, VerifyDomainErrors, VerifyDomainResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses, VerifyMagicLinkData, VerifyMagicLinkErrors, VerifyMagicLinkResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses, VerifyOtpData, VerifyOtpErrors, VerifyOtpResponses } from './types.gen.js';
|
|
2
|
+
import type { AnalyzeSentimentData, AnalyzeSentimentErrors, AnalyzeSentimentResponses, AutocompleteTextData, AutocompleteTextErrors, AutocompleteTextResponses, ChatCompletionData, ChatCompletionErrors, ChatCompletionResponses, CheckGrammarData, CheckGrammarErrors, CheckGrammarResponses, ComputerCreateData, ComputerCreateErrors, ComputerCreateResponses, ComputerDeleteData, ComputerDeleteErrors, ComputerDeleteResponses, ComputerExecData, ComputerExecErrors, ComputerExecResponses, ComputerGetData, ComputerGetErrors, ComputerGetOrCreateByNameData, ComputerGetOrCreateByNameErrors, ComputerGetOrCreateByNameResponses, ComputerGetResponses, ComputerListData, ComputerListErrors, ComputerListResponses, ComputerReadFileData, ComputerReadFileErrors, ComputerReadFileResponses, ComputerSetSshKeysData, ComputerSetSshKeysErrors, ComputerSetSshKeysResponses, ComputerStartData, ComputerStartErrors, ComputerStartResponses, ComputerStopData, ComputerStopErrors, ComputerStopResponses, ComputerWriteFilesData, ComputerWriteFilesErrors, ComputerWriteFilesResponses, CreateBucketData, CreateBucketErrors, CreateBucketResponses, CreateCronScheduleData, CreateCronScheduleErrors, CreateCronScheduleResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabaseResponses, CreateDeploymentData, CreateDeploymentErrors, CreateDeploymentResponses, CreateDocgenData, CreateDocgenErrors, CreateDocgenResponses, CreateEmailTemplateData, CreateEmailTemplateErrors, CreateEmailTemplateResponses, CreateEmbeddingsData, CreateEmbeddingsErrors, CreateEmbeddingsResponses, CreateEventSubscriptionData, CreateEventSubscriptionErrors, CreateEventSubscriptionResponses, CreateEventTopicData, CreateEventTopicErrors, CreateEventTopicResponses, CreateFunctionData, CreateFunctionErrors, CreateFunctionResponses, DeleteBucketData, DeleteBucketErrors, DeleteBucketResponses, DeleteCronScheduleData, DeleteCronScheduleErrors, DeleteCronScheduleResponses, DeleteDatabaseData, DeleteDatabaseErrors, DeleteDatabaseResponses, DeleteDeploymentData, DeleteDeploymentErrors, DeleteDeploymentResponses, DeleteEmailTemplateData, DeleteEmailTemplateErrors, DeleteEmailTemplateResponses, DeleteEventSubscriptionData, DeleteEventSubscriptionErrors, DeleteEventSubscriptionResponses, DeleteEventTopicData, DeleteEventTopicErrors, DeleteEventTopicResponses, DeleteFunctionData, DeleteFunctionErrors, DeleteFunctionResponses, DeleteObjectData, DeleteObjectErrors, DeleteObjectResponses, DeleteRagDocumentData, DeleteRagDocumentErrors, DeleteRagDocumentResponses, DownloadDocgenData, DownloadDocgenErrors, DownloadDocgenResponses, GenerateImageData, GenerateImageErrors, GenerateImageResponses, GenerateSpeechData, GenerateSpeechErrors, GenerateSpeechResponses, GetAiProvidersStatusData, GetAiProvidersStatusErrors, GetAiProvidersStatusResponses, GetCronScheduleData, GetCronScheduleErrors, GetCronScheduleResponses, GetDatabaseData, GetDatabaseErrors, GetDatabaseResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentLogsData, GetDeploymentLogsErrors, GetDeploymentLogsResponses, GetDeploymentResponses, GetDocgenHistoryData, GetDocgenHistoryErrors, GetDocgenHistoryResponses, GetDocgenStatusData, GetDocgenStatusErrors, GetDocgenStatusResponses, GetEventSubscriptionData, GetEventSubscriptionErrors, GetEventSubscriptionResponses, GetEventTopicData, GetEventTopicErrors, GetEventTopicResponses, GetFunctionData, GetFunctionErrors, GetFunctionLogsData, GetFunctionLogsErrors, GetFunctionLogsResponses, GetFunctionResponses, GetKeysUsageData, GetKeysUsageErrors, GetKeysUsageResponses, GetObjectData, GetObjectErrors, GetObjectResponses, GetRagStatusData, GetRagStatusErrors, GetRagStatusResponses, GetResearchStatusData, GetResearchStatusErrors, GetResearchStatusResponses, InvokeFunctionData, InvokeFunctionErrors, InvokeFunctionResponses, KvDelData, KvDelErrors, KvDelResponses, KvExistsData, KvExistsErrors, KvExistsResponses, KvGetData, KvGetErrors, KvGetResponses, KvKeysData, KvKeysErrors, KvKeysResponses, KvSetData, KvSetErrors, KvSetResponses, ListBucketsData, ListBucketsErrors, ListBucketsResponses, ListCronExecutionsData, ListCronExecutionsErrors, ListCronExecutionsResponses, ListCronSchedulesData, ListCronSchedulesErrors, ListCronSchedulesResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDeploymentInstancesData, ListDeploymentInstancesErrors, ListDeploymentInstancesResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListDeploymentVersionsData, ListDeploymentVersionsErrors, ListDeploymentVersionsResponses, ListDocgenFormatsData, ListDocgenFormatsErrors, ListDocgenFormatsResponses, ListDocgenTemplatesData, ListDocgenTemplatesErrors, ListDocgenTemplatesResponses, ListDocgenVersionsData, ListDocgenVersionsErrors, ListDocgenVersionsResponses, ListEmailTemplatesData, ListEmailTemplatesErrors, ListEmailTemplatesResponses, ListEventTopicsData, ListEventTopicsErrors, ListEventTopicsResponses, ListFunctionInvocationsData, ListFunctionInvocationsErrors, ListFunctionInvocationsResponses, ListFunctionsData, ListFunctionsErrors, ListFunctionsResponses, ListModelsData, ListModelsErrors, ListModelsResponses, ListObjectsData, ListObjectsErrors, ListObjectsResponses, ListRagDocumentsData, ListRagDocumentsErrors, ListRagDocumentsResponses, ListSubscriptionDeliveriesData, ListSubscriptionDeliveriesErrors, ListSubscriptionDeliveriesResponses, ListTopicEventsData, ListTopicEventsErrors, ListTopicEventsResponses, ListTopicSubscriptionsData, ListTopicSubscriptionsErrors, ListTopicSubscriptionsResponses, PresignObjectData, PresignObjectErrors, PresignObjectResponses, PreviewDocgenData, PreviewDocgenErrors, PreviewDocgenResponses, ProvisionDatabaseData, ProvisionDatabaseErrors, ProvisionDatabaseResponses, PublishEventData, PublishEventErrors, PublishEventResponses, PutObjectData, PutObjectErrors, PutObjectResponses, QueryRagData, QueryRagErrors, QueryRagResponses, RestartDeploymentData, RestartDeploymentErrors, RestartDeploymentResponses, RestoreDatabaseData, RestoreDatabaseErrors, RestoreDatabaseResponses, ReviseDocgenData, ReviseDocgenErrors, ReviseDocgenResponses, RollbackDeploymentData, RollbackDeploymentErrors, RollbackDeploymentResponses, RunDeepResearchData, RunDeepResearchErrors, RunDeepResearchResponses, RunResearchData, RunResearchErrors, RunResearchResponses, SandboxCreateData, SandboxCreateErrors, SandboxCreateResponses, SandboxDeleteData, SandboxDeleteErrors, SandboxDeleteResponses, SandboxExtendData, SandboxExtendErrors, SandboxExtendResponses, SandboxGetData, SandboxGetErrors, SandboxGetResponses, SandboxListData, SandboxListErrors, SandboxListResponses, SandboxReadFileData, SandboxReadFileErrors, SandboxReadFileResponses, SandboxRunCommandData, SandboxRunCommandErrors, SandboxRunCommandResponses, SandboxSnapshotData, SandboxSnapshotErrors, SandboxWriteFilesData, SandboxWriteFilesErrors, SandboxWriteFilesResponses, ScaleDeploymentData, ScaleDeploymentErrors, ScaleDeploymentResponses, SearchResearchData, SearchResearchErrors, SearchResearchResponses, SendRawEmailData, SendRawEmailErrors, SendRawEmailResponses, SendTransactionalEmailData, SendTransactionalEmailErrors, SendTransactionalEmailResponses, StreamChatCompletionData, StreamChatCompletionErrors, StreamChatCompletionResponses, SummarizeTextData, SummarizeTextErrors, SummarizeTextResponses, TextVectorSearchData, TextVectorSearchErrors, TextVectorSearchResponses, TranscribeAudioData, TranscribeAudioErrors, TranscribeAudioResponses, TranslateTextData, TranslateTextErrors, TranslateTextResponses, TriggerCronScheduleData, TriggerCronScheduleErrors, TriggerCronScheduleResponses, UpdateCronScheduleData, UpdateCronScheduleErrors, UpdateCronScheduleResponses, UpdateEmailTemplateData, UpdateEmailTemplateErrors, UpdateEmailTemplateResponses, UpdateFunctionData, UpdateFunctionErrors, UpdateFunctionResponses, UploadRagDocumentData, UploadRagDocumentErrors, UploadRagDocumentResponses } from './types.gen.js';
|
|
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
|
|
@@ -13,219 +13,6 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
13
13
|
*/
|
|
14
14
|
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
15
|
};
|
|
16
|
-
/**
|
|
17
|
-
* Detect database anomalies.
|
|
18
|
-
*
|
|
19
|
-
* Analyzes recent activity and returns a report of detected database anomalies.
|
|
20
|
-
*/
|
|
21
|
-
export declare const detectAnomalies: <ThrowOnError extends boolean = false>(options?: Options<DetectAnomaliesData, ThrowOnError>) => RequestResult<DetectAnomaliesResponses, DetectAnomaliesErrors, ThrowOnError>;
|
|
22
|
-
/**
|
|
23
|
-
* Decrypt data.
|
|
24
|
-
*
|
|
25
|
-
* Decrypts the supplied ciphertext and returns the plaintext.
|
|
26
|
-
*/
|
|
27
|
-
export declare const decryptData: <ThrowOnError extends boolean = false>(options?: Options<DecryptDataData, ThrowOnError>) => RequestResult<DecryptDataResponses, DecryptDataErrors, ThrowOnError>;
|
|
28
|
-
/**
|
|
29
|
-
* Encrypt data.
|
|
30
|
-
*
|
|
31
|
-
* Encrypts the supplied plaintext and returns the ciphertext.
|
|
32
|
-
*/
|
|
33
|
-
export declare const encryptData: <ThrowOnError extends boolean = false>(options?: Options<EncryptDataData, ThrowOnError>) => RequestResult<EncryptDataResponses, EncryptDataErrors, ThrowOnError>;
|
|
34
|
-
/**
|
|
35
|
-
* Rotate the encryption key.
|
|
36
|
-
*
|
|
37
|
-
* Rotates the tenant's encryption key.
|
|
38
|
-
*/
|
|
39
|
-
export declare const rotateEncryptionKey: <ThrowOnError extends boolean = false>(options?: Options<RotateEncryptionKeyData, ThrowOnError>) => RequestResult<RotateEncryptionKeyResponses, RotateEncryptionKeyErrors, ThrowOnError>;
|
|
40
|
-
/**
|
|
41
|
-
* List MCP tools.
|
|
42
|
-
*
|
|
43
|
-
* Returns the MCP tool definitions available to the caller.
|
|
44
|
-
*/
|
|
45
|
-
export declare const listMcpTools: <ThrowOnError extends boolean = false>(options?: Options<ListMcpToolsData, ThrowOnError>) => RequestResult<ListMcpToolsResponses, ListMcpToolsErrors, ThrowOnError>;
|
|
46
|
-
/**
|
|
47
|
-
* Call an MCP tool.
|
|
48
|
-
*
|
|
49
|
-
* Invokes an MCP tool and returns its result.
|
|
50
|
-
*/
|
|
51
|
-
export declare const callMcpTool: <ThrowOnError extends boolean = false>(options?: Options<CallMcpToolData, ThrowOnError>) => RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError>;
|
|
52
|
-
/**
|
|
53
|
-
* Translate natural language to SQL.
|
|
54
|
-
*
|
|
55
|
-
* Generates a SQL statement from a natural-language description of the desired query.
|
|
56
|
-
*/
|
|
57
|
-
export declare const naturalLanguageToSql: <ThrowOnError extends boolean = false>(options?: Options<NaturalLanguageToSqlData, ThrowOnError>) => RequestResult<NaturalLanguageToSqlResponses, NaturalLanguageToSqlErrors, ThrowOnError>;
|
|
58
|
-
/**
|
|
59
|
-
* Get query optimization suggestions.
|
|
60
|
-
*
|
|
61
|
-
* Analyzes the tenant's database and returns indexing and query optimization suggestions.
|
|
62
|
-
*/
|
|
63
|
-
export declare const optimizeQuery: <ThrowOnError extends boolean = false>(options?: Options<OptimizeQueryData, ThrowOnError>) => RequestResult<OptimizeQueryResponses, OptimizeQueryErrors, ThrowOnError>;
|
|
64
|
-
/**
|
|
65
|
-
* List recent query logs.
|
|
66
|
-
*
|
|
67
|
-
* Returns recent query-log entries for a tenant, newest first.
|
|
68
|
-
*/
|
|
69
|
-
export declare const listQueryLogs: <ThrowOnError extends boolean = false>(options: Options<ListQueryLogsData, ThrowOnError>) => RequestResult<ListQueryLogsResponses, ListQueryLogsErrors, ThrowOnError>;
|
|
70
|
-
/**
|
|
71
|
-
* Get scaling suggestions.
|
|
72
|
-
*
|
|
73
|
-
* Returns capacity and scaling recommendations for the tenant's database.
|
|
74
|
-
*/
|
|
75
|
-
export declare const getScalingSuggestions: <ThrowOnError extends boolean = false>(options?: Options<GetScalingSuggestionsData, ThrowOnError>) => RequestResult<GetScalingSuggestionsResponses, GetScalingSuggestionsErrors, ThrowOnError>;
|
|
76
|
-
/**
|
|
77
|
-
* Get the database schema.
|
|
78
|
-
*
|
|
79
|
-
* Returns the tables, views, and types in the tenant's database.
|
|
80
|
-
*/
|
|
81
|
-
export declare const getSchema: <ThrowOnError extends boolean = false>(options?: Options<GetSchemaData, ThrowOnError>) => RequestResult<GetSchemaResponses, GetSchemaErrors, ThrowOnError>;
|
|
82
|
-
/**
|
|
83
|
-
* Search schema columns.
|
|
84
|
-
*
|
|
85
|
-
* Returns columns across the schema matching an optional name search term.
|
|
86
|
-
*/
|
|
87
|
-
export declare const searchSchemaColumns: <ThrowOnError extends boolean = false>(options?: Options<SearchSchemaColumnsData, ThrowOnError>) => RequestResult<SearchSchemaColumnsResponses, SearchSchemaColumnsErrors, ThrowOnError>;
|
|
88
|
-
/**
|
|
89
|
-
* Analyze PII columns.
|
|
90
|
-
*
|
|
91
|
-
* Returns columns flagged as likely personally identifiable information.
|
|
92
|
-
*/
|
|
93
|
-
export declare const listPiiColumns: <ThrowOnError extends boolean = false>(options?: Options<ListPiiColumnsData, ThrowOnError>) => RequestResult<ListPiiColumnsResponses, ListPiiColumnsErrors, ThrowOnError>;
|
|
94
|
-
/**
|
|
95
|
-
* List schema relationships.
|
|
96
|
-
*
|
|
97
|
-
* Returns the foreign-key relationships between tables in the schema.
|
|
98
|
-
*/
|
|
99
|
-
export declare const getSchemaRelationships: <ThrowOnError extends boolean = false>(options?: Options<GetSchemaRelationshipsData, ThrowOnError>) => RequestResult<GetSchemaRelationshipsResponses, GetSchemaRelationshipsErrors, ThrowOnError>;
|
|
100
|
-
/**
|
|
101
|
-
* Get a table's schema.
|
|
102
|
-
*
|
|
103
|
-
* Returns the columns and types for a single table.
|
|
104
|
-
*/
|
|
105
|
-
export declare const getTableSchema: <ThrowOnError extends boolean = false>(options: Options<GetTableSchemaData, ThrowOnError>) => RequestResult<GetTableSchemaResponses, GetTableSchemaErrors, ThrowOnError>;
|
|
106
|
-
/**
|
|
107
|
-
* Get service status.
|
|
108
|
-
*
|
|
109
|
-
* Returns the operational status of Scalix Cloud services.
|
|
110
|
-
*/
|
|
111
|
-
export declare const getServicesStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServicesStatusData, ThrowOnError>) => RequestResult<GetServicesStatusResponses, GetServicesStatusErrors, ThrowOnError>;
|
|
112
|
-
/**
|
|
113
|
-
* Execute a SQL query.
|
|
114
|
-
*
|
|
115
|
-
* Runs a parameterized SQL statement against the tenant's database and returns the result set.
|
|
116
|
-
*/
|
|
117
|
-
export declare const executeSql: <ThrowOnError extends boolean = false>(options: Options<ExecuteSqlData, ThrowOnError>) => RequestResult<ExecuteSqlResponses, ExecuteSqlErrors, ThrowOnError>;
|
|
118
|
-
/**
|
|
119
|
-
* Execute a batch of SQL queries.
|
|
120
|
-
*
|
|
121
|
-
* Runs multiple SQL statements in one request; each query executes independently and returns its own result set.
|
|
122
|
-
*/
|
|
123
|
-
export declare const batchSql: <ThrowOnError extends boolean = false>(options: Options<BatchSqlData, ThrowOnError>) => RequestResult<BatchSqlResponses, BatchSqlErrors, ThrowOnError>;
|
|
124
|
-
/**
|
|
125
|
-
* Register a migration.
|
|
126
|
-
*
|
|
127
|
-
* Registers a database migration for a tenant.
|
|
128
|
-
*/
|
|
129
|
-
export declare const registerMigration: <ThrowOnError extends boolean = false>(options: Options<RegisterMigrationData, ThrowOnError>) => RequestResult<RegisterMigrationResponses, RegisterMigrationErrors, ThrowOnError>;
|
|
130
|
-
/**
|
|
131
|
-
* Get the migration plan.
|
|
132
|
-
*
|
|
133
|
-
* Returns the pending migrations for a tenant.
|
|
134
|
-
*/
|
|
135
|
-
export declare const getMigrationPlan: <ThrowOnError extends boolean = false>(options: Options<GetMigrationPlanData, ThrowOnError>) => RequestResult<GetMigrationPlanResponses, GetMigrationPlanErrors, ThrowOnError>;
|
|
136
|
-
/**
|
|
137
|
-
* Restore to a point in time.
|
|
138
|
-
*
|
|
139
|
-
* Initiates a point-in-time restore of a tenant's database.
|
|
140
|
-
*/
|
|
141
|
-
export declare const restorePitr: <ThrowOnError extends boolean = false>(options: Options<RestorePitrData, ThrowOnError>) => RequestResult<RestorePitrResponses, RestorePitrErrors, ThrowOnError>;
|
|
142
|
-
/**
|
|
143
|
-
* Create a realtime subscription.
|
|
144
|
-
*
|
|
145
|
-
* Creates a realtime subscription for a tenant.
|
|
146
|
-
*/
|
|
147
|
-
export declare const subscribeRealtime: <ThrowOnError extends boolean = false>(options: Options<SubscribeRealtimeData, ThrowOnError>) => RequestResult<SubscribeRealtimeResponses, SubscribeRealtimeErrors, ThrowOnError>;
|
|
148
|
-
/**
|
|
149
|
-
* Open a realtime WebSocket.
|
|
150
|
-
*
|
|
151
|
-
* Upgrades the connection to a realtime WebSocket stream for a tenant.
|
|
152
|
-
*/
|
|
153
|
-
export declare const realtimeWebsocket: <ThrowOnError extends boolean = false>(options: Options<RealtimeWebsocketData, ThrowOnError>) => RequestResult<unknown, RealtimeWebsocketErrors, ThrowOnError>;
|
|
154
|
-
/**
|
|
155
|
-
* Branch a timeline.
|
|
156
|
-
*
|
|
157
|
-
* Restores the parent timeline's durable base backup + archived WAL into a
|
|
158
|
-
* NEW compute worker replayed to `branch_lsn` (`0` = latest), then routes the
|
|
159
|
-
* branch endpoint. The branch archives onto its own timeline from that point.
|
|
160
|
-
*/
|
|
161
|
-
export declare const branchTimeline: <ThrowOnError extends boolean = false>(options: Options<BranchTimelineData, ThrowOnError>) => RequestResult<BranchTimelineResponses, BranchTimelineErrors, ThrowOnError>;
|
|
162
|
-
/**
|
|
163
|
-
* Batch upsert vectors.
|
|
164
|
-
*
|
|
165
|
-
* Inserts or updates many vectors in a collection in a single request
|
|
166
|
-
* (one multi-row write). Returns the number of vectors upserted.
|
|
167
|
-
*/
|
|
168
|
-
export declare const batchUpsertVectors: <ThrowOnError extends boolean = false>(options: Options<BatchUpsertVectorsData, ThrowOnError>) => RequestResult<BatchUpsertVectorsResponses, BatchUpsertVectorsErrors, ThrowOnError>;
|
|
169
|
-
/**
|
|
170
|
-
* List vector collections.
|
|
171
|
-
*
|
|
172
|
-
* Returns the vector collections for a tenant.
|
|
173
|
-
*/
|
|
174
|
-
export declare const listVectorCollections: <ThrowOnError extends boolean = false>(options: Options<ListVectorCollectionsData, ThrowOnError>) => RequestResult<ListVectorCollectionsResponses, ListVectorCollectionsErrors, ThrowOnError>;
|
|
175
|
-
/**
|
|
176
|
-
* Create a vector collection.
|
|
177
|
-
*
|
|
178
|
-
* Creates a new vector collection for a tenant.
|
|
179
|
-
*/
|
|
180
|
-
export declare const createVectorCollection: <ThrowOnError extends boolean = false>(options: Options<CreateVectorCollectionData, ThrowOnError>) => RequestResult<CreateVectorCollectionResponses, CreateVectorCollectionErrors, ThrowOnError>;
|
|
181
|
-
/**
|
|
182
|
-
* Search vectors.
|
|
183
|
-
*
|
|
184
|
-
* Runs a nearest-neighbour vector search and returns scored matches.
|
|
185
|
-
*/
|
|
186
|
-
export declare const searchVectors: <ThrowOnError extends boolean = false>(options: Options<SearchVectorsData, ThrowOnError>) => RequestResult<SearchVectorsResponses, SearchVectorsErrors, ThrowOnError>;
|
|
187
|
-
/**
|
|
188
|
-
* Upsert vectors.
|
|
189
|
-
*
|
|
190
|
-
* Inserts or updates a batch of vectors in a collection.
|
|
191
|
-
*/
|
|
192
|
-
export declare const upsertVectors: <ThrowOnError extends boolean = false>(options: Options<UpsertVectorsData, ThrowOnError>) => RequestResult<UpsertVectorsResponses, UpsertVectorsErrors, ThrowOnError>;
|
|
193
|
-
/**
|
|
194
|
-
* List webhooks.
|
|
195
|
-
*
|
|
196
|
-
* Returns the registered webhook endpoints for a tenant.
|
|
197
|
-
*/
|
|
198
|
-
export declare const listWebhooks: <ThrowOnError extends boolean = false>(options: Options<ListWebhooksData, ThrowOnError>) => RequestResult<ListWebhooksResponses, ListWebhooksErrors, ThrowOnError>;
|
|
199
|
-
/**
|
|
200
|
-
* Register a webhook.
|
|
201
|
-
*
|
|
202
|
-
* Registers a webhook endpoint for a set of event types.
|
|
203
|
-
*/
|
|
204
|
-
export declare const registerWebhook: <ThrowOnError extends boolean = false>(options: Options<RegisterWebhookData, ThrowOnError>) => RequestResult<RegisterWebhookResponses, RegisterWebhookErrors, ThrowOnError>;
|
|
205
|
-
/**
|
|
206
|
-
* Get usage summary.
|
|
207
|
-
*
|
|
208
|
-
* Returns the caller's aggregate usage summary.
|
|
209
|
-
*/
|
|
210
|
-
export declare const getUsageSummary: <ThrowOnError extends boolean = false>(options?: Options<GetUsageSummaryData, ThrowOnError>) => RequestResult<GetUsageSummaryResponses, GetUsageSummaryErrors, ThrowOnError>;
|
|
211
|
-
/**
|
|
212
|
-
* Liveness probe.
|
|
213
|
-
*
|
|
214
|
-
* Returns 200 while the gateway process is alive.
|
|
215
|
-
*/
|
|
216
|
-
export declare const healthz: <ThrowOnError extends boolean = false>(options?: Options<HealthzData, ThrowOnError>) => RequestResult<HealthzResponses, unknown, ThrowOnError>;
|
|
217
|
-
/**
|
|
218
|
-
* Get the OpenAPI spec.
|
|
219
|
-
*
|
|
220
|
-
* Returns this OpenAPI specification document.
|
|
221
|
-
*/
|
|
222
|
-
export declare const getOpenapiSpec: <ThrowOnError extends boolean = false>(options?: Options<GetOpenapiSpecData, ThrowOnError>) => RequestResult<GetOpenapiSpecResponses, unknown, ThrowOnError>;
|
|
223
|
-
/**
|
|
224
|
-
* Readiness probe.
|
|
225
|
-
*
|
|
226
|
-
* Returns 200 when the gateway is ready to serve traffic.
|
|
227
|
-
*/
|
|
228
|
-
export declare const readyz: <ThrowOnError extends boolean = false>(options?: Options<ReadyzData, ThrowOnError>) => RequestResult<ReadyzResponses, unknown, ThrowOnError>;
|
|
229
16
|
/**
|
|
230
17
|
* Generate speech.
|
|
231
18
|
*
|
|
@@ -418,265 +205,6 @@ export declare const translateText: <ThrowOnError extends boolean = false>(optio
|
|
|
418
205
|
* Runs a vector similarity search over supplied in-context text.
|
|
419
206
|
*/
|
|
420
207
|
export declare const textVectorSearch: <ThrowOnError extends boolean = false>(options: Options<TextVectorSearchData, ThrowOnError>) => RequestResult<TextVectorSearchResponses, TextVectorSearchErrors, ThrowOnError>;
|
|
421
|
-
/**
|
|
422
|
-
* Sign in anonymously.
|
|
423
|
-
*
|
|
424
|
-
* Creates an anonymous end-user account and returns auth tokens; the account
|
|
425
|
-
* can later be linked to a real identity via identity linking.
|
|
426
|
-
*/
|
|
427
|
-
export declare const signUpAnonymous: <ThrowOnError extends boolean = false>(options?: Options<SignUpAnonymousData, ThrowOnError>) => RequestResult<SignUpAnonymousResponses, SignUpAnonymousErrors, ThrowOnError>;
|
|
428
|
-
/**
|
|
429
|
-
* Link an identity.
|
|
430
|
-
*
|
|
431
|
-
* Links an additional identity (e.g. an OAuth provider or email/password) to
|
|
432
|
-
* the authenticated user, including upgrading anonymous accounts.
|
|
433
|
-
*/
|
|
434
|
-
export declare const linkIdentity: <ThrowOnError extends boolean = false>(options?: Options<LinkIdentityData, ThrowOnError>) => RequestResult<LinkIdentityResponses, LinkIdentityErrors, ThrowOnError>;
|
|
435
|
-
/**
|
|
436
|
-
* Log in.
|
|
437
|
-
*
|
|
438
|
-
* Authenticates an end user with email and password and returns auth tokens.
|
|
439
|
-
*/
|
|
440
|
-
export declare const login: <ThrowOnError extends boolean = false>(options: Options<LoginData, ThrowOnError>) => RequestResult<LoginResponses, LoginErrors, ThrowOnError>;
|
|
441
|
-
/**
|
|
442
|
-
* Log out.
|
|
443
|
-
*
|
|
444
|
-
* Invalidates the caller's current session/token.
|
|
445
|
-
*/
|
|
446
|
-
export declare const logout: <ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>) => RequestResult<LogoutResponses, LogoutErrors, ThrowOnError>;
|
|
447
|
-
/**
|
|
448
|
-
* Send a magic link.
|
|
449
|
-
*
|
|
450
|
-
* Emails the user a passwordless magic sign-in link.
|
|
451
|
-
*/
|
|
452
|
-
export declare const sendMagicLink: <ThrowOnError extends boolean = false>(options?: Options<SendMagicLinkData, ThrowOnError>) => RequestResult<SendMagicLinkResponses, SendMagicLinkErrors, ThrowOnError>;
|
|
453
|
-
/**
|
|
454
|
-
* Verify a magic link.
|
|
455
|
-
*
|
|
456
|
-
* Exchanges the emailed magic-link token for Scalix auth tokens.
|
|
457
|
-
*/
|
|
458
|
-
export declare const verifyMagicLink: <ThrowOnError extends boolean = false>(options?: Options<VerifyMagicLinkData, ThrowOnError>) => RequestResult<VerifyMagicLinkResponses, VerifyMagicLinkErrors, ThrowOnError>;
|
|
459
|
-
/**
|
|
460
|
-
* List the user's organizations.
|
|
461
|
-
*
|
|
462
|
-
* Returns the organizations the authenticated end user belongs to.
|
|
463
|
-
*/
|
|
464
|
-
export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => RequestResult<ListUserOrgsResponses, ListUserOrgsErrors, ThrowOnError>;
|
|
465
|
-
/**
|
|
466
|
-
* Complete an MFA challenge.
|
|
467
|
-
*
|
|
468
|
-
* Verifies a TOTP code against an enrolled factor during sign-in and returns
|
|
469
|
-
* auth tokens.
|
|
470
|
-
*/
|
|
471
|
-
export declare const challengeMfa: <ThrowOnError extends boolean = false>(options?: Options<ChallengeMfaData, ThrowOnError>) => RequestResult<ChallengeMfaResponses, ChallengeMfaErrors, ThrowOnError>;
|
|
472
|
-
/**
|
|
473
|
-
* Enroll in MFA.
|
|
474
|
-
*
|
|
475
|
-
* Begins TOTP multi-factor enrollment and returns the secret and QR code.
|
|
476
|
-
*/
|
|
477
|
-
export declare const enrollMfa: <ThrowOnError extends boolean = false>(options?: Options<EnrollMfaData, ThrowOnError>) => RequestResult<EnrollMfaResponses, EnrollMfaErrors, ThrowOnError>;
|
|
478
|
-
/**
|
|
479
|
-
* List MFA factors.
|
|
480
|
-
*
|
|
481
|
-
* Returns the authenticated user's enrolled multi-factor authentication factors.
|
|
482
|
-
*/
|
|
483
|
-
export declare const listMfaFactors: <ThrowOnError extends boolean = false>(options?: Options<ListMfaFactorsData, ThrowOnError>) => RequestResult<ListMfaFactorsResponses, ListMfaFactorsErrors, ThrowOnError>;
|
|
484
|
-
/**
|
|
485
|
-
* Delete an MFA factor.
|
|
486
|
-
*
|
|
487
|
-
* Removes an enrolled multi-factor authentication factor.
|
|
488
|
-
*/
|
|
489
|
-
export declare const deleteMfaFactor: <ThrowOnError extends boolean = false>(options: Options<DeleteMfaFactorData, ThrowOnError>) => RequestResult<DeleteMfaFactorResponses, DeleteMfaFactorErrors, ThrowOnError>;
|
|
490
|
-
/**
|
|
491
|
-
* Verify MFA.
|
|
492
|
-
*
|
|
493
|
-
* Verifies a TOTP code to complete multi-factor enrollment or a challenge.
|
|
494
|
-
*/
|
|
495
|
-
export declare const verifyMfa: <ThrowOnError extends boolean = false>(options?: Options<VerifyMfaData, ThrowOnError>) => RequestResult<VerifyMfaResponses, VerifyMfaErrors, ThrowOnError>;
|
|
496
|
-
/**
|
|
497
|
-
* Start OAuth authorization.
|
|
498
|
-
*
|
|
499
|
-
* Returns the provider authorization URL to begin an OAuth sign-in flow.
|
|
500
|
-
*/
|
|
501
|
-
export declare const authorizeOauth: <ThrowOnError extends boolean = false>(options?: Options<AuthorizeOauthData, ThrowOnError>) => RequestResult<AuthorizeOauthResponses, AuthorizeOauthErrors, ThrowOnError>;
|
|
502
|
-
/**
|
|
503
|
-
* Complete OAuth sign-in.
|
|
504
|
-
*
|
|
505
|
-
* Exchanges the provider OAuth callback for Scalix auth tokens.
|
|
506
|
-
*/
|
|
507
|
-
export declare const oauthCallback: <ThrowOnError extends boolean = false>(options?: Options<OauthCallbackData, ThrowOnError>) => RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError>;
|
|
508
|
-
/**
|
|
509
|
-
* Send a one-time passcode.
|
|
510
|
-
*
|
|
511
|
-
* Sends the user a one-time passcode for passwordless sign-in.
|
|
512
|
-
*/
|
|
513
|
-
export declare const sendOtp: <ThrowOnError extends boolean = false>(options?: Options<SendOtpData, ThrowOnError>) => RequestResult<SendOtpResponses, SendOtpErrors, ThrowOnError>;
|
|
514
|
-
/**
|
|
515
|
-
* Verify a one-time passcode.
|
|
516
|
-
*
|
|
517
|
-
* Exchanges the phone number and OTP code for Scalix auth tokens.
|
|
518
|
-
*/
|
|
519
|
-
export declare const verifyOtp: <ThrowOnError extends boolean = false>(options?: Options<VerifyOtpData, ThrowOnError>) => RequestResult<VerifyOtpResponses, VerifyOtpErrors, ThrowOnError>;
|
|
520
|
-
/**
|
|
521
|
-
* Request a password reset.
|
|
522
|
-
*
|
|
523
|
-
* Emails the user a password-recovery link.
|
|
524
|
-
*/
|
|
525
|
-
export declare const requestPasswordReset: <ThrowOnError extends boolean = false>(options?: Options<RequestPasswordResetData, ThrowOnError>) => RequestResult<RequestPasswordResetResponses, RequestPasswordResetErrors, ThrowOnError>;
|
|
526
|
-
/**
|
|
527
|
-
* Reset the password.
|
|
528
|
-
*
|
|
529
|
-
* Sets a new password using a recovery token.
|
|
530
|
-
*/
|
|
531
|
-
export declare const resetPassword: <ThrowOnError extends boolean = false>(options?: Options<ResetPasswordData, ThrowOnError>) => RequestResult<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError>;
|
|
532
|
-
/**
|
|
533
|
-
* Refresh auth tokens.
|
|
534
|
-
*
|
|
535
|
-
* Exchanges a refresh token for a new access/refresh token pair.
|
|
536
|
-
*/
|
|
537
|
-
export declare const refreshToken: <ThrowOnError extends boolean = false>(options?: Options<RefreshTokenData, ThrowOnError>) => RequestResult<RefreshTokenResponses, RefreshTokenErrors, ThrowOnError>;
|
|
538
|
-
/**
|
|
539
|
-
* Resend the verification email.
|
|
540
|
-
*
|
|
541
|
-
* Sends the email-verification message again.
|
|
542
|
-
*/
|
|
543
|
-
export declare const resendVerification: <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationData, ThrowOnError>) => RequestResult<ResendVerificationResponses, ResendVerificationErrors, ThrowOnError>;
|
|
544
|
-
/**
|
|
545
|
-
* List sessions.
|
|
546
|
-
*
|
|
547
|
-
* Returns the authenticated user's active sessions.
|
|
548
|
-
*/
|
|
549
|
-
export declare const listSessions: <ThrowOnError extends boolean = false>(options?: Options<ListSessionsData, ThrowOnError>) => RequestResult<ListSessionsResponses, ListSessionsErrors, ThrowOnError>;
|
|
550
|
-
/**
|
|
551
|
-
* Revoke a session.
|
|
552
|
-
*
|
|
553
|
-
* Terminates one of the authenticated user's sessions.
|
|
554
|
-
*/
|
|
555
|
-
export declare const revokeSession: <ThrowOnError extends boolean = false>(options: Options<RevokeSessionData, ThrowOnError>) => RequestResult<RevokeSessionResponses, RevokeSessionErrors, ThrowOnError>;
|
|
556
|
-
/**
|
|
557
|
-
* Sign up a new user.
|
|
558
|
-
*
|
|
559
|
-
* Creates a new end-user account and returns auth tokens plus the created user.
|
|
560
|
-
*/
|
|
561
|
-
export declare const signUp: <ThrowOnError extends boolean = false>(options: Options<SignUpData, ThrowOnError>) => RequestResult<SignUpResponses, SignUpErrors, ThrowOnError>;
|
|
562
|
-
/**
|
|
563
|
-
* Get the current user.
|
|
564
|
-
*
|
|
565
|
-
* Returns the authenticated end user's profile.
|
|
566
|
-
*/
|
|
567
|
-
export declare const getAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetAuthUserData, ThrowOnError>) => RequestResult<GetAuthUserResponses, GetAuthUserErrors, ThrowOnError>;
|
|
568
|
-
/**
|
|
569
|
-
* Update the current user.
|
|
570
|
-
*
|
|
571
|
-
* Updates the authenticated end user's profile and returns the new record.
|
|
572
|
-
*/
|
|
573
|
-
export declare const updateAuthUser: <ThrowOnError extends boolean = false>(options?: Options<UpdateAuthUserData, ThrowOnError>) => RequestResult<UpdateAuthUserResponses, UpdateAuthUserErrors, ThrowOnError>;
|
|
574
|
-
/**
|
|
575
|
-
* List consent records.
|
|
576
|
-
*
|
|
577
|
-
* Returns the authenticated user's consent audit trail.
|
|
578
|
-
*/
|
|
579
|
-
export declare const listAuthUserConsent: <ThrowOnError extends boolean = false>(options?: Options<ListAuthUserConsentData, ThrowOnError>) => RequestResult<ListAuthUserConsentResponses, ListAuthUserConsentErrors, ThrowOnError>;
|
|
580
|
-
/**
|
|
581
|
-
* Record a consent decision.
|
|
582
|
-
*
|
|
583
|
-
* Records a single GDPR consent decision for the authenticated user.
|
|
584
|
-
*/
|
|
585
|
-
export declare const recordAuthUserConsent: <ThrowOnError extends boolean = false>(options: Options<RecordAuthUserConsentData, ThrowOnError>) => RequestResult<RecordAuthUserConsentResponses, RecordAuthUserConsentErrors, ThrowOnError>;
|
|
586
|
-
/**
|
|
587
|
-
* Export user data.
|
|
588
|
-
*
|
|
589
|
-
* Returns a complete export of the authenticated user's data (GDPR portability).
|
|
590
|
-
*/
|
|
591
|
-
export declare const exportAuthUser: <ThrowOnError extends boolean = false>(options?: Options<ExportAuthUserData, ThrowOnError>) => RequestResult<ExportAuthUserResponses, ExportAuthUserErrors, ThrowOnError>;
|
|
592
|
-
/**
|
|
593
|
-
* Verify an email address.
|
|
594
|
-
*
|
|
595
|
-
* Confirms the user's email address using the emailed verification token.
|
|
596
|
-
*/
|
|
597
|
-
export declare const verifyEmail: <ThrowOnError extends boolean = false>(options?: Options<VerifyEmailData, ThrowOnError>) => RequestResult<VerifyEmailResponses, VerifyEmailErrors, ThrowOnError>;
|
|
598
|
-
/**
|
|
599
|
-
* List builds.
|
|
600
|
-
*
|
|
601
|
-
* Returns the builds for the caller's project.
|
|
602
|
-
*/
|
|
603
|
-
export declare const listBuilds: <ThrowOnError extends boolean = false>(options?: Options<ListBuildsData, ThrowOnError>) => RequestResult<ListBuildsResponses, ListBuildsErrors, ThrowOnError>;
|
|
604
|
-
/**
|
|
605
|
-
* Start a build.
|
|
606
|
-
*
|
|
607
|
-
* Starts a container image build and returns the build record.
|
|
608
|
-
*/
|
|
609
|
-
export declare const createBuild: <ThrowOnError extends boolean = false>(options: Options<CreateBuildData, ThrowOnError>) => RequestResult<CreateBuildResponses, CreateBuildErrors, ThrowOnError>;
|
|
610
|
-
/**
|
|
611
|
-
* Get a build.
|
|
612
|
-
*
|
|
613
|
-
* Returns a single build by id.
|
|
614
|
-
*/
|
|
615
|
-
export declare const getBuild: <ThrowOnError extends boolean = false>(options: Options<GetBuildData, ThrowOnError>) => RequestResult<GetBuildResponses, GetBuildErrors, ThrowOnError>;
|
|
616
|
-
/**
|
|
617
|
-
* Cancel a build.
|
|
618
|
-
*
|
|
619
|
-
* Cancels an in-progress build.
|
|
620
|
-
*/
|
|
621
|
-
export declare const cancelBuild: <ThrowOnError extends boolean = false>(options: Options<CancelBuildData, ThrowOnError>) => RequestResult<CancelBuildResponses, CancelBuildErrors, ThrowOnError>;
|
|
622
|
-
/**
|
|
623
|
-
* Get build logs.
|
|
624
|
-
*
|
|
625
|
-
* Returns log output for a build.
|
|
626
|
-
*/
|
|
627
|
-
export declare const getBuildLogs: <ThrowOnError extends boolean = false>(options: Options<GetBuildLogsData, ThrowOnError>) => RequestResult<GetBuildLogsResponses, GetBuildLogsErrors, ThrowOnError>;
|
|
628
|
-
/**
|
|
629
|
-
* Query the audit log.
|
|
630
|
-
*
|
|
631
|
-
* Returns audit events for the caller's tenant, filterable by action and time
|
|
632
|
-
* range. The tenant scope is always taken from the token, never the query.
|
|
633
|
-
*/
|
|
634
|
-
export declare const queryAuditLog: <ThrowOnError extends boolean = false>(options?: Options<QueryAuditLogData, ThrowOnError>) => RequestResult<QueryAuditLogResponses, QueryAuditLogErrors, ThrowOnError>;
|
|
635
|
-
/**
|
|
636
|
-
* Export the audit log.
|
|
637
|
-
*
|
|
638
|
-
* Returns the full audit trail for the caller's tenant for compliance export
|
|
639
|
-
* (JSON by default, CSV with `?format=csv`).
|
|
640
|
-
*/
|
|
641
|
-
export declare const exportAuditLog: <ThrowOnError extends boolean = false>(options?: Options<ExportAuditLogData, ThrowOnError>) => RequestResult<ExportAuditLogResponses, ExportAuditLogErrors, ThrowOnError>;
|
|
642
|
-
/**
|
|
643
|
-
* List GDPR requests.
|
|
644
|
-
*
|
|
645
|
-
* Returns the data-subject requests for the caller's tenant.
|
|
646
|
-
*/
|
|
647
|
-
export declare const listGdprRequests: <ThrowOnError extends boolean = false>(options?: Options<ListGdprRequestsData, ThrowOnError>) => RequestResult<ListGdprRequestsResponses, ListGdprRequestsErrors, ThrowOnError>;
|
|
648
|
-
/**
|
|
649
|
-
* Create a GDPR request.
|
|
650
|
-
*
|
|
651
|
-
* Files a GDPR data-subject request (access / erasure / rectification). This is
|
|
652
|
-
* intake only: the request is persisted with status `pending`; export and
|
|
653
|
-
* erasure are fulfilled out of band.
|
|
654
|
-
*/
|
|
655
|
-
export declare const createGdprRequest: <ThrowOnError extends boolean = false>(options: Options<CreateGdprRequestData, ThrowOnError>) => RequestResult<CreateGdprRequestResponses, CreateGdprRequestErrors, ThrowOnError>;
|
|
656
|
-
/**
|
|
657
|
-
* Get a GDPR request.
|
|
658
|
-
*
|
|
659
|
-
* Returns a single GDPR data-subject request by id.
|
|
660
|
-
*/
|
|
661
|
-
export declare const getGdprRequest: <ThrowOnError extends boolean = false>(options: Options<GetGdprRequestData, ThrowOnError>) => RequestResult<GetGdprRequestResponses, GetGdprRequestErrors, ThrowOnError>;
|
|
662
|
-
/**
|
|
663
|
-
* Advance a GDPR data-subject request through its lifecycle.
|
|
664
|
-
*
|
|
665
|
-
* SEC-1: the DSR flow was intake-only — requests sat `pending` forever with no
|
|
666
|
-
* way to fulfill them, while the compliance status implied a working workflow.
|
|
667
|
-
* A data-protection officer (compliance:write) now moves each request through
|
|
668
|
-
* pending → in_progress → completed/rejected; terminal states stamp
|
|
669
|
-
* `completed_at`, giving an auditable fulfillment record within the GDPR Art.
|
|
670
|
-
* 12(3) one-month window. Tenant-scoped.
|
|
671
|
-
*/
|
|
672
|
-
export declare const updateGdprRequestStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateGdprRequestStatusData, ThrowOnError>) => RequestResult<UpdateGdprRequestStatusResponses, UpdateGdprRequestStatusErrors, ThrowOnError>;
|
|
673
|
-
/**
|
|
674
|
-
* Get compliance status.
|
|
675
|
-
*
|
|
676
|
-
* Runs the compliance checks (encryption, audit, access controls) and returns
|
|
677
|
-
* each check's result plus an overall score.
|
|
678
|
-
*/
|
|
679
|
-
export declare const getComplianceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetComplianceStatusData, ThrowOnError>) => RequestResult<GetComplianceStatusResponses, GetComplianceStatusErrors, ThrowOnError>;
|
|
680
208
|
/**
|
|
681
209
|
* List deployments.
|
|
682
210
|
*
|
|
@@ -891,71 +419,43 @@ export declare const getDatabase: <ThrowOnError extends boolean = false>(options
|
|
|
891
419
|
*/
|
|
892
420
|
export declare const restoreDatabase: <ThrowOnError extends boolean = false>(options: Options<RestoreDatabaseData, ThrowOnError>) => RequestResult<RestoreDatabaseResponses, RestoreDatabaseErrors, ThrowOnError>;
|
|
893
421
|
/**
|
|
894
|
-
*
|
|
895
|
-
*
|
|
896
|
-
* Returns all custom domains attached to the caller's project, with their
|
|
897
|
-
* verification and SSL status.
|
|
898
|
-
*/
|
|
899
|
-
export declare const listDomains: <ThrowOnError extends boolean = false>(options?: Options<ListDomainsData, ThrowOnError>) => RequestResult<ListDomainsResponses, ListDomainsErrors, ThrowOnError>;
|
|
900
|
-
/**
|
|
901
|
-
* Add a custom domain.
|
|
902
|
-
*
|
|
903
|
-
* Registers a custom domain for the caller's project and returns the created
|
|
904
|
-
* record plus the DNS records (CNAME + TXT) needed to verify and serve it.
|
|
905
|
-
*/
|
|
906
|
-
export declare const addDomain: <ThrowOnError extends boolean = false>(options: Options<AddDomainData, ThrowOnError>) => RequestResult<AddDomainResponses, AddDomainErrors, ThrowOnError>;
|
|
907
|
-
/**
|
|
908
|
-
* Remove a custom domain.
|
|
909
|
-
*
|
|
910
|
-
* Detaches a custom domain from the caller's project and deletes its record.
|
|
911
|
-
*/
|
|
912
|
-
export declare const deleteDomain: <ThrowOnError extends boolean = false>(options: Options<DeleteDomainData, ThrowOnError>) => RequestResult<DeleteDomainResponses, DeleteDomainErrors, ThrowOnError>;
|
|
913
|
-
/**
|
|
914
|
-
* Get a custom domain.
|
|
915
|
-
*
|
|
916
|
-
* Returns a single custom domain by id, scoped to the caller's project.
|
|
917
|
-
*/
|
|
918
|
-
export declare const getDomain: <ThrowOnError extends boolean = false>(options: Options<GetDomainData, ThrowOnError>) => RequestResult<GetDomainResponses, GetDomainErrors, ThrowOnError>;
|
|
919
|
-
/**
|
|
920
|
-
* Provision SSL for a domain.
|
|
422
|
+
* Send a raw email.
|
|
921
423
|
*
|
|
922
|
-
*
|
|
923
|
-
*
|
|
424
|
+
* Sends an HTML email without a stored template. Requires the `email:send`
|
|
425
|
+
* scope.
|
|
924
426
|
*/
|
|
925
|
-
export declare const
|
|
427
|
+
export declare const sendRawEmail: <ThrowOnError extends boolean = false>(options: Options<SendRawEmailData, ThrowOnError>) => RequestResult<SendRawEmailResponses, SendRawEmailErrors, ThrowOnError>;
|
|
926
428
|
/**
|
|
927
|
-
*
|
|
429
|
+
* Send a templated email.
|
|
928
430
|
*
|
|
929
|
-
*
|
|
930
|
-
*
|
|
931
|
-
* or a configured `SCALIX_EDGE_IP`). On success, marks the domain active. This is
|
|
932
|
-
* the industry-standard "does it point at us" check (Vercel/Netlify/Render).
|
|
431
|
+
* Renders `template` with `data` and sends it to `to`. Requires the
|
|
432
|
+
* `email:send` scope.
|
|
933
433
|
*/
|
|
934
|
-
export declare const
|
|
434
|
+
export declare const sendTransactionalEmail: <ThrowOnError extends boolean = false>(options: Options<SendTransactionalEmailData, ThrowOnError>) => RequestResult<SendTransactionalEmailResponses, SendTransactionalEmailErrors, ThrowOnError>;
|
|
935
435
|
/**
|
|
936
|
-
* List
|
|
436
|
+
* List email templates.
|
|
937
437
|
*
|
|
938
|
-
* Returns
|
|
438
|
+
* Returns the org's stored templates. Requires the `email:read` scope.
|
|
939
439
|
*/
|
|
940
|
-
export declare const
|
|
440
|
+
export declare const listEmailTemplates: <ThrowOnError extends boolean = false>(options?: Options<ListEmailTemplatesData, ThrowOnError>) => RequestResult<ListEmailTemplatesResponses, ListEmailTemplatesErrors, ThrowOnError>;
|
|
941
441
|
/**
|
|
942
|
-
*
|
|
442
|
+
* Create an email template.
|
|
943
443
|
*
|
|
944
|
-
*
|
|
444
|
+
* Stores a new template for the org. Requires the `email:write` scope.
|
|
945
445
|
*/
|
|
946
|
-
export declare const
|
|
446
|
+
export declare const createEmailTemplate: <ThrowOnError extends boolean = false>(options: Options<CreateEmailTemplateData, ThrowOnError>) => RequestResult<CreateEmailTemplateResponses, CreateEmailTemplateErrors, ThrowOnError>;
|
|
947
447
|
/**
|
|
948
|
-
*
|
|
448
|
+
* Delete an email template.
|
|
949
449
|
*
|
|
950
|
-
*
|
|
450
|
+
* Removes a stored template. Requires the `email:write` scope.
|
|
951
451
|
*/
|
|
952
|
-
export declare const
|
|
452
|
+
export declare const deleteEmailTemplate: <ThrowOnError extends boolean = false>(options: Options<DeleteEmailTemplateData, ThrowOnError>) => RequestResult<DeleteEmailTemplateResponses, DeleteEmailTemplateErrors, ThrowOnError>;
|
|
953
453
|
/**
|
|
954
|
-
*
|
|
454
|
+
* Update an email template.
|
|
955
455
|
*
|
|
956
|
-
*
|
|
456
|
+
* Replaces a stored template. Requires the `email:write` scope.
|
|
957
457
|
*/
|
|
958
|
-
export declare const
|
|
458
|
+
export declare const updateEmailTemplate: <ThrowOnError extends boolean = false>(options: Options<UpdateEmailTemplateData, ThrowOnError>) => RequestResult<UpdateEmailTemplateResponses, UpdateEmailTemplateErrors, ThrowOnError>;
|
|
959
459
|
/**
|
|
960
460
|
* Delete a subscription.
|
|
961
461
|
*
|
|
@@ -1070,60 +570,6 @@ export declare const invokeFunction: <ThrowOnError extends boolean = false>(opti
|
|
|
1070
570
|
* Returns log output for a serverless function.
|
|
1071
571
|
*/
|
|
1072
572
|
export declare const getFunctionLogs: <ThrowOnError extends boolean = false>(options: Options<GetFunctionLogsData, ThrowOnError>) => RequestResult<GetFunctionLogsResponses, GetFunctionLogsErrors, ThrowOnError>;
|
|
1073
|
-
/**
|
|
1074
|
-
* List source-control integrations.
|
|
1075
|
-
*
|
|
1076
|
-
* Returns all GitHub/GitLab/Bitbucket integrations attached to the caller's
|
|
1077
|
-
* project.
|
|
1078
|
-
*/
|
|
1079
|
-
export declare const listIntegrations: <ThrowOnError extends boolean = false>(options?: Options<ListIntegrationsData, ThrowOnError>) => RequestResult<ListIntegrationsResponses, ListIntegrationsErrors, ThrowOnError>;
|
|
1080
|
-
/**
|
|
1081
|
-
* Create a source-control integration.
|
|
1082
|
-
*
|
|
1083
|
-
* Attaches a Git provider repo to the caller's project and returns the created
|
|
1084
|
-
* integration plus the webhook URL and secret to configure on the provider.
|
|
1085
|
-
*/
|
|
1086
|
-
export declare const createIntegration: <ThrowOnError extends boolean = false>(options: Options<CreateIntegrationData, ThrowOnError>) => RequestResult<CreateIntegrationResponses, CreateIntegrationErrors, ThrowOnError>;
|
|
1087
|
-
/**
|
|
1088
|
-
* List GitHub App installations.
|
|
1089
|
-
*
|
|
1090
|
-
* Returns the GitHub App installations registered to the caller's project.
|
|
1091
|
-
*/
|
|
1092
|
-
export declare const listGithubInstallations: <ThrowOnError extends boolean = false>(options?: Options<ListGithubInstallationsData, ThrowOnError>) => RequestResult<ListGithubInstallationsResponses, ListGithubInstallationsErrors, ThrowOnError>;
|
|
1093
|
-
/**
|
|
1094
|
-
* Mint an installation token.
|
|
1095
|
-
*
|
|
1096
|
-
* Returns a short-lived GitHub App installation access token for an
|
|
1097
|
-
* installation owned by the caller's project.
|
|
1098
|
-
*/
|
|
1099
|
-
export declare const createGithubInstallationToken: <ThrowOnError extends boolean = false>(options: Options<CreateGithubInstallationTokenData, ThrowOnError>) => RequestResult<CreateGithubInstallationTokenResponses, CreateGithubInstallationTokenErrors, ThrowOnError>;
|
|
1100
|
-
/**
|
|
1101
|
-
* List accessible GitHub repos.
|
|
1102
|
-
*
|
|
1103
|
-
* Returns the repositories the project's GitHub App installations can access,
|
|
1104
|
-
* aggregated across all active installations.
|
|
1105
|
-
*/
|
|
1106
|
-
export declare const listGithubRepos: <ThrowOnError extends boolean = false>(options?: Options<ListGithubReposData, ThrowOnError>) => RequestResult<ListGithubReposResponses, ListGithubReposErrors, ThrowOnError>;
|
|
1107
|
-
/**
|
|
1108
|
-
* Delete a source-control integration.
|
|
1109
|
-
*
|
|
1110
|
-
* Detaches a Git provider repo from the caller's project and deletes the
|
|
1111
|
-
* integration record.
|
|
1112
|
-
*/
|
|
1113
|
-
export declare const deleteIntegration: <ThrowOnError extends boolean = false>(options: Options<DeleteIntegrationData, ThrowOnError>) => RequestResult<DeleteIntegrationResponses, DeleteIntegrationErrors, ThrowOnError>;
|
|
1114
|
-
/**
|
|
1115
|
-
* Get a source-control integration.
|
|
1116
|
-
*
|
|
1117
|
-
* Returns a single integration by id, scoped to the caller's project.
|
|
1118
|
-
*/
|
|
1119
|
-
export declare const getIntegration: <ThrowOnError extends boolean = false>(options: Options<GetIntegrationData, ThrowOnError>) => RequestResult<GetIntegrationResponses, GetIntegrationErrors, ThrowOnError>;
|
|
1120
|
-
/**
|
|
1121
|
-
* Update a source-control integration.
|
|
1122
|
-
*
|
|
1123
|
-
* Updates an integration's build/deploy settings (branch filter, auto-build,
|
|
1124
|
-
* auto-deploy, preview, status) and returns the updated record.
|
|
1125
|
-
*/
|
|
1126
|
-
export declare const updateIntegration: <ThrowOnError extends boolean = false>(options: Options<UpdateIntegrationData, ThrowOnError>) => RequestResult<UpdateIntegrationResponses, UpdateIntegrationErrors, ThrowOnError>;
|
|
1127
573
|
/**
|
|
1128
574
|
* Delete keys.
|
|
1129
575
|
*
|
|
@@ -1154,168 +600,6 @@ export declare const kvKeys: <ThrowOnError extends boolean = false>(options: Opt
|
|
|
1154
600
|
* Writes a value to the tenant's key-value store, with an optional TTL.
|
|
1155
601
|
*/
|
|
1156
602
|
export declare const kvSet: <ThrowOnError extends boolean = false>(options: Options<KvSetData, ThrowOnError>) => RequestResult<KvSetResponses, KvSetErrors, ThrowOnError>;
|
|
1157
|
-
/**
|
|
1158
|
-
* List load balancers.
|
|
1159
|
-
*
|
|
1160
|
-
* Returns all load balancers belonging to the caller's project.
|
|
1161
|
-
*/
|
|
1162
|
-
export declare const listLoadBalancers: <ThrowOnError extends boolean = false>(options?: Options<ListLoadBalancersData, ThrowOnError>) => RequestResult<ListLoadBalancersResponses, ListLoadBalancersErrors, ThrowOnError>;
|
|
1163
|
-
/**
|
|
1164
|
-
* Create a load balancer.
|
|
1165
|
-
*
|
|
1166
|
-
* Provisions a load balancer for the caller's project and returns its details.
|
|
1167
|
-
*/
|
|
1168
|
-
export declare const createLoadBalancer: <ThrowOnError extends boolean = false>(options: Options<CreateLoadBalancerData, ThrowOnError>) => RequestResult<CreateLoadBalancerResponses, CreateLoadBalancerErrors, ThrowOnError>;
|
|
1169
|
-
/**
|
|
1170
|
-
* Delete a load balancer.
|
|
1171
|
-
*
|
|
1172
|
-
* Removes a load balancer and its backends by id.
|
|
1173
|
-
*/
|
|
1174
|
-
export declare const deleteLoadBalancer: <ThrowOnError extends boolean = false>(options: Options<DeleteLoadBalancerData, ThrowOnError>) => RequestResult<DeleteLoadBalancerResponses, DeleteLoadBalancerErrors, ThrowOnError>;
|
|
1175
|
-
/**
|
|
1176
|
-
* Get a load balancer.
|
|
1177
|
-
*
|
|
1178
|
-
* Returns a single load balancer by id.
|
|
1179
|
-
*/
|
|
1180
|
-
export declare const getLoadBalancer: <ThrowOnError extends boolean = false>(options: Options<GetLoadBalancerData, ThrowOnError>) => RequestResult<GetLoadBalancerResponses, GetLoadBalancerErrors, ThrowOnError>;
|
|
1181
|
-
/**
|
|
1182
|
-
* Add a backend to a load balancer.
|
|
1183
|
-
*
|
|
1184
|
-
* Registers a backend target on the load balancer and returns its details.
|
|
1185
|
-
*/
|
|
1186
|
-
export declare const addLoadBalancerBackend: <ThrowOnError extends boolean = false>(options: Options<AddLoadBalancerBackendData, ThrowOnError>) => RequestResult<AddLoadBalancerBackendResponses, AddLoadBalancerBackendErrors, ThrowOnError>;
|
|
1187
|
-
/**
|
|
1188
|
-
* Remove a backend from a load balancer.
|
|
1189
|
-
*
|
|
1190
|
-
* Deletes a backend target from the load balancer by id.
|
|
1191
|
-
*/
|
|
1192
|
-
export declare const removeLoadBalancerBackend: <ThrowOnError extends boolean = false>(options: Options<RemoveLoadBalancerBackendData, ThrowOnError>) => RequestResult<RemoveLoadBalancerBackendResponses, RemoveLoadBalancerBackendErrors, ThrowOnError>;
|
|
1193
|
-
/**
|
|
1194
|
-
* Describe the current token.
|
|
1195
|
-
*
|
|
1196
|
-
* Returns the caller's identity, effective permissions and scopes, the MCP
|
|
1197
|
-
* tools their scopes unlock, and their plan's rate-limit and API-key ceilings.
|
|
1198
|
-
*/
|
|
1199
|
-
export declare const getMe: <ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>) => RequestResult<GetMeResponses, GetMeErrors, ThrowOnError>;
|
|
1200
|
-
/**
|
|
1201
|
-
* Check the registry API version.
|
|
1202
|
-
*
|
|
1203
|
-
* Returns the OCI Distribution API version supported by the registry.
|
|
1204
|
-
*/
|
|
1205
|
-
export declare const registryVersionCheck: <ThrowOnError extends boolean = false>(options?: Options<RegistryVersionCheckData, ThrowOnError>) => RequestResult<RegistryVersionCheckResponses, RegistryVersionCheckErrors, ThrowOnError>;
|
|
1206
|
-
/**
|
|
1207
|
-
* List the repository catalog.
|
|
1208
|
-
*
|
|
1209
|
-
* Returns the catalog of repositories in the registry.
|
|
1210
|
-
*/
|
|
1211
|
-
export declare const getRegistryCatalog: <ThrowOnError extends boolean = false>(options?: Options<GetRegistryCatalogData, ThrowOnError>) => RequestResult<GetRegistryCatalogResponses, GetRegistryCatalogErrors, ThrowOnError>;
|
|
1212
|
-
/**
|
|
1213
|
-
* Start a blob upload.
|
|
1214
|
-
*
|
|
1215
|
-
* Begins an OCI blob upload session and returns the upload location.
|
|
1216
|
-
*/
|
|
1217
|
-
export declare const startRegistryBlobUpload: <ThrowOnError extends boolean = false>(options: Options<StartRegistryBlobUploadData, ThrowOnError>) => RequestResult<StartRegistryBlobUploadResponses, StartRegistryBlobUploadErrors, ThrowOnError>;
|
|
1218
|
-
/**
|
|
1219
|
-
* Get a blob.
|
|
1220
|
-
*
|
|
1221
|
-
* Downloads an OCI blob by digest.
|
|
1222
|
-
*/
|
|
1223
|
-
export declare const getRegistryBlob: <ThrowOnError extends boolean = false>(options: Options<GetRegistryBlobData, ThrowOnError>) => RequestResult<GetRegistryBlobResponses, GetRegistryBlobErrors, ThrowOnError>;
|
|
1224
|
-
/**
|
|
1225
|
-
* Check a blob exists.
|
|
1226
|
-
*
|
|
1227
|
-
* Returns headers indicating whether an OCI blob exists.
|
|
1228
|
-
*/
|
|
1229
|
-
export declare const headRegistryBlob: <ThrowOnError extends boolean = false>(options: Options<HeadRegistryBlobData, ThrowOnError>) => RequestResult<HeadRegistryBlobResponses, HeadRegistryBlobErrors, ThrowOnError>;
|
|
1230
|
-
/**
|
|
1231
|
-
* Delete a manifest.
|
|
1232
|
-
*
|
|
1233
|
-
* Removes an OCI image manifest by tag or digest.
|
|
1234
|
-
*/
|
|
1235
|
-
export declare const deleteRegistryManifest: <ThrowOnError extends boolean = false>(options: Options<DeleteRegistryManifestData, ThrowOnError>) => RequestResult<DeleteRegistryManifestResponses, DeleteRegistryManifestErrors, ThrowOnError>;
|
|
1236
|
-
/**
|
|
1237
|
-
* Get a manifest.
|
|
1238
|
-
*
|
|
1239
|
-
* Returns an OCI image manifest by tag or digest.
|
|
1240
|
-
*/
|
|
1241
|
-
export declare const getRegistryManifest: <ThrowOnError extends boolean = false>(options: Options<GetRegistryManifestData, ThrowOnError>) => RequestResult<GetRegistryManifestResponses, GetRegistryManifestErrors, ThrowOnError>;
|
|
1242
|
-
/**
|
|
1243
|
-
* Check a manifest exists.
|
|
1244
|
-
*
|
|
1245
|
-
* Returns headers indicating whether an OCI manifest exists.
|
|
1246
|
-
*/
|
|
1247
|
-
export declare const headRegistryManifest: <ThrowOnError extends boolean = false>(options: Options<HeadRegistryManifestData, ThrowOnError>) => RequestResult<HeadRegistryManifestResponses, HeadRegistryManifestErrors, ThrowOnError>;
|
|
1248
|
-
/**
|
|
1249
|
-
* Store a manifest.
|
|
1250
|
-
*
|
|
1251
|
-
* Uploads an OCI image manifest under a tag or digest.
|
|
1252
|
-
*/
|
|
1253
|
-
export declare const putRegistryManifest: <ThrowOnError extends boolean = false>(options: Options<PutRegistryManifestData, ThrowOnError>) => RequestResult<PutRegistryManifestResponses, PutRegistryManifestErrors, ThrowOnError>;
|
|
1254
|
-
/**
|
|
1255
|
-
* List tags.
|
|
1256
|
-
*
|
|
1257
|
-
* Returns the tags available for a repository.
|
|
1258
|
-
*/
|
|
1259
|
-
export declare const listRegistryTags: <ThrowOnError extends boolean = false>(options: Options<ListRegistryTagsData, ThrowOnError>) => RequestResult<ListRegistryTagsResponses, ListRegistryTagsErrors, ThrowOnError>;
|
|
1260
|
-
/**
|
|
1261
|
-
* List Scalix Run services.
|
|
1262
|
-
*
|
|
1263
|
-
* Returns all Scalix Run services for the caller's project.
|
|
1264
|
-
*/
|
|
1265
|
-
export declare const listServices: <ThrowOnError extends boolean = false>(options?: Options<ListServicesData, ThrowOnError>) => RequestResult<ListServicesResponses, ListServicesErrors, ThrowOnError>;
|
|
1266
|
-
/**
|
|
1267
|
-
* Deploy a Scalix Run service.
|
|
1268
|
-
*
|
|
1269
|
-
* Deploys a Scalix Run service and returns the created service.
|
|
1270
|
-
*/
|
|
1271
|
-
export declare const createService: <ThrowOnError extends boolean = false>(options: Options<CreateServiceData, ThrowOnError>) => RequestResult<CreateServiceResponses, CreateServiceErrors, ThrowOnError>;
|
|
1272
|
-
/**
|
|
1273
|
-
* Delete a Scalix Run service.
|
|
1274
|
-
*
|
|
1275
|
-
* Removes a Scalix Run service by id.
|
|
1276
|
-
*/
|
|
1277
|
-
export declare const deleteService: <ThrowOnError extends boolean = false>(options: Options<DeleteServiceData, ThrowOnError>) => RequestResult<DeleteServiceResponses, DeleteServiceErrors, ThrowOnError>;
|
|
1278
|
-
/**
|
|
1279
|
-
* Get a Scalix Run service.
|
|
1280
|
-
*
|
|
1281
|
-
* Returns a single Scalix Run service by id.
|
|
1282
|
-
*/
|
|
1283
|
-
export declare const getService: <ThrowOnError extends boolean = false>(options: Options<GetServiceData, ThrowOnError>) => RequestResult<GetServiceResponses, GetServiceErrors, ThrowOnError>;
|
|
1284
|
-
/**
|
|
1285
|
-
* Update a Scalix Run service.
|
|
1286
|
-
*
|
|
1287
|
-
* Updates a Scalix Run service (e.g. scaling) and returns the new state.
|
|
1288
|
-
*/
|
|
1289
|
-
export declare const updateService: <ThrowOnError extends boolean = false>(options: Options<UpdateServiceData, ThrowOnError>) => RequestResult<UpdateServiceResponses, UpdateServiceErrors, ThrowOnError>;
|
|
1290
|
-
/**
|
|
1291
|
-
* List service instances.
|
|
1292
|
-
*
|
|
1293
|
-
* Returns the running instances of a Scalix Run service.
|
|
1294
|
-
*/
|
|
1295
|
-
export declare const listServiceInstances: <ThrowOnError extends boolean = false>(options: Options<ListServiceInstancesData, ThrowOnError>) => RequestResult<ListServiceInstancesResponses, ListServiceInstancesErrors, ThrowOnError>;
|
|
1296
|
-
/**
|
|
1297
|
-
* Get service live instance state.
|
|
1298
|
-
*
|
|
1299
|
-
* Returns healthy/total instance counts and in-flight request totals for a
|
|
1300
|
-
* Scalix Run service. Request-level RED metrics (requests/sec, errors/sec,
|
|
1301
|
-
* latency percentiles) are served by
|
|
1302
|
-
* `GET /v1/metering/services/run-service/{id}/metrics`, whose response
|
|
1303
|
-
* carries `available:false` with a message when the deployment has no
|
|
1304
|
-
* metrics backend.
|
|
1305
|
-
*/
|
|
1306
|
-
export declare const getServiceMetrics: <ThrowOnError extends boolean = false>(options: Options<GetServiceMetricsData, ThrowOnError>) => RequestResult<GetServiceMetricsResponses, GetServiceMetricsErrors, ThrowOnError>;
|
|
1307
|
-
/**
|
|
1308
|
-
* List service revisions.
|
|
1309
|
-
*
|
|
1310
|
-
* Returns the revision history of a Scalix Run service.
|
|
1311
|
-
*/
|
|
1312
|
-
export declare const listServiceRevisions: <ThrowOnError extends boolean = false>(options: Options<ListServiceRevisionsData, ThrowOnError>) => RequestResult<ListServiceRevisionsResponses, ListServiceRevisionsErrors, ThrowOnError>;
|
|
1313
|
-
/**
|
|
1314
|
-
* Roll back a service.
|
|
1315
|
-
*
|
|
1316
|
-
* Rolls a Scalix Run service back to a previous revision.
|
|
1317
|
-
*/
|
|
1318
|
-
export declare const rollbackService: <ThrowOnError extends boolean = false>(options: Options<RollbackServiceData, ThrowOnError>) => RequestResult<RollbackServiceResponses, RollbackServiceErrors, ThrowOnError>;
|
|
1319
603
|
/**
|
|
1320
604
|
* List your sandboxes.
|
|
1321
605
|
*/
|
|
@@ -1360,118 +644,6 @@ export declare const sandboxReadFile: <ThrowOnError extends boolean = false>(opt
|
|
|
1360
644
|
* This endpoint returns 501 until snapshots ship (demand-gated).
|
|
1361
645
|
*/
|
|
1362
646
|
export declare const sandboxSnapshot: <ThrowOnError extends boolean = false>(options: Options<SandboxSnapshotData, ThrowOnError>) => RequestResult<unknown, SandboxSnapshotErrors, ThrowOnError>;
|
|
1363
|
-
/**
|
|
1364
|
-
* Run a search.
|
|
1365
|
-
*
|
|
1366
|
-
* Runs a query against the curated Scalix Search index and returns ranked results.
|
|
1367
|
-
*/
|
|
1368
|
-
export declare const searchIndex: <ThrowOnError extends boolean = false>(options?: Options<SearchIndexData, ThrowOnError>) => RequestResult<SearchIndexResponses, SearchIndexErrors, ThrowOnError>;
|
|
1369
|
-
/**
|
|
1370
|
-
* Run a search ingest.
|
|
1371
|
-
*
|
|
1372
|
-
* Triggers an ingest run that crawls and indexes registered sources.
|
|
1373
|
-
*/
|
|
1374
|
-
export declare const runSearchIngest: <ThrowOnError extends boolean = false>(options?: Options<RunSearchIngestData, ThrowOnError>) => RequestResult<RunSearchIngestResponses, RunSearchIngestErrors, ThrowOnError>;
|
|
1375
|
-
/**
|
|
1376
|
-
* List search sources.
|
|
1377
|
-
*
|
|
1378
|
-
* Returns the curated sources registered in the search index.
|
|
1379
|
-
*/
|
|
1380
|
-
export declare const listSearchSources: <ThrowOnError extends boolean = false>(options?: Options<ListSearchSourcesData, ThrowOnError>) => RequestResult<ListSearchSourcesResponses, ListSearchSourcesErrors, ThrowOnError>;
|
|
1381
|
-
/**
|
|
1382
|
-
* Upsert a search source.
|
|
1383
|
-
*
|
|
1384
|
-
* Creates or updates a curated source in the search index.
|
|
1385
|
-
*/
|
|
1386
|
-
export declare const upsertSearchSource: <ThrowOnError extends boolean = false>(options: Options<UpsertSearchSourceData, ThrowOnError>) => RequestResult<UpsertSearchSourceResponses, UpsertSearchSourceErrors, ThrowOnError>;
|
|
1387
|
-
/**
|
|
1388
|
-
* Get search stats.
|
|
1389
|
-
*
|
|
1390
|
-
* Returns statistics about the search index.
|
|
1391
|
-
*/
|
|
1392
|
-
export declare const getSearchStats: <ThrowOnError extends boolean = false>(options?: Options<GetSearchStatsData, ThrowOnError>) => RequestResult<GetSearchStatsResponses, GetSearchStatsErrors, ThrowOnError>;
|
|
1393
|
-
/**
|
|
1394
|
-
* Get Shield config.
|
|
1395
|
-
*
|
|
1396
|
-
* Returns the Shield configuration (default action, challenge settings) for the
|
|
1397
|
-
* caller's project.
|
|
1398
|
-
*/
|
|
1399
|
-
export declare const getShieldConfig: <ThrowOnError extends boolean = false>(options?: Options<GetShieldConfigData, ThrowOnError>) => RequestResult<GetShieldConfigResponses, GetShieldConfigErrors, ThrowOnError>;
|
|
1400
|
-
/**
|
|
1401
|
-
* Update Shield config.
|
|
1402
|
-
*
|
|
1403
|
-
* Replaces the Shield configuration for the caller's project. Requires the Pro
|
|
1404
|
-
* plan or higher.
|
|
1405
|
-
*/
|
|
1406
|
-
export declare const updateShieldConfig: <ThrowOnError extends boolean = false>(options: Options<UpdateShieldConfigData, ThrowOnError>) => RequestResult<UpdateShieldConfigResponses, UpdateShieldConfigErrors, ThrowOnError>;
|
|
1407
|
-
/**
|
|
1408
|
-
* List Shield crawlers.
|
|
1409
|
-
*
|
|
1410
|
-
* Returns the known AI crawlers with their per-project policy and traffic
|
|
1411
|
-
* stats, plus any custom user-defined crawler rules.
|
|
1412
|
-
*/
|
|
1413
|
-
export declare const listShieldCrawlers: <ThrowOnError extends boolean = false>(options?: Options<ListShieldCrawlersData, ThrowOnError>) => RequestResult<ListShieldCrawlersResponses, ListShieldCrawlersErrors, ThrowOnError>;
|
|
1414
|
-
/**
|
|
1415
|
-
* Set a crawler's verification IP ranges.
|
|
1416
|
-
*
|
|
1417
|
-
* Sets the IP addresses or CIDR ranges used to verify a crawler's source IP.
|
|
1418
|
-
* Requires the Pro plan or higher.
|
|
1419
|
-
*/
|
|
1420
|
-
export declare const setShieldCrawlerIpRanges: <ThrowOnError extends boolean = false>(options: Options<SetShieldCrawlerIpRangesData, ThrowOnError>) => RequestResult<SetShieldCrawlerIpRangesResponses, SetShieldCrawlerIpRangesErrors, ThrowOnError>;
|
|
1421
|
-
/**
|
|
1422
|
-
* Clear a crawler policy.
|
|
1423
|
-
*
|
|
1424
|
-
* Removes the access policy for a crawler, reverting it to the project default.
|
|
1425
|
-
* Policy controls require the Pro plan or higher.
|
|
1426
|
-
*/
|
|
1427
|
-
export declare const clearShieldCrawlerPolicy: <ThrowOnError extends boolean = false>(options: Options<ClearShieldCrawlerPolicyData, ThrowOnError>) => RequestResult<ClearShieldCrawlerPolicyResponses, ClearShieldCrawlerPolicyErrors, ThrowOnError>;
|
|
1428
|
-
/**
|
|
1429
|
-
* Set a crawler policy.
|
|
1430
|
-
*
|
|
1431
|
-
* Sets the access policy (allow / block / rate-limit) for a known crawler in
|
|
1432
|
-
* the caller's project. Policy controls require the Pro plan or higher.
|
|
1433
|
-
*/
|
|
1434
|
-
export declare const setShieldCrawlerPolicy: <ThrowOnError extends boolean = false>(options: Options<SetShieldCrawlerPolicyData, ThrowOnError>) => RequestResult<SetShieldCrawlerPolicyResponses, SetShieldCrawlerPolicyErrors, ThrowOnError>;
|
|
1435
|
-
/**
|
|
1436
|
-
* Create a custom Shield rule.
|
|
1437
|
-
*
|
|
1438
|
-
* Adds a customer-defined crawler rule matched by User-Agent substring, with
|
|
1439
|
-
* its own access policy. Requires the Pro plan or higher.
|
|
1440
|
-
*/
|
|
1441
|
-
export declare const createShieldCustomRule: <ThrowOnError extends boolean = false>(options: Options<CreateShieldCustomRuleData, ThrowOnError>) => RequestResult<CreateShieldCustomRuleResponses, CreateShieldCustomRuleErrors, ThrowOnError>;
|
|
1442
|
-
/**
|
|
1443
|
-
* Delete a custom Shield rule.
|
|
1444
|
-
*
|
|
1445
|
-
* Removes a custom crawler rule by id. Requires the Pro plan or higher.
|
|
1446
|
-
*/
|
|
1447
|
-
export declare const deleteShieldCustomRule: <ThrowOnError extends boolean = false>(options: Options<DeleteShieldCustomRuleData, ThrowOnError>) => RequestResult<DeleteShieldCustomRuleResponses, DeleteShieldCustomRuleErrors, ThrowOnError>;
|
|
1448
|
-
/**
|
|
1449
|
-
* Update a custom Shield rule.
|
|
1450
|
-
*
|
|
1451
|
-
* Updates the access policy of an existing custom crawler rule. Requires the
|
|
1452
|
-
* Pro plan or higher.
|
|
1453
|
-
*/
|
|
1454
|
-
export declare const updateShieldCustomRule: <ThrowOnError extends boolean = false>(options: Options<UpdateShieldCustomRuleData, ThrowOnError>) => RequestResult<UpdateShieldCustomRuleResponses, UpdateShieldCustomRuleErrors, ThrowOnError>;
|
|
1455
|
-
/**
|
|
1456
|
-
* List Shield events.
|
|
1457
|
-
*
|
|
1458
|
-
* Returns recent Shield crawler events for the project, paginated.
|
|
1459
|
-
*/
|
|
1460
|
-
export declare const listShieldEvents: <ThrowOnError extends boolean = false>(options?: Options<ListShieldEventsData, ThrowOnError>) => RequestResult<ListShieldEventsResponses, ListShieldEventsErrors, ThrowOnError>;
|
|
1461
|
-
/**
|
|
1462
|
-
* Generate robots.txt.
|
|
1463
|
-
*
|
|
1464
|
-
* Returns a `robots.txt` file generated from the project's Shield crawler
|
|
1465
|
-
* policies.
|
|
1466
|
-
*/
|
|
1467
|
-
export declare const getShieldRobotsTxt: <ThrowOnError extends boolean = false>(options?: Options<GetShieldRobotsTxtData, ThrowOnError>) => RequestResult<GetShieldRobotsTxtResponses, GetShieldRobotsTxtErrors, ThrowOnError>;
|
|
1468
|
-
/**
|
|
1469
|
-
* Get Shield statistics.
|
|
1470
|
-
*
|
|
1471
|
-
* Returns aggregate request, block, and rate-limit counts broken down by
|
|
1472
|
-
* crawler for the caller's project.
|
|
1473
|
-
*/
|
|
1474
|
-
export declare const getShieldStats: <ThrowOnError extends boolean = false>(options?: Options<GetShieldStatsData, ThrowOnError>) => RequestResult<GetShieldStatsResponses, GetShieldStatsErrors, ThrowOnError>;
|
|
1475
647
|
/**
|
|
1476
648
|
* List buckets.
|
|
1477
649
|
*
|
|
@@ -1502,12 +674,6 @@ export declare const deleteObject: <ThrowOnError extends boolean = false>(option
|
|
|
1502
674
|
* Downloads the contents of an object from a bucket.
|
|
1503
675
|
*/
|
|
1504
676
|
export declare const getObject: <ThrowOnError extends boolean = false>(options: Options<GetObjectData, ThrowOnError>) => RequestResult<GetObjectResponses, GetObjectErrors, ThrowOnError>;
|
|
1505
|
-
/**
|
|
1506
|
-
* Get object metadata.
|
|
1507
|
-
*
|
|
1508
|
-
* Returns an object's metadata headers without its body.
|
|
1509
|
-
*/
|
|
1510
|
-
export declare const headObject: <ThrowOnError extends boolean = false>(options: Options<HeadObjectData, ThrowOnError>) => RequestResult<HeadObjectResponses, HeadObjectErrors, ThrowOnError>;
|
|
1511
677
|
/**
|
|
1512
678
|
* Upload an object.
|
|
1513
679
|
*
|
|
@@ -1533,118 +699,4 @@ export declare const presignObject: <ThrowOnError extends boolean = false>(optio
|
|
|
1533
699
|
* current billing month. Requires the `metering:read` scope.
|
|
1534
700
|
*/
|
|
1535
701
|
export declare const getKeysUsage: <ThrowOnError extends boolean = false>(options?: Options<GetKeysUsageData, ThrowOnError>) => RequestResult<GetKeysUsageResponses, GetKeysUsageErrors, ThrowOnError>;
|
|
1536
|
-
/**
|
|
1537
|
-
* Get usage for one API key.
|
|
1538
|
-
*
|
|
1539
|
-
* Returns the request count for a single API key this billing month. Requires
|
|
1540
|
-
* the `metering:read` scope; the key must belong to the caller's org.
|
|
1541
|
-
*/
|
|
1542
|
-
export declare const getKeyUsage: <ThrowOnError extends boolean = false>(options: Options<GetKeyUsageData, ThrowOnError>) => RequestResult<GetKeyUsageResponses, GetKeyUsageErrors, ThrowOnError>;
|
|
1543
|
-
/**
|
|
1544
|
-
* Get the caller's budget.
|
|
1545
|
-
*
|
|
1546
|
-
* Returns current usage (AI tokens, storage, compute hours), the plan's
|
|
1547
|
-
* allowances, and the remaining headroom for each.
|
|
1548
|
-
*/
|
|
1549
|
-
export declare const getUserBudget: <ThrowOnError extends boolean = false>(options?: Options<GetUserBudgetData, ThrowOnError>) => RequestResult<GetUserBudgetResponses, GetUserBudgetErrors, ThrowOnError>;
|
|
1550
|
-
/**
|
|
1551
|
-
* Get the caller's account profile.
|
|
1552
|
-
*
|
|
1553
|
-
* Returns the authenticated user's id, email, name, plan, and status. Fields
|
|
1554
|
-
* after `status` are present only when a stored user record exists.
|
|
1555
|
-
*/
|
|
1556
|
-
export declare const getUserInfo: <ThrowOnError extends boolean = false>(options?: Options<GetUserInfoData, ThrowOnError>) => RequestResult<GetUserInfoResponses, GetUserInfoErrors, ThrowOnError>;
|
|
1557
|
-
/**
|
|
1558
|
-
* Get the caller's usage stats.
|
|
1559
|
-
*
|
|
1560
|
-
* Returns a per-service usage breakdown (AI, storage, compute, bandwidth,
|
|
1561
|
-
* functions) for the current month.
|
|
1562
|
-
*/
|
|
1563
|
-
export declare const getUserStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserStatsData, ThrowOnError>) => RequestResult<GetUserStatsResponses, GetUserStatsErrors, ThrowOnError>;
|
|
1564
|
-
/**
|
|
1565
|
-
* List VPCs.
|
|
1566
|
-
*
|
|
1567
|
-
* Returns all VPCs belonging to the caller's project.
|
|
1568
|
-
*/
|
|
1569
|
-
export declare const listVpcs: <ThrowOnError extends boolean = false>(options?: Options<ListVpcsData, ThrowOnError>) => RequestResult<ListVpcsResponses, ListVpcsErrors, ThrowOnError>;
|
|
1570
|
-
/**
|
|
1571
|
-
* Create a VPC.
|
|
1572
|
-
*
|
|
1573
|
-
* Provisions a VPC for the caller's project. Currently returns 501 —
|
|
1574
|
-
* enforcement and durable storage are a planned capability.
|
|
1575
|
-
*/
|
|
1576
|
-
export declare const createVpc: <ThrowOnError extends boolean = false>(options: Options<CreateVpcData, ThrowOnError>) => RequestResult<CreateVpcResponses, CreateVpcErrors, ThrowOnError>;
|
|
1577
|
-
/**
|
|
1578
|
-
* Delete a VPC.
|
|
1579
|
-
*
|
|
1580
|
-
* Removes a VPC and its peers by id.
|
|
1581
|
-
*/
|
|
1582
|
-
export declare const deleteVpc: <ThrowOnError extends boolean = false>(options: Options<DeleteVpcData, ThrowOnError>) => RequestResult<DeleteVpcResponses, DeleteVpcErrors, ThrowOnError>;
|
|
1583
|
-
/**
|
|
1584
|
-
* Get a VPC.
|
|
1585
|
-
*
|
|
1586
|
-
* Returns a single VPC by id.
|
|
1587
|
-
*/
|
|
1588
|
-
export declare const getVpc: <ThrowOnError extends boolean = false>(options: Options<GetVpcData, ThrowOnError>) => RequestResult<GetVpcResponses, GetVpcErrors, ThrowOnError>;
|
|
1589
|
-
/**
|
|
1590
|
-
* Get a VPC's config.
|
|
1591
|
-
*
|
|
1592
|
-
* Returns the rendered VPN client configuration file for the VPC.
|
|
1593
|
-
*/
|
|
1594
|
-
export declare const getVpcConfig: <ThrowOnError extends boolean = false>(options: Options<GetVpcConfigData, ThrowOnError>) => RequestResult<GetVpcConfigResponses, GetVpcConfigErrors, ThrowOnError>;
|
|
1595
|
-
/**
|
|
1596
|
-
* List a VPC's peers.
|
|
1597
|
-
*
|
|
1598
|
-
* Returns all peers registered in the VPC.
|
|
1599
|
-
*/
|
|
1600
|
-
export declare const listVpcPeers: <ThrowOnError extends boolean = false>(options: Options<ListVpcPeersData, ThrowOnError>) => RequestResult<ListVpcPeersResponses, ListVpcPeersErrors, ThrowOnError>;
|
|
1601
|
-
/**
|
|
1602
|
-
* Add a peer to a VPC.
|
|
1603
|
-
*
|
|
1604
|
-
* Registers a peer in the VPC. Currently returns 501 — peer
|
|
1605
|
-
* enforcement and durable storage are a planned capability.
|
|
1606
|
-
*/
|
|
1607
|
-
export declare const addVpcPeer: <ThrowOnError extends boolean = false>(options: Options<AddVpcPeerData, ThrowOnError>) => RequestResult<AddVpcPeerResponses, AddVpcPeerErrors, ThrowOnError>;
|
|
1608
|
-
/**
|
|
1609
|
-
* Remove a peer from a VPC.
|
|
1610
|
-
*
|
|
1611
|
-
* Deletes a peer from the VPC by id.
|
|
1612
|
-
*/
|
|
1613
|
-
export declare const removeVpcPeer: <ThrowOnError extends boolean = false>(options: Options<RemoveVpcPeerData, ThrowOnError>) => RequestResult<RemoveVpcPeerResponses, RemoveVpcPeerErrors, ThrowOnError>;
|
|
1614
|
-
/**
|
|
1615
|
-
* List recent WAF events.
|
|
1616
|
-
*
|
|
1617
|
-
* Returns the most recent web application firewall events (up to 100).
|
|
1618
|
-
*/
|
|
1619
|
-
export declare const listWafEvents: <ThrowOnError extends boolean = false>(options?: Options<ListWafEventsData, ThrowOnError>) => RequestResult<ListWafEventsResponses, ListWafEventsErrors, ThrowOnError>;
|
|
1620
|
-
/**
|
|
1621
|
-
* List WAF rules.
|
|
1622
|
-
*
|
|
1623
|
-
* Returns all configured web application firewall rules.
|
|
1624
|
-
*/
|
|
1625
|
-
export declare const listWafRules: <ThrowOnError extends boolean = false>(options?: Options<ListWafRulesData, ThrowOnError>) => RequestResult<ListWafRulesResponses, ListWafRulesErrors, ThrowOnError>;
|
|
1626
|
-
/**
|
|
1627
|
-
* Create a WAF rule.
|
|
1628
|
-
*
|
|
1629
|
-
* Adds a new web application firewall rule and returns the created rule.
|
|
1630
|
-
*/
|
|
1631
|
-
export declare const createWafRule: <ThrowOnError extends boolean = false>(options: Options<CreateWafRuleData, ThrowOnError>) => RequestResult<CreateWafRuleResponses, CreateWafRuleErrors, ThrowOnError>;
|
|
1632
|
-
/**
|
|
1633
|
-
* Delete a WAF rule.
|
|
1634
|
-
*
|
|
1635
|
-
* Removes a web application firewall rule by id.
|
|
1636
|
-
*/
|
|
1637
|
-
export declare const deleteWafRule: <ThrowOnError extends boolean = false>(options: Options<DeleteWafRuleData, ThrowOnError>) => RequestResult<DeleteWafRuleResponses, DeleteWafRuleErrors, ThrowOnError>;
|
|
1638
|
-
/**
|
|
1639
|
-
* Update a WAF rule.
|
|
1640
|
-
*
|
|
1641
|
-
* Replaces the configuration of an existing web application firewall rule.
|
|
1642
|
-
*/
|
|
1643
|
-
export declare const updateWafRule: <ThrowOnError extends boolean = false>(options: Options<UpdateWafRuleData, ThrowOnError>) => RequestResult<UpdateWafRuleResponses, UpdateWafRuleErrors, ThrowOnError>;
|
|
1644
|
-
/**
|
|
1645
|
-
* Get WAF statistics.
|
|
1646
|
-
*
|
|
1647
|
-
* Returns combined web application firewall and DDoS-detector counters.
|
|
1648
|
-
*/
|
|
1649
|
-
export declare const getWafStats: <ThrowOnError extends boolean = false>(options?: Options<GetWafStatsData, ThrowOnError>) => RequestResult<GetWafStatsResponses, GetWafStatsErrors, ThrowOnError>;
|
|
1650
702
|
//# sourceMappingURL=sdk.gen.d.ts.map
|