alchemy 0.83.3 → 0.85.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/bin/alchemy.js +1 -1
- package/lib/cloudflare/api-error.d.ts +11 -0
- package/lib/cloudflare/api-error.d.ts.map +1 -1
- package/lib/cloudflare/api-error.js +11 -0
- package/lib/cloudflare/api-error.js.map +1 -1
- package/lib/cloudflare/api.js +1 -1
- package/lib/cloudflare/api.js.map +1 -1
- package/lib/cloudflare/bindings.d.ts +12 -2
- package/lib/cloudflare/bindings.d.ts.map +1 -1
- package/lib/cloudflare/bindings.js.map +1 -1
- package/lib/cloudflare/bound.d.ts +2 -1
- package/lib/cloudflare/bound.d.ts.map +1 -1
- package/lib/cloudflare/d1-database.d.ts.map +1 -1
- package/lib/cloudflare/d1-database.js +9 -1
- package/lib/cloudflare/d1-database.js.map +1 -1
- package/lib/cloudflare/index.d.ts +1 -0
- package/lib/cloudflare/index.d.ts.map +1 -1
- package/lib/cloudflare/index.js +1 -0
- package/lib/cloudflare/index.js.map +1 -1
- package/lib/cloudflare/kv-namespace.d.ts.map +1 -1
- package/lib/cloudflare/kv-namespace.js +2 -2
- package/lib/cloudflare/kv-namespace.js.map +1 -1
- package/lib/cloudflare/miniflare/build-worker-options.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/build-worker-options.js +15 -0
- package/lib/cloudflare/miniflare/build-worker-options.js.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-controller.d.ts +1 -1
- package/lib/cloudflare/miniflare/miniflare-controller.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.js +41 -3
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.js.map +1 -1
- package/lib/cloudflare/vpc-service.d.ts +288 -0
- package/lib/cloudflare/vpc-service.d.ts.map +1 -0
- package/lib/cloudflare/vpc-service.js +238 -0
- package/lib/cloudflare/vpc-service.js.map +1 -0
- package/lib/cloudflare/worker-metadata.d.ts +1 -0
- package/lib/cloudflare/worker-metadata.d.ts.map +1 -1
- package/lib/cloudflare/worker-metadata.js +8 -0
- package/lib/cloudflare/worker-metadata.js.map +1 -1
- package/lib/cloudflare/worker-stub.d.ts.map +1 -1
- package/lib/cloudflare/worker-stub.js +8 -10
- package/lib/cloudflare/worker-stub.js.map +1 -1
- package/lib/cloudflare/worker-subdomain.d.ts +11 -8
- package/lib/cloudflare/worker-subdomain.d.ts.map +1 -1
- package/lib/cloudflare/worker-subdomain.js +16 -25
- package/lib/cloudflare/worker-subdomain.js.map +1 -1
- package/lib/cloudflare/worker.d.ts +16 -0
- package/lib/cloudflare/worker.d.ts.map +1 -1
- package/lib/cloudflare/worker.js +50 -24
- package/lib/cloudflare/worker.js.map +1 -1
- package/lib/cloudflare/wrangler.json.d.ts.map +1 -1
- package/lib/cloudflare/wrangler.json.js +9 -0
- package/lib/cloudflare/wrangler.json.js.map +1 -1
- package/lib/planetscale/api/sdk.gen.d.ts +874 -190
- package/lib/planetscale/api/sdk.gen.d.ts.map +1 -1
- package/lib/planetscale/api/sdk.gen.js +1250 -306
- package/lib/planetscale/api/sdk.gen.js.map +1 -1
- package/lib/planetscale/api/types.gen.d.ts +8241 -4128
- package/lib/planetscale/api/types.gen.d.ts.map +1 -1
- package/lib/planetscale/branch.js +4 -4
- package/lib/planetscale/branch.js.map +1 -1
- package/lib/planetscale/database.d.ts +43 -24
- package/lib/planetscale/database.d.ts.map +1 -1
- package/lib/planetscale/database.js +39 -18
- package/lib/planetscale/database.js.map +1 -1
- package/lib/planetscale/default-role.d.ts +51 -0
- package/lib/planetscale/default-role.d.ts.map +1 -0
- package/lib/planetscale/default-role.js +100 -0
- package/lib/planetscale/default-role.js.map +1 -0
- package/lib/planetscale/index.d.ts +1 -0
- package/lib/planetscale/index.d.ts.map +1 -1
- package/lib/planetscale/index.js +1 -0
- package/lib/planetscale/index.js.map +1 -1
- package/lib/planetscale/organization.js +1 -1
- package/lib/planetscale/organization.js.map +1 -1
- package/lib/planetscale/role.d.ts +1 -1
- package/lib/planetscale/role.d.ts.map +1 -1
- package/lib/planetscale/role.js +1 -1
- package/lib/planetscale/role.js.map +1 -1
- package/lib/planetscale/utils.d.ts +1 -1
- package/lib/planetscale/utils.d.ts.map +1 -1
- package/lib/planetscale/utils.js +9 -10
- package/lib/planetscale/utils.js.map +1 -1
- package/lib/state/sqlite-state-store.js +2 -0
- package/lib/state/sqlite-state-store.js.map +1 -1
- package/package.json +2 -2
- package/src/cloudflare/api-error.ts +19 -0
- package/src/cloudflare/api.ts +1 -1
- package/src/cloudflare/bindings.ts +15 -2
- package/src/cloudflare/bound.ts +6 -3
- package/src/cloudflare/d1-database.ts +11 -4
- package/src/cloudflare/index.ts +1 -0
- package/src/cloudflare/kv-namespace.ts +6 -2
- package/src/cloudflare/miniflare/build-worker-options.ts +30 -18
- package/src/cloudflare/miniflare/miniflare-worker-proxy.ts +47 -2
- package/src/cloudflare/vpc-service.ts +466 -0
- package/src/cloudflare/worker-metadata.ts +8 -0
- package/src/cloudflare/worker-stub.ts +9 -11
- package/src/cloudflare/worker-subdomain.ts +29 -34
- package/src/cloudflare/worker.ts +170 -98
- package/src/cloudflare/wrangler.json.ts +8 -0
- package/src/planetscale/api/sdk.gen.ts +2331 -987
- package/src/planetscale/api/types.gen.ts +8980 -4574
- package/src/planetscale/branch.ts +4 -4
- package/src/planetscale/database.ts +87 -46
- package/src/planetscale/default-role.ts +162 -0
- package/src/planetscale/index.ts +1 -0
- package/src/planetscale/organization.ts +1 -1
- package/src/planetscale/role.ts +3 -2
- package/src/planetscale/utils.ts +10 -10
- package/src/state/sqlite-state-store.ts +2 -0
- package/workers/tunnel-proxy.js +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from "../../util/api/client/index.ts";
|
|
2
|
-
import type { CancelBranchChangeRequestData, CancelBranchChangeRequestErrors, CancelBranchChangeRequestResponses, CancelDeployRequestData, CancelDeployRequestErrors, CancelDeployRequestResponses, CloseDeployRequestData, CloseDeployRequestErrors, CloseDeployRequestResponses, CompleteErroredDeployData, CompleteErroredDeployErrors, CompleteErroredDeployResponses, CompleteGatedDeployRequestData, CompleteGatedDeployRequestErrors, CompleteGatedDeployRequestResponses, CompleteRevertData, CompleteRevertErrors, CompleteRevertResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateBranchData, CreateBranchErrors, CreateBranchResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabaseResponses, CreateDeployRequestData, CreateDeployRequestErrors, CreateDeployRequestResponses, CreateKeyspaceData, CreateKeyspaceErrors, CreateKeyspaceResponses, CreateOauthTokenData, CreateOauthTokenErrors, CreateOauthTokenResponses, CreatePasswordData, CreatePasswordErrors, CreatePasswordResponses, CreateQueryPatternsReportData, CreateQueryPatternsReportErrors, CreateQueryPatternsReportResponses, CreateRoleData, CreateRoleErrors, CreateRoleResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteBranchData, DeleteBranchErrors, DeleteBranchResponses, DeleteDatabaseData, DeleteDatabaseErrors, DeleteDatabaseResponses, DeleteKeyspaceData, DeleteKeyspaceErrors, DeleteKeyspaceResponses, DeleteOauthTokenData, DeleteOauthTokenErrors, DeleteOauthTokenResponses, DeletePasswordData, DeletePasswordErrors, DeletePasswordResponses, DeleteQueryPatternsReportData, DeleteQueryPatternsReportErrors, DeleteQueryPatternsReportResponses, DeleteRoleData, DeleteRoleErrors, DeleteRoleResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DemoteBranchData, DemoteBranchErrors, DemoteBranchResponses, DisableSafeMigrationsData, DisableSafeMigrationsErrors, DisableSafeMigrationsResponses, EnableSafeMigrationsData, EnableSafeMigrationsErrors, EnableSafeMigrationsResponses, GetBackupData, GetBackupErrors, GetBackupResponses, GetBranchData, GetBranchErrors, GetBranchResponses, GetBranchSchemaData, GetBranchSchemaErrors, GetBranchSchemaResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseData, GetDatabaseErrors, GetDatabaseResponses, GetDatabaseThrottlerData, GetDatabaseThrottlerErrors, GetDatabaseThrottlerResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentResponses, GetDeployQueueData, GetDeployQueueErrors, GetDeployQueueResponses, GetDeployRequestData, GetDeployRequestErrors, GetDeployRequestResponses, GetDeployRequestThrottlerData, GetDeployRequestThrottlerErrors, GetDeployRequestThrottlerResponses, GetInvoiceData, GetInvoiceErrors, GetInvoiceLineItemsData, GetInvoiceLineItemsErrors, GetInvoiceLineItemsResponses, GetInvoiceResponses, GetKeyspaceData, GetKeyspaceErrors, GetKeyspaceResponses, GetKeyspaceRolloutStatusData, GetKeyspaceRolloutStatusErrors, GetKeyspaceRolloutStatusResponses, GetKeyspaceVschemaData, GetKeyspaceVschemaErrors, GetKeyspaceVschemaResponses, GetOauthApplicationData, GetOauthApplicationErrors, GetOauthApplicationResponses, GetOauthTokenData, GetOauthTokenErrors, GetOauthTokenResponses, GetOrganizationData, GetOrganizationErrors, GetOrganizationResponses, GetPasswordData, GetPasswordErrors, GetPasswordResponses, GetQueryPatternsReportData, GetQueryPatternsReportErrors, GetQueryPatternsReportStatusData, GetQueryPatternsReportStatusErrors, GetQueryPatternsReportStatusResponses, GetRoleData, GetRoleErrors, GetRoleResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, LintBranchSchemaData, LintBranchSchemaErrors, LintBranchSchemaResponses, ListAuditLogsData, ListAuditLogsErrors, ListAuditLogsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListBranchChangeRequestsData, ListBranchChangeRequestsErrors, ListBranchChangeRequestsResponses, ListBranchesData, ListBranchesErrors, ListBranchesResponses, ListDatabaseRegionsData, ListDatabaseRegionsErrors, ListDatabaseRegionsResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDeployOperationsData, ListDeployOperationsErrors, ListDeployOperationsResponses, ListDeployRequestReviewsData, ListDeployRequestReviewsErrors, ListDeployRequestReviewsResponses, ListDeployRequestsData, ListDeployRequestsErrors, ListDeployRequestsResponses, ListExtensionsData, ListExtensionsErrors, ListExtensionsResponses, ListGeneratedQueryPatternsReportsData, ListGeneratedQueryPatternsReportsErrors, ListGeneratedQueryPatternsReportsResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListKeyspaceResizesData, ListKeyspaceResizesErrors, ListKeyspaceResizesResponses, ListKeyspacesData, ListKeyspacesErrors, ListKeyspacesResponses, ListOauthApplicationsData, ListOauthApplicationsErrors, ListOauthApplicationsResponses, ListOauthTokensData, ListOauthTokensErrors, ListOauthTokensResponses, ListOrganizationMembersData, ListOrganizationMembersErrors, ListOrganizationMembersResponses, ListOrganizationsData, ListOrganizationsErrors, ListOrganizationsResponses, ListParametersData, ListParametersErrors, ListParametersResponses, ListPasswordsData, ListPasswordsErrors, ListPasswordsResponses, ListPublicRegionsData, ListPublicRegionsErrors, ListPublicRegionsResponses, ListReadOnlyRegionsData, ListReadOnlyRegionsErrors, ListReadOnlyRegionsResponses, ListRegionsForOrganizationData, ListRegionsForOrganizationErrors, ListRegionsForOrganizationResponses, ListRolesData, ListRolesErrors, ListRolesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, PromoteBranchData, PromoteBranchErrors, PromoteBranchResponses, QueueDeployRequestData, QueueDeployRequestErrors, QueueDeployRequestResponses, RenewPasswordData, RenewPasswordErrors, RenewPasswordResponses, RenewRoleData, RenewRoleErrors, RenewRoleResponses, ReviewDeployRequestData, ReviewDeployRequestErrors, ReviewDeployRequestResponses, SkipRevertPeriodData, SkipRevertPeriodErrors, SkipRevertPeriodResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAutoApplyData, UpdateAutoApplyErrors, UpdateAutoApplyResponses, UpdateBackupData, UpdateBackupErrors, UpdateBackupResponses, UpdateBranchChangeRequestData, UpdateBranchChangeRequestErrors, UpdateBranchChangeRequestResponses, UpdateBranchClusterConfigData, UpdateBranchClusterConfigErrors, UpdateBranchClusterConfigResponses, UpdateDatabaseSettingsData, UpdateDatabaseSettingsErrors, UpdateDatabaseSettingsResponses, UpdateDatabaseThrottlerData, UpdateDatabaseThrottlerErrors, UpdateDatabaseThrottlerResponses, UpdateDeployRequestThrottlerData, UpdateDeployRequestThrottlerErrors, UpdateDeployRequestThrottlerResponses, UpdateKeyspaceData, UpdateKeyspaceErrors, UpdateKeyspaceResponses, UpdateKeyspaceVschemaData, UpdateKeyspaceVschemaErrors, UpdateKeyspaceVschemaResponses, UpdateOrganizationData, UpdateOrganizationErrors, UpdateOrganizationResponses, UpdatePasswordData, UpdatePasswordErrors, UpdatePasswordResponses, UpdateRoleData, UpdateRoleErrors, UpdateRoleResponses, UpdateWebhookData, UpdateWebhookErrors, UpdateWebhookResponses, VerifyWorkflowData, VerifyWorkflowErrors, VerifyWorkflowResponses, WorkflowCancelData, WorkflowCancelErrors, WorkflowCancelResponses, WorkflowCompleteData, WorkflowCompleteErrors, WorkflowCompleteResponses, WorkflowCutoverData, WorkflowCutoverErrors, WorkflowCutoverResponses, WorkflowRetryData, WorkflowRetryErrors, WorkflowRetryResponses, WorkflowReverseCutoverData, WorkflowReverseCutoverErrors, WorkflowReverseCutoverResponses, WorkflowReverseTrafficData, WorkflowReverseTrafficErrors, WorkflowReverseTrafficResponses, WorkflowSwitchPrimariesData, WorkflowSwitchPrimariesErrors, WorkflowSwitchPrimariesResponses, WorkflowSwitchReplicasData, WorkflowSwitchReplicasErrors, WorkflowSwitchReplicasResponses } from "./types.gen.ts";
|
|
2
|
+
import type { AddOrganizationTeamMemberData, AddOrganizationTeamMemberErrors, AddOrganizationTeamMemberResponses, CancelBouncerResizeRequestData, CancelBouncerResizeRequestErrors, CancelBouncerResizeRequestResponses, CancelBranchChangeRequestData, CancelBranchChangeRequestErrors, CancelBranchChangeRequestResponses, CancelDeployRequestData, CancelDeployRequestErrors, CancelDeployRequestResponses, CloseDeployRequestData, CloseDeployRequestErrors, CloseDeployRequestResponses, CompleteErroredDeployData, CompleteErroredDeployErrors, CompleteErroredDeployResponses, CompleteGatedDeployRequestData, CompleteGatedDeployRequestErrors, CompleteGatedDeployRequestResponses, CompleteRevertData, CompleteRevertErrors, CompleteRevertResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateBouncerData, CreateBouncerErrors, CreateBouncerResponses, CreateBranchData, CreateBranchErrors, CreateBranchResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabasePostgresCidrData, CreateDatabasePostgresCidrErrors, CreateDatabasePostgresCidrResponses, CreateDatabaseResponses, CreateDeployRequestData, CreateDeployRequestErrors, CreateDeployRequestResponses, CreateKeyspaceData, CreateKeyspaceErrors, CreateKeyspaceResponses, CreateOauthTokenData, CreateOauthTokenErrors, CreateOauthTokenResponses, CreateOrganizationTeamData, CreateOrganizationTeamErrors, CreateOrganizationTeamResponses, CreatePasswordData, CreatePasswordErrors, CreatePasswordResponses, CreateQueryPatternsReportData, CreateQueryPatternsReportErrors, CreateQueryPatternsReportResponses, CreateRoleData, CreateRoleErrors, CreateRoleResponses, CreateServiceTokenData, CreateServiceTokenErrors, CreateServiceTokenResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteBouncerData, DeleteBouncerErrors, DeleteBouncerResponses, DeleteBranchData, DeleteBranchErrors, DeleteBranchResponses, DeleteDatabaseData, DeleteDatabaseErrors, DeleteDatabasePostgresCidrData, DeleteDatabasePostgresCidrErrors, DeleteDatabasePostgresCidrResponses, DeleteDatabaseResponses, DeleteKeyspaceData, DeleteKeyspaceErrors, DeleteKeyspaceResponses, DeleteOauthTokenData, DeleteOauthTokenErrors, DeleteOauthTokenResponses, DeleteOrganizationTeamData, DeleteOrganizationTeamErrors, DeleteOrganizationTeamResponses, DeletePasswordData, DeletePasswordErrors, DeletePasswordResponses, DeleteQueryPatternsReportData, DeleteQueryPatternsReportErrors, DeleteQueryPatternsReportResponses, DeleteRoleData, DeleteRoleErrors, DeleteRoleResponses, DeleteServiceTokenData, DeleteServiceTokenErrors, DeleteServiceTokenResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DemoteBranchData, DemoteBranchErrors, DemoteBranchResponses, DisableSafeMigrationsData, DisableSafeMigrationsErrors, DisableSafeMigrationsResponses, DismissSchemaRecommendationData, DismissSchemaRecommendationErrors, DismissSchemaRecommendationResponses, EnableSafeMigrationsData, EnableSafeMigrationsErrors, EnableSafeMigrationsResponses, GetBackupData, GetBackupErrors, GetBackupResponses, GetBouncerData, GetBouncerErrors, GetBouncerResponses, GetBranchChangeRequestData, GetBranchChangeRequestErrors, GetBranchChangeRequestResponses, GetBranchData, GetBranchErrors, GetBranchResponses, GetBranchSchemaData, GetBranchSchemaErrors, GetBranchSchemaResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseData, GetDatabaseErrors, GetDatabasePostgresCidrData, GetDatabasePostgresCidrErrors, GetDatabasePostgresCidrResponses, GetDatabaseResponses, GetDatabaseThrottlerData, GetDatabaseThrottlerErrors, GetDatabaseThrottlerResponses, GetDefaultRoleData, GetDefaultRoleErrors, GetDefaultRoleResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentResponses, GetDeployQueueData, GetDeployQueueErrors, GetDeployQueueResponses, GetDeployRequestData, GetDeployRequestErrors, GetDeployRequestResponses, GetDeployRequestThrottlerData, GetDeployRequestThrottlerErrors, GetDeployRequestThrottlerResponses, GetInvoiceData, GetInvoiceErrors, GetInvoiceLineItemsData, GetInvoiceLineItemsErrors, GetInvoiceLineItemsResponses, GetInvoiceResponses, GetKeyspaceData, GetKeyspaceErrors, GetKeyspaceResponses, GetKeyspaceRolloutStatusData, GetKeyspaceRolloutStatusErrors, GetKeyspaceRolloutStatusResponses, GetKeyspaceVschemaData, GetKeyspaceVschemaErrors, GetKeyspaceVschemaResponses, GetOauthApplicationData, GetOauthApplicationErrors, GetOauthApplicationResponses, GetOauthTokenData, GetOauthTokenErrors, GetOauthTokenResponses, GetOrganizationData, GetOrganizationErrors, GetOrganizationMembershipData, GetOrganizationMembershipErrors, GetOrganizationMembershipResponses, GetOrganizationResponses, GetOrganizationTeamData, GetOrganizationTeamErrors, GetOrganizationTeamMemberData, GetOrganizationTeamMemberErrors, GetOrganizationTeamMemberResponses, GetOrganizationTeamResponses, GetPasswordData, GetPasswordErrors, GetPasswordResponses, GetQueryPatternsReportData, GetQueryPatternsReportErrors, GetQueryPatternsReportStatusData, GetQueryPatternsReportStatusErrors, GetQueryPatternsReportStatusResponses, GetRoleData, GetRoleErrors, GetRoleResponses, GetSchemaRecommendationData, GetSchemaRecommendationErrors, GetSchemaRecommendationResponses, GetServiceTokenData, GetServiceTokenErrors, GetServiceTokenResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, LintBranchSchemaData, LintBranchSchemaErrors, LintBranchSchemaResponses, ListAuditLogsData, ListAuditLogsErrors, ListAuditLogsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListBouncerResizeRequestsData, ListBouncerResizeRequestsErrors, ListBouncerResizeRequestsResponses, ListBouncersData, ListBouncersErrors, ListBouncersResponses, ListBranchBouncerResizeRequestsData, ListBranchBouncerResizeRequestsErrors, ListBranchBouncerResizeRequestsResponses, ListBranchChangeRequestsData, ListBranchChangeRequestsErrors, ListBranchChangeRequestsResponses, ListBranchesData, ListBranchesErrors, ListBranchesResponses, ListClusterSizeSkusData, ListClusterSizeSkusErrors, ListClusterSizeSkusResponses, ListDatabasePostgresCidrsData, ListDatabasePostgresCidrsErrors, ListDatabasePostgresCidrsResponses, ListDatabaseRegionsData, ListDatabaseRegionsErrors, ListDatabaseRegionsResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDeployOperationsData, ListDeployOperationsErrors, ListDeployOperationsResponses, ListDeployRequestReviewsData, ListDeployRequestReviewsErrors, ListDeployRequestReviewsResponses, ListDeployRequestsData, ListDeployRequestsErrors, ListDeployRequestsResponses, ListExtensionsData, ListExtensionsErrors, ListExtensionsResponses, ListGeneratedQueryPatternsReportsData, ListGeneratedQueryPatternsReportsErrors, ListGeneratedQueryPatternsReportsResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListKeyspaceResizesData, ListKeyspaceResizesErrors, ListKeyspaceResizesResponses, ListKeyspacesData, ListKeyspacesErrors, ListKeyspacesResponses, ListOauthApplicationsData, ListOauthApplicationsErrors, ListOauthApplicationsResponses, ListOauthTokensData, ListOauthTokensErrors, ListOauthTokensResponses, ListOrganizationMembersData, ListOrganizationMembersErrors, ListOrganizationMembersResponses, ListOrganizationsData, ListOrganizationsErrors, ListOrganizationsResponses, ListOrganizationTeamMembersData, ListOrganizationTeamMembersErrors, ListOrganizationTeamMembersResponses, ListOrganizationTeamsData, ListOrganizationTeamsErrors, ListOrganizationTeamsResponses, ListParametersData, ListParametersErrors, ListParametersResponses, ListPasswordsData, ListPasswordsErrors, ListPasswordsResponses, ListPublicRegionsData, ListPublicRegionsErrors, ListPublicRegionsResponses, ListReadOnlyRegionsData, ListReadOnlyRegionsErrors, ListReadOnlyRegionsResponses, ListRegionsForOrganizationData, ListRegionsForOrganizationErrors, ListRegionsForOrganizationResponses, ListRolesData, ListRolesErrors, ListRolesResponses, ListSchemaRecommendationsData, ListSchemaRecommendationsErrors, ListSchemaRecommendationsResponses, ListServiceTokensData, ListServiceTokensErrors, ListServiceTokensResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, PromoteBranchData, PromoteBranchErrors, PromoteBranchResponses, QueueDeployRequestData, QueueDeployRequestErrors, QueueDeployRequestResponses, ReassignRoleObjectsData, ReassignRoleObjectsErrors, ReassignRoleObjectsResponses, RemoveOrganizationMemberData, RemoveOrganizationMemberErrors, RemoveOrganizationMemberResponses, RemoveOrganizationTeamMemberData, RemoveOrganizationTeamMemberErrors, RemoveOrganizationTeamMemberResponses, RenewPasswordData, RenewPasswordErrors, RenewPasswordResponses, RenewRoleData, RenewRoleErrors, RenewRoleResponses, ResetDefaultRoleData, ResetDefaultRoleErrors, ResetDefaultRoleResponses, ResetRoleData, ResetRoleErrors, ResetRoleResponses, ReviewDeployRequestData, ReviewDeployRequestErrors, ReviewDeployRequestResponses, SkipRevertPeriodData, SkipRevertPeriodErrors, SkipRevertPeriodResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAutoApplyData, UpdateAutoApplyErrors, UpdateAutoApplyResponses, UpdateAutoDeleteBranchData, UpdateAutoDeleteBranchErrors, UpdateAutoDeleteBranchResponses, UpdateBackupData, UpdateBackupErrors, UpdateBackupResponses, UpdateBouncerResizeRequestData, UpdateBouncerResizeRequestErrors, UpdateBouncerResizeRequestResponses, UpdateBranchChangeRequestData, UpdateBranchChangeRequestErrors, UpdateBranchChangeRequestResponses, UpdateBranchClusterConfigData, UpdateBranchClusterConfigErrors, UpdateBranchClusterConfigResponses, UpdateBranchData, UpdateBranchErrors, UpdateBranchResponses, UpdateDatabasePostgresCidrData, UpdateDatabasePostgresCidrErrors, UpdateDatabasePostgresCidrResponses, UpdateDatabaseSettingsData, UpdateDatabaseSettingsErrors, UpdateDatabaseSettingsResponses, UpdateDatabaseThrottlerData, UpdateDatabaseThrottlerErrors, UpdateDatabaseThrottlerResponses, UpdateDeployRequestThrottlerData, UpdateDeployRequestThrottlerErrors, UpdateDeployRequestThrottlerResponses, UpdateKeyspaceData, UpdateKeyspaceErrors, UpdateKeyspaceResponses, UpdateKeyspaceVschemaData, UpdateKeyspaceVschemaErrors, UpdateKeyspaceVschemaResponses, UpdateOrganizationData, UpdateOrganizationErrors, UpdateOrganizationMembershipData, UpdateOrganizationMembershipErrors, UpdateOrganizationMembershipResponses, UpdateOrganizationResponses, UpdateOrganizationTeamData, UpdateOrganizationTeamErrors, UpdateOrganizationTeamResponses, UpdatePasswordData, UpdatePasswordErrors, UpdatePasswordResponses, UpdateRoleData, UpdateRoleErrors, UpdateRoleResponses, UpdateWebhookData, UpdateWebhookErrors, UpdateWebhookResponses, VerifyWorkflowData, VerifyWorkflowErrors, VerifyWorkflowResponses, WorkflowCancelData, WorkflowCancelErrors, WorkflowCancelResponses, WorkflowCompleteData, WorkflowCompleteErrors, WorkflowCompleteResponses, WorkflowCutoverData, WorkflowCutoverErrors, WorkflowCutoverResponses, WorkflowRetryData, WorkflowRetryErrors, WorkflowRetryResponses, WorkflowReverseCutoverData, WorkflowReverseCutoverErrors, WorkflowReverseCutoverResponses, WorkflowReverseTrafficData, WorkflowReverseTrafficErrors, WorkflowReverseTrafficResponses, WorkflowSwitchPrimariesData, WorkflowSwitchPrimariesErrors, WorkflowSwitchPrimariesResponses, WorkflowSwitchReplicasData, WorkflowSwitchReplicasErrors, WorkflowSwitchReplicasResponses } from "./types.gen.ts";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -76,8 +76,8 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
76
76
|
*/
|
|
77
77
|
listAuditLogs<ThrowOnError extends boolean = true>(options: Options<ListAuditLogsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListAuditLogsResponses, ListAuditLogsErrors, ThrowOnError, "fields">;
|
|
78
78
|
/**
|
|
79
|
-
* List
|
|
80
|
-
*
|
|
79
|
+
* List available cluster sizes
|
|
80
|
+
* List available cluster sizes for an organization
|
|
81
81
|
* ### Authorization
|
|
82
82
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
83
83
|
*
|
|
@@ -91,7 +91,7 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
91
91
|
* | User | `read_organizations` |
|
|
92
92
|
* | Organization | `read_organization` |
|
|
93
93
|
*/
|
|
94
|
-
|
|
94
|
+
listClusterSizeSkus<ThrowOnError extends boolean = true>(options: Options<ListClusterSizeSkusData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListClusterSizeSkusResponses, ListClusterSizeSkusErrors, ThrowOnError, "fields">;
|
|
95
95
|
/**
|
|
96
96
|
* List databases
|
|
97
97
|
*
|
|
@@ -99,7 +99,7 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
99
99
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
100
100
|
*
|
|
101
101
|
* **Service Token Accesses**
|
|
102
|
-
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `
|
|
102
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
103
103
|
*
|
|
104
104
|
* **OAuth Scopes**
|
|
105
105
|
*
|
|
@@ -124,6 +124,57 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
124
124
|
* | Organization | `create_databases` |
|
|
125
125
|
*/
|
|
126
126
|
createDatabase<ThrowOnError extends boolean = true>(options: Options<CreateDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateDatabaseResponses, CreateDatabaseErrors, ThrowOnError, "fields">;
|
|
127
|
+
/**
|
|
128
|
+
* Delete a database
|
|
129
|
+
*
|
|
130
|
+
* ### Authorization
|
|
131
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
132
|
+
*
|
|
133
|
+
* **Service Token Accesses**
|
|
134
|
+
* `delete_database`
|
|
135
|
+
*
|
|
136
|
+
* **OAuth Scopes**
|
|
137
|
+
*
|
|
138
|
+
* | Resource | Scopes |
|
|
139
|
+
* | :------- | :---------- |
|
|
140
|
+
* | Organization | `delete_databases` |
|
|
141
|
+
* | Database | `delete_database` |
|
|
142
|
+
*/
|
|
143
|
+
deleteDatabase<ThrowOnError extends boolean = true>(options: Options<DeleteDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteDatabaseResponses, DeleteDatabaseErrors, ThrowOnError, "fields">;
|
|
144
|
+
/**
|
|
145
|
+
* Get a database
|
|
146
|
+
*
|
|
147
|
+
* ### Authorization
|
|
148
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
149
|
+
*
|
|
150
|
+
* **Service Token Accesses**
|
|
151
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
152
|
+
*
|
|
153
|
+
* **OAuth Scopes**
|
|
154
|
+
*
|
|
155
|
+
* | Resource | Scopes |
|
|
156
|
+
* | :------- | :---------- |
|
|
157
|
+
* | Organization | `read_databases` |
|
|
158
|
+
* | Database | `read_database` |
|
|
159
|
+
*/
|
|
160
|
+
getDatabase<ThrowOnError extends boolean = true>(options: Options<GetDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDatabaseResponses, GetDatabaseErrors, ThrowOnError, "fields">;
|
|
161
|
+
/**
|
|
162
|
+
* Update database settings
|
|
163
|
+
*
|
|
164
|
+
* ### Authorization
|
|
165
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
166
|
+
*
|
|
167
|
+
* **Service Token Accesses**
|
|
168
|
+
* `write_database`
|
|
169
|
+
*
|
|
170
|
+
* **OAuth Scopes**
|
|
171
|
+
*
|
|
172
|
+
* | Resource | Scopes |
|
|
173
|
+
* | :------- | :---------- |
|
|
174
|
+
* | Organization | `write_databases` |
|
|
175
|
+
* | Database | `write_database` |
|
|
176
|
+
*/
|
|
177
|
+
updateDatabaseSettings<ThrowOnError extends boolean = true>(options: Options<UpdateDatabaseSettingsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateDatabaseSettingsResponses, UpdateDatabaseSettingsErrors, ThrowOnError, "fields">;
|
|
127
178
|
/**
|
|
128
179
|
* List branches
|
|
129
180
|
*
|
|
@@ -160,6 +211,60 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
160
211
|
* | Branch | `restore_backups` |
|
|
161
212
|
*/
|
|
162
213
|
createBranch<ThrowOnError extends boolean = true>(options: Options<CreateBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateBranchResponses, CreateBranchErrors, ThrowOnError, "fields">;
|
|
214
|
+
/**
|
|
215
|
+
* Delete a branch
|
|
216
|
+
*
|
|
217
|
+
* ### Authorization
|
|
218
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
219
|
+
*
|
|
220
|
+
* **Service Token Accesses**
|
|
221
|
+
* `delete_branch`
|
|
222
|
+
*
|
|
223
|
+
* **OAuth Scopes**
|
|
224
|
+
*
|
|
225
|
+
* | Resource | Scopes |
|
|
226
|
+
* | :------- | :---------- |
|
|
227
|
+
* | Organization | `delete_branches`, `delete_production_branches` |
|
|
228
|
+
* | Database | `delete_branches`, `delete_production_branches` |
|
|
229
|
+
* | Branch | `delete_branch` |
|
|
230
|
+
*/
|
|
231
|
+
deleteBranch<ThrowOnError extends boolean = true>(options: Options<DeleteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteBranchResponses, DeleteBranchErrors, ThrowOnError, "fields">;
|
|
232
|
+
/**
|
|
233
|
+
* Get a branch
|
|
234
|
+
*
|
|
235
|
+
* ### Authorization
|
|
236
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
237
|
+
*
|
|
238
|
+
* **Service Token Accesses**
|
|
239
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
240
|
+
*
|
|
241
|
+
* **OAuth Scopes**
|
|
242
|
+
*
|
|
243
|
+
* | Resource | Scopes |
|
|
244
|
+
* | :------- | :---------- |
|
|
245
|
+
* | Organization | `read_branches` |
|
|
246
|
+
* | Database | `read_branches` |
|
|
247
|
+
* | Branch | `read_branch` |
|
|
248
|
+
*/
|
|
249
|
+
getBranch<ThrowOnError extends boolean = true>(options: Options<GetBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetBranchResponses, GetBranchErrors, ThrowOnError, "fields">;
|
|
250
|
+
/**
|
|
251
|
+
* Update a branch
|
|
252
|
+
*
|
|
253
|
+
* ### Authorization
|
|
254
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
255
|
+
*
|
|
256
|
+
* **Service Token Accesses**
|
|
257
|
+
* `write_database`
|
|
258
|
+
*
|
|
259
|
+
* **OAuth Scopes**
|
|
260
|
+
*
|
|
261
|
+
* | Resource | Scopes |
|
|
262
|
+
* | :------- | :---------- |
|
|
263
|
+
* | Organization | `write_branches` |
|
|
264
|
+
* | Database | `write_branches` |
|
|
265
|
+
* | Branch | `write_branch` |
|
|
266
|
+
*/
|
|
267
|
+
updateBranch<ThrowOnError extends boolean = true>(options: Options<UpdateBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBranchResponses, UpdateBranchErrors, ThrowOnError, "fields">;
|
|
163
268
|
/**
|
|
164
269
|
* List backups
|
|
165
270
|
*
|
|
@@ -250,6 +355,146 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
250
355
|
* | Branch | `write_backups` |
|
|
251
356
|
*/
|
|
252
357
|
updateBackup<ThrowOnError extends boolean = true>(options: Options<UpdateBackupData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBackupResponses, UpdateBackupErrors, ThrowOnError, "fields">;
|
|
358
|
+
/**
|
|
359
|
+
* Get bouncer resize requests
|
|
360
|
+
*
|
|
361
|
+
* ### Authorization
|
|
362
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
363
|
+
*
|
|
364
|
+
* **Service Token Accesses**
|
|
365
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
366
|
+
*
|
|
367
|
+
* **OAuth Scopes**
|
|
368
|
+
*
|
|
369
|
+
* | Resource | Scopes |
|
|
370
|
+
* | :------- | :---------- |
|
|
371
|
+
* | Organization | `read_branches` |
|
|
372
|
+
* | Database | `read_branches` |
|
|
373
|
+
* | Branch | `read_branch` |
|
|
374
|
+
*/
|
|
375
|
+
listBranchBouncerResizeRequests<ThrowOnError extends boolean = true>(options: Options<ListBranchBouncerResizeRequestsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListBranchBouncerResizeRequestsResponses, ListBranchBouncerResizeRequestsErrors, ThrowOnError, "fields">;
|
|
376
|
+
/**
|
|
377
|
+
* List bouncers
|
|
378
|
+
*
|
|
379
|
+
* ### Authorization
|
|
380
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
381
|
+
*
|
|
382
|
+
* **Service Token Accesses**
|
|
383
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
384
|
+
*
|
|
385
|
+
* **OAuth Scopes**
|
|
386
|
+
*
|
|
387
|
+
* | Resource | Scopes |
|
|
388
|
+
* | :------- | :---------- |
|
|
389
|
+
* | Organization | `read_branches` |
|
|
390
|
+
* | Database | `read_branches` |
|
|
391
|
+
* | Branch | `read_branch` |
|
|
392
|
+
*/
|
|
393
|
+
listBouncers<ThrowOnError extends boolean = true>(options: Options<ListBouncersData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListBouncersResponses, ListBouncersErrors, ThrowOnError, "fields">;
|
|
394
|
+
/**
|
|
395
|
+
* Create a bouncer
|
|
396
|
+
*
|
|
397
|
+
* ### Authorization
|
|
398
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
399
|
+
*
|
|
400
|
+
* **Service Token Accesses**
|
|
401
|
+
* `write_database`
|
|
402
|
+
*
|
|
403
|
+
* **OAuth Scopes**
|
|
404
|
+
*
|
|
405
|
+
* | Resource | Scopes |
|
|
406
|
+
* | :------- | :---------- |
|
|
407
|
+
* | Organization | `write_databases` |
|
|
408
|
+
* | Database | `write_database` |
|
|
409
|
+
*/
|
|
410
|
+
createBouncer<ThrowOnError extends boolean = true>(options: Options<CreateBouncerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateBouncerResponses, CreateBouncerErrors, ThrowOnError, "fields">;
|
|
411
|
+
/**
|
|
412
|
+
* Delete a bouncer
|
|
413
|
+
*
|
|
414
|
+
* ### Authorization
|
|
415
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
416
|
+
*
|
|
417
|
+
* **Service Token Accesses**
|
|
418
|
+
* `write_database`
|
|
419
|
+
*
|
|
420
|
+
* **OAuth Scopes**
|
|
421
|
+
*
|
|
422
|
+
* | Resource | Scopes |
|
|
423
|
+
* | :------- | :---------- |
|
|
424
|
+
* | Organization | `write_databases` |
|
|
425
|
+
* | Database | `write_database` |
|
|
426
|
+
*/
|
|
427
|
+
deleteBouncer<ThrowOnError extends boolean = true>(options: Options<DeleteBouncerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteBouncerResponses, DeleteBouncerErrors, ThrowOnError, "fields">;
|
|
428
|
+
/**
|
|
429
|
+
* Get a bouncer
|
|
430
|
+
*
|
|
431
|
+
* ### Authorization
|
|
432
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
433
|
+
*
|
|
434
|
+
* **Service Token Accesses**
|
|
435
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
436
|
+
*
|
|
437
|
+
* **OAuth Scopes**
|
|
438
|
+
*
|
|
439
|
+
* | Resource | Scopes |
|
|
440
|
+
* | :------- | :---------- |
|
|
441
|
+
* | Organization | `read_branches` |
|
|
442
|
+
* | Database | `read_branches` |
|
|
443
|
+
* | Branch | `read_branch` |
|
|
444
|
+
*/
|
|
445
|
+
getBouncer<ThrowOnError extends boolean = true>(options: Options<GetBouncerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetBouncerResponses, GetBouncerErrors, ThrowOnError, "fields">;
|
|
446
|
+
/**
|
|
447
|
+
* Cancel a resize request
|
|
448
|
+
*
|
|
449
|
+
* ### Authorization
|
|
450
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
451
|
+
*
|
|
452
|
+
* **Service Token Accesses**
|
|
453
|
+
* `write_database`
|
|
454
|
+
*
|
|
455
|
+
* **OAuth Scopes**
|
|
456
|
+
*
|
|
457
|
+
* | Resource | Scopes |
|
|
458
|
+
* | :------- | :---------- |
|
|
459
|
+
* | Organization | `write_databases` |
|
|
460
|
+
* | Database | `write_database` |
|
|
461
|
+
*/
|
|
462
|
+
cancelBouncerResizeRequest<ThrowOnError extends boolean = true>(options: Options<CancelBouncerResizeRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CancelBouncerResizeRequestResponses, CancelBouncerResizeRequestErrors, ThrowOnError, "fields">;
|
|
463
|
+
/**
|
|
464
|
+
* Get bouncer resize requests
|
|
465
|
+
*
|
|
466
|
+
* ### Authorization
|
|
467
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
468
|
+
*
|
|
469
|
+
* **Service Token Accesses**
|
|
470
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
471
|
+
*
|
|
472
|
+
* **OAuth Scopes**
|
|
473
|
+
*
|
|
474
|
+
* | Resource | Scopes |
|
|
475
|
+
* | :------- | :---------- |
|
|
476
|
+
* | Organization | `read_branches` |
|
|
477
|
+
* | Database | `read_branches` |
|
|
478
|
+
* | Branch | `read_branch` |
|
|
479
|
+
*/
|
|
480
|
+
listBouncerResizeRequests<ThrowOnError extends boolean = true>(options: Options<ListBouncerResizeRequestsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListBouncerResizeRequestsResponses, ListBouncerResizeRequestsErrors, ThrowOnError, "fields">;
|
|
481
|
+
/**
|
|
482
|
+
* Upsert a bouncer resize request
|
|
483
|
+
*
|
|
484
|
+
* ### Authorization
|
|
485
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
486
|
+
*
|
|
487
|
+
* **Service Token Accesses**
|
|
488
|
+
* `write_database`
|
|
489
|
+
*
|
|
490
|
+
* **OAuth Scopes**
|
|
491
|
+
*
|
|
492
|
+
* | Resource | Scopes |
|
|
493
|
+
* | :------- | :---------- |
|
|
494
|
+
* | Organization | `write_databases` |
|
|
495
|
+
* | Database | `write_database` |
|
|
496
|
+
*/
|
|
497
|
+
updateBouncerResizeRequest<ThrowOnError extends boolean = true>(options: Options<UpdateBouncerResizeRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBouncerResizeRequestResponses, UpdateBouncerResizeRequestErrors, ThrowOnError, "fields">;
|
|
253
498
|
/**
|
|
254
499
|
* Get branch change requests
|
|
255
500
|
*
|
|
@@ -285,6 +530,53 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
285
530
|
* | Database | `write_database` |
|
|
286
531
|
*/
|
|
287
532
|
updateBranchChangeRequest<ThrowOnError extends boolean = true>(options: Options<UpdateBranchChangeRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBranchChangeRequestResponses, UpdateBranchChangeRequestErrors, ThrowOnError, "fields">;
|
|
533
|
+
/**
|
|
534
|
+
* Get a branch change request
|
|
535
|
+
*
|
|
536
|
+
* ### Authorization
|
|
537
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
538
|
+
*
|
|
539
|
+
* **Service Token Accesses**
|
|
540
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
541
|
+
*
|
|
542
|
+
* **OAuth Scopes**
|
|
543
|
+
*
|
|
544
|
+
* | Resource | Scopes |
|
|
545
|
+
* | :------- | :---------- |
|
|
546
|
+
* | Organization | `read_branches` |
|
|
547
|
+
* | Database | `read_branches` |
|
|
548
|
+
* | Branch | `read_branch` |
|
|
549
|
+
*/
|
|
550
|
+
getBranchChangeRequest<ThrowOnError extends boolean = true>(options: Options<GetBranchChangeRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetBranchChangeRequestResponses, GetBranchChangeRequestErrors, ThrowOnError, "fields">;
|
|
551
|
+
/**
|
|
552
|
+
* Change a branch cluster configuration
|
|
553
|
+
*
|
|
554
|
+
* ### Authorization
|
|
555
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
556
|
+
*
|
|
557
|
+
* **Service Token Accesses**
|
|
558
|
+
* `write_database`
|
|
559
|
+
*
|
|
560
|
+
*
|
|
561
|
+
*/
|
|
562
|
+
updateBranchClusterConfig<ThrowOnError extends boolean = true>(options: Options<UpdateBranchClusterConfigData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBranchClusterConfigResponses, UpdateBranchClusterConfigErrors, ThrowOnError, "fields">;
|
|
563
|
+
/**
|
|
564
|
+
* Demote a branch
|
|
565
|
+
* Demotes a branch from production to development
|
|
566
|
+
* ### Authorization
|
|
567
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
568
|
+
*
|
|
569
|
+
* **Service Token Accesses**
|
|
570
|
+
* `connect_production_branch`, `demote_branches`
|
|
571
|
+
*
|
|
572
|
+
* **OAuth Scopes**
|
|
573
|
+
*
|
|
574
|
+
* | Resource | Scopes |
|
|
575
|
+
* | :------- | :---------- |
|
|
576
|
+
* | Organization | `demote_branches` |
|
|
577
|
+
* | Database | `demote_branches` |
|
|
578
|
+
*/
|
|
579
|
+
demoteBranch<ThrowOnError extends boolean = true>(options: Options<DemoteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DemoteBranchResponses, DemoteBranchErrors, ThrowOnError, "fields">;
|
|
288
580
|
/**
|
|
289
581
|
* List cluster extensions
|
|
290
582
|
*
|
|
@@ -306,15 +598,75 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
306
598
|
/**
|
|
307
599
|
* Get keyspaces
|
|
308
600
|
*
|
|
601
|
+
* ### Authorization
|
|
602
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
603
|
+
*
|
|
604
|
+
* **Service Token Accesses**
|
|
605
|
+
* `read_branch`
|
|
606
|
+
*
|
|
607
|
+
*
|
|
608
|
+
*/
|
|
609
|
+
listKeyspaces<ThrowOnError extends boolean = true>(options: Options<ListKeyspacesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListKeyspacesResponses, ListKeyspacesErrors, ThrowOnError, "fields">;
|
|
610
|
+
/**
|
|
611
|
+
* Create a keyspace
|
|
612
|
+
*
|
|
613
|
+
* ### Authorization
|
|
614
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
615
|
+
*
|
|
616
|
+
* **Service Token Accesses**
|
|
617
|
+
* `create_branch`
|
|
618
|
+
*
|
|
619
|
+
*
|
|
620
|
+
*/
|
|
621
|
+
createKeyspace<ThrowOnError extends boolean = true>(options: Options<CreateKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateKeyspaceResponses, CreateKeyspaceErrors, ThrowOnError, "fields">;
|
|
622
|
+
/**
|
|
623
|
+
* Delete a keyspace
|
|
624
|
+
*
|
|
625
|
+
* ### Authorization
|
|
626
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
627
|
+
*
|
|
628
|
+
* **Service Token Accesses**
|
|
629
|
+
* `delete_branch`, `delete_production_branch`
|
|
630
|
+
*
|
|
631
|
+
*
|
|
632
|
+
*/
|
|
633
|
+
deleteKeyspace<ThrowOnError extends boolean = true>(options: Options<DeleteKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteKeyspaceResponses, DeleteKeyspaceErrors, ThrowOnError, "fields">;
|
|
634
|
+
/**
|
|
635
|
+
* Get a keyspace
|
|
636
|
+
*
|
|
637
|
+
* ### Authorization
|
|
638
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
639
|
+
*
|
|
640
|
+
* **Service Token Accesses**
|
|
641
|
+
* `read_branch`
|
|
642
|
+
*
|
|
643
|
+
*
|
|
644
|
+
*/
|
|
645
|
+
getKeyspace<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceResponses, GetKeyspaceErrors, ThrowOnError, "fields">;
|
|
646
|
+
/**
|
|
647
|
+
* Configure keyspace settings
|
|
648
|
+
*
|
|
649
|
+
* ### Authorization
|
|
650
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
651
|
+
*
|
|
652
|
+
* **Service Token Accesses**
|
|
653
|
+
* `create_branch`
|
|
654
|
+
*
|
|
655
|
+
*
|
|
656
|
+
*/
|
|
657
|
+
updateKeyspace<ThrowOnError extends boolean = true>(options: Options<UpdateKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateKeyspaceResponses, UpdateKeyspaceErrors, ThrowOnError, "fields">;
|
|
658
|
+
/**
|
|
659
|
+
* Get keyspace rollout status
|
|
660
|
+
*
|
|
661
|
+
* ### Authorization
|
|
662
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
309
663
|
*
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
/**
|
|
313
|
-
* Create a keyspace
|
|
664
|
+
* **Service Token Accesses**
|
|
665
|
+
* `read_branch`
|
|
314
666
|
*
|
|
315
667
|
*
|
|
316
668
|
*/
|
|
317
|
-
|
|
669
|
+
getKeyspaceRolloutStatus<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceRolloutStatusData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceRolloutStatusResponses, GetKeyspaceRolloutStatusErrors, ThrowOnError, "fields">;
|
|
318
670
|
/**
|
|
319
671
|
* Get the VSchema for the keyspace
|
|
320
672
|
*
|
|
@@ -339,32 +691,9 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
339
691
|
*
|
|
340
692
|
*/
|
|
341
693
|
updateKeyspaceVschema<ThrowOnError extends boolean = true>(options: Options<UpdateKeyspaceVschemaData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateKeyspaceVschemaResponses, UpdateKeyspaceVschemaErrors, ThrowOnError, "fields">;
|
|
342
|
-
/**
|
|
343
|
-
* Delete a keyspace
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*/
|
|
347
|
-
deleteKeyspace<ThrowOnError extends boolean = true>(options: Options<DeleteKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteKeyspaceResponses, DeleteKeyspaceErrors, ThrowOnError, "fields">;
|
|
348
|
-
/**
|
|
349
|
-
* Get a keyspace
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*/
|
|
353
|
-
getKeyspace<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceResponses, GetKeyspaceErrors, ThrowOnError, "fields">;
|
|
354
|
-
/**
|
|
355
|
-
* Configure keyspace settings
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
*/
|
|
359
|
-
updateKeyspace<ThrowOnError extends boolean = true>(options: Options<UpdateKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateKeyspaceResponses, UpdateKeyspaceErrors, ThrowOnError, "fields">;
|
|
360
|
-
/**
|
|
361
|
-
* Get keyspace rollout status
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*/
|
|
365
|
-
getKeyspaceRolloutStatus<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceRolloutStatusData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceRolloutStatusResponses, GetKeyspaceRolloutStatusErrors, ThrowOnError, "fields">;
|
|
366
694
|
/**
|
|
367
695
|
* List cluster parameters
|
|
696
|
+
* Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint.
|
|
368
697
|
*
|
|
369
698
|
* ### Authorization
|
|
370
699
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
@@ -388,15 +717,15 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
388
717
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
389
718
|
*
|
|
390
719
|
* **Service Token Accesses**
|
|
391
|
-
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
720
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
392
721
|
*
|
|
393
722
|
* **OAuth Scopes**
|
|
394
723
|
*
|
|
395
724
|
* | Resource | Scopes |
|
|
396
725
|
* | :------- | :---------- |
|
|
397
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
398
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
399
|
-
* | Branch | `manage_passwords` |
|
|
726
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
727
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
728
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
400
729
|
*/
|
|
401
730
|
listPasswords<ThrowOnError extends boolean = true>(options: Options<ListPasswordsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListPasswordsResponses, ListPasswordsErrors, ThrowOnError, "fields">;
|
|
402
731
|
/**
|
|
@@ -406,15 +735,15 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
406
735
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
407
736
|
*
|
|
408
737
|
* **Service Token Accesses**
|
|
409
|
-
* `connect_production_branch`, `connect_branch`
|
|
738
|
+
* `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
410
739
|
*
|
|
411
740
|
* **OAuth Scopes**
|
|
412
741
|
*
|
|
413
742
|
* | Resource | Scopes |
|
|
414
743
|
* | :------- | :---------- |
|
|
415
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
416
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
417
|
-
* | Branch | `manage_passwords` |
|
|
744
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
745
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
746
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
418
747
|
*/
|
|
419
748
|
createPassword<ThrowOnError extends boolean = true>(options: Options<CreatePasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreatePasswordResponses, CreatePasswordErrors, ThrowOnError, "fields">;
|
|
420
749
|
/**
|
|
@@ -424,15 +753,15 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
424
753
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
425
754
|
*
|
|
426
755
|
* **Service Token Accesses**
|
|
427
|
-
* `delete_production_branch_password`, `delete_branch_password`
|
|
756
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
428
757
|
*
|
|
429
758
|
* **OAuth Scopes**
|
|
430
759
|
*
|
|
431
760
|
* | Resource | Scopes |
|
|
432
761
|
* | :------- | :---------- |
|
|
433
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
434
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
435
|
-
* | Branch | `manage_passwords` |
|
|
762
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
763
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
764
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
436
765
|
*/
|
|
437
766
|
deletePassword<ThrowOnError extends boolean = true>(options: Options<DeletePasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeletePasswordResponses, DeletePasswordErrors, ThrowOnError, "fields">;
|
|
438
767
|
/**
|
|
@@ -442,15 +771,15 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
442
771
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
443
772
|
*
|
|
444
773
|
* **Service Token Accesses**
|
|
445
|
-
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
774
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
446
775
|
*
|
|
447
776
|
* **OAuth Scopes**
|
|
448
777
|
*
|
|
449
778
|
* | Resource | Scopes |
|
|
450
779
|
* | :------- | :---------- |
|
|
451
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
452
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
453
|
-
* | Branch | `manage_passwords` |
|
|
780
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
781
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
782
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
454
783
|
*/
|
|
455
784
|
getPassword<ThrowOnError extends boolean = true>(options: Options<GetPasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetPasswordResponses, GetPasswordErrors, ThrowOnError, "fields">;
|
|
456
785
|
/**
|
|
@@ -460,15 +789,15 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
460
789
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
461
790
|
*
|
|
462
791
|
* **Service Token Accesses**
|
|
463
|
-
* `connect_production_branch`, `connect_branch`
|
|
792
|
+
* `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
464
793
|
*
|
|
465
794
|
* **OAuth Scopes**
|
|
466
795
|
*
|
|
467
796
|
* | Resource | Scopes |
|
|
468
797
|
* | :------- | :---------- |
|
|
469
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
470
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
471
|
-
* | Branch | `manage_passwords` |
|
|
798
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
799
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
800
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
472
801
|
*/
|
|
473
802
|
updatePassword<ThrowOnError extends boolean = true>(options: Options<UpdatePasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdatePasswordResponses, UpdatePasswordErrors, ThrowOnError, "fields">;
|
|
474
803
|
/**
|
|
@@ -478,17 +807,34 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
478
807
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
479
808
|
*
|
|
480
809
|
* **Service Token Accesses**
|
|
481
|
-
* `connect_production_branch`, `connect_branch`
|
|
810
|
+
* `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
482
811
|
*
|
|
483
812
|
* **OAuth Scopes**
|
|
484
813
|
*
|
|
485
814
|
* | Resource | Scopes |
|
|
486
815
|
* | :------- | :---------- |
|
|
487
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
488
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
489
|
-
* | Branch | `manage_passwords` |
|
|
816
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
817
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
818
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
490
819
|
*/
|
|
491
820
|
renewPassword<ThrowOnError extends boolean = true>(options: Options<RenewPasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<RenewPasswordResponses, RenewPasswordErrors, ThrowOnError, "fields">;
|
|
821
|
+
/**
|
|
822
|
+
* Promote a branch
|
|
823
|
+
* Promotes a branch from development to production
|
|
824
|
+
* ### Authorization
|
|
825
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
826
|
+
*
|
|
827
|
+
* **Service Token Accesses**
|
|
828
|
+
* `connect_production_branch`, `promote_branches`
|
|
829
|
+
*
|
|
830
|
+
* **OAuth Scopes**
|
|
831
|
+
*
|
|
832
|
+
* | Resource | Scopes |
|
|
833
|
+
* | :------- | :---------- |
|
|
834
|
+
* | Organization | `promote_branches` |
|
|
835
|
+
* | Database | `promote_branches` |
|
|
836
|
+
*/
|
|
837
|
+
promoteBranch<ThrowOnError extends boolean = true>(options: Options<PromoteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<PromoteBranchResponses, PromoteBranchErrors, ThrowOnError, "fields">;
|
|
492
838
|
/**
|
|
493
839
|
* List generated query patterns reports
|
|
494
840
|
*
|
|
@@ -603,15 +949,15 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
603
949
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
604
950
|
*
|
|
605
951
|
* **Service Token Accesses**
|
|
606
|
-
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
952
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
607
953
|
*
|
|
608
954
|
* **OAuth Scopes**
|
|
609
955
|
*
|
|
610
956
|
* | Resource | Scopes |
|
|
611
957
|
* | :------- | :---------- |
|
|
612
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
613
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
614
|
-
* | Branch | `manage_passwords` |
|
|
958
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
959
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
960
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
615
961
|
*/
|
|
616
962
|
listRoles<ThrowOnError extends boolean = true>(options: Options<ListRolesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListRolesResponses, ListRolesErrors, ThrowOnError, "fields">;
|
|
617
963
|
/**
|
|
@@ -621,171 +967,161 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
621
967
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
622
968
|
*
|
|
623
969
|
* **Service Token Accesses**
|
|
624
|
-
* `create_production_branch_password`, `create_branch_password`
|
|
970
|
+
* `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
|
|
625
971
|
*
|
|
626
972
|
* **OAuth Scopes**
|
|
627
973
|
*
|
|
628
974
|
* | Resource | Scopes |
|
|
629
975
|
* | :------- | :---------- |
|
|
630
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
631
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
632
|
-
* | Branch | `manage_passwords` |
|
|
976
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
977
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
978
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
633
979
|
*/
|
|
634
980
|
createRole<ThrowOnError extends boolean = true>(options: Options<CreateRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateRoleResponses, CreateRoleErrors, ThrowOnError, "fields">;
|
|
635
981
|
/**
|
|
636
|
-
*
|
|
982
|
+
* Get the default postgres role
|
|
637
983
|
*
|
|
638
984
|
* ### Authorization
|
|
639
985
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
640
986
|
*
|
|
641
987
|
* **Service Token Accesses**
|
|
642
|
-
* `
|
|
988
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
643
989
|
*
|
|
644
990
|
* **OAuth Scopes**
|
|
645
991
|
*
|
|
646
992
|
* | Resource | Scopes |
|
|
647
993
|
* | :------- | :---------- |
|
|
648
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
649
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
650
|
-
* | Branch | `manage_passwords` |
|
|
994
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
995
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
996
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
651
997
|
*/
|
|
652
|
-
|
|
998
|
+
getDefaultRole<ThrowOnError extends boolean = true>(options: Options<GetDefaultRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDefaultRoleResponses, GetDefaultRoleErrors, ThrowOnError, "fields">;
|
|
653
999
|
/**
|
|
654
|
-
*
|
|
1000
|
+
* Reset default credentials
|
|
655
1001
|
*
|
|
656
1002
|
* ### Authorization
|
|
657
1003
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
658
1004
|
*
|
|
659
1005
|
* **Service Token Accesses**
|
|
660
|
-
* `
|
|
1006
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
661
1007
|
*
|
|
662
1008
|
* **OAuth Scopes**
|
|
663
1009
|
*
|
|
664
1010
|
* | Resource | Scopes |
|
|
665
1011
|
* | :------- | :---------- |
|
|
666
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
667
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
668
|
-
* | Branch | `manage_passwords` |
|
|
1012
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1013
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1014
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
669
1015
|
*/
|
|
670
|
-
|
|
1016
|
+
resetDefaultRole<ThrowOnError extends boolean = true>(options: Options<ResetDefaultRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ResetDefaultRoleResponses, ResetDefaultRoleErrors, ThrowOnError, "fields">;
|
|
671
1017
|
/**
|
|
672
|
-
*
|
|
1018
|
+
* Delete role credentials
|
|
673
1019
|
*
|
|
674
1020
|
* ### Authorization
|
|
675
1021
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
676
1022
|
*
|
|
677
1023
|
* **Service Token Accesses**
|
|
678
|
-
* `
|
|
1024
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
679
1025
|
*
|
|
680
1026
|
* **OAuth Scopes**
|
|
681
1027
|
*
|
|
682
1028
|
* | Resource | Scopes |
|
|
683
1029
|
* | :------- | :---------- |
|
|
684
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
685
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
686
|
-
* | Branch | `manage_passwords` |
|
|
1030
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1031
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1032
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
687
1033
|
*/
|
|
688
|
-
|
|
1034
|
+
deleteRole<ThrowOnError extends boolean = true>(options: Options<DeleteRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteRoleResponses, DeleteRoleErrors, ThrowOnError, "fields">;
|
|
689
1035
|
/**
|
|
690
|
-
*
|
|
1036
|
+
* Get a role
|
|
691
1037
|
*
|
|
692
1038
|
* ### Authorization
|
|
693
1039
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
694
1040
|
*
|
|
695
1041
|
* **Service Token Accesses**
|
|
696
|
-
* `
|
|
1042
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
697
1043
|
*
|
|
698
1044
|
* **OAuth Scopes**
|
|
699
1045
|
*
|
|
700
1046
|
* | Resource | Scopes |
|
|
701
1047
|
* | :------- | :---------- |
|
|
702
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
703
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
704
|
-
* | Branch | `manage_passwords` |
|
|
1048
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1049
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1050
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
705
1051
|
*/
|
|
706
|
-
|
|
1052
|
+
getRole<ThrowOnError extends boolean = true>(options: Options<GetRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetRoleResponses, GetRoleErrors, ThrowOnError, "fields">;
|
|
707
1053
|
/**
|
|
708
|
-
*
|
|
1054
|
+
* Update role name
|
|
709
1055
|
*
|
|
710
1056
|
* ### Authorization
|
|
711
1057
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
712
1058
|
*
|
|
713
1059
|
* **Service Token Accesses**
|
|
714
|
-
* `
|
|
1060
|
+
* `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
|
|
715
1061
|
*
|
|
716
1062
|
* **OAuth Scopes**
|
|
717
1063
|
*
|
|
718
1064
|
* | Resource | Scopes |
|
|
719
1065
|
* | :------- | :---------- |
|
|
720
|
-
* | Organization | `
|
|
721
|
-
* | Database | `
|
|
722
|
-
* | Branch | `
|
|
1066
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1067
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1068
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
723
1069
|
*/
|
|
724
|
-
|
|
1070
|
+
updateRole<ThrowOnError extends boolean = true>(options: Options<UpdateRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateRoleResponses, UpdateRoleErrors, ThrowOnError, "fields">;
|
|
725
1071
|
/**
|
|
726
|
-
*
|
|
1072
|
+
* Reassign objects owned by one role to another role
|
|
727
1073
|
*
|
|
728
1074
|
* ### Authorization
|
|
729
1075
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
730
1076
|
*
|
|
731
1077
|
* **Service Token Accesses**
|
|
732
|
-
* `
|
|
1078
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
733
1079
|
*
|
|
734
1080
|
* **OAuth Scopes**
|
|
735
1081
|
*
|
|
736
1082
|
* | Resource | Scopes |
|
|
737
1083
|
* | :------- | :---------- |
|
|
738
|
-
* | Organization | `
|
|
739
|
-
* | Database | `
|
|
740
|
-
* | Branch | `
|
|
1084
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1085
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1086
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
741
1087
|
*/
|
|
742
|
-
|
|
1088
|
+
reassignRoleObjects<ThrowOnError extends boolean = true>(options: Options<ReassignRoleObjectsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ReassignRoleObjectsResponses, ReassignRoleObjectsErrors, ThrowOnError, "fields">;
|
|
743
1089
|
/**
|
|
744
|
-
*
|
|
745
|
-
*
|
|
746
|
-
* ### Authorization
|
|
747
|
-
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
748
|
-
*
|
|
749
|
-
* **Service Token Accesses**
|
|
750
|
-
* `write_database`
|
|
751
|
-
*
|
|
1090
|
+
* Renew role expiration
|
|
752
1091
|
*
|
|
753
|
-
*/
|
|
754
|
-
updateBranchClusterConfig<ThrowOnError extends boolean = true>(options: Options<UpdateBranchClusterConfigData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBranchClusterConfigResponses, UpdateBranchClusterConfigErrors, ThrowOnError, "fields">;
|
|
755
|
-
/**
|
|
756
|
-
* Demote a branch
|
|
757
|
-
* Demotes a branch from production to development
|
|
758
1092
|
* ### Authorization
|
|
759
1093
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
760
1094
|
*
|
|
761
1095
|
* **Service Token Accesses**
|
|
762
|
-
* `
|
|
1096
|
+
* `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
|
|
763
1097
|
*
|
|
764
1098
|
* **OAuth Scopes**
|
|
765
1099
|
*
|
|
766
1100
|
* | Resource | Scopes |
|
|
767
1101
|
* | :------- | :---------- |
|
|
768
|
-
* | Organization | `
|
|
769
|
-
* | Database | `
|
|
1102
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1103
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1104
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
770
1105
|
*/
|
|
771
|
-
|
|
1106
|
+
renewRole<ThrowOnError extends boolean = true>(options: Options<RenewRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<RenewRoleResponses, RenewRoleErrors, ThrowOnError, "fields">;
|
|
772
1107
|
/**
|
|
773
|
-
*
|
|
774
|
-
*
|
|
1108
|
+
* Reset a role's password
|
|
1109
|
+
*
|
|
775
1110
|
* ### Authorization
|
|
776
1111
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
777
1112
|
*
|
|
778
1113
|
* **Service Token Accesses**
|
|
779
|
-
* `
|
|
1114
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
780
1115
|
*
|
|
781
1116
|
* **OAuth Scopes**
|
|
782
1117
|
*
|
|
783
1118
|
* | Resource | Scopes |
|
|
784
1119
|
* | :------- | :---------- |
|
|
785
|
-
* | Organization | `
|
|
786
|
-
* | Database | `
|
|
1120
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1121
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1122
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
787
1123
|
*/
|
|
788
|
-
|
|
1124
|
+
resetRole<ThrowOnError extends boolean = true>(options: Options<ResetRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ResetRoleResponses, ResetRoleErrors, ThrowOnError, "fields">;
|
|
789
1125
|
/**
|
|
790
1126
|
* Disable safe migrations for a branch
|
|
791
1127
|
*
|
|
@@ -834,6 +1170,76 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
834
1170
|
* | Branch | `read_branch` |
|
|
835
1171
|
*/
|
|
836
1172
|
lintBranchSchema<ThrowOnError extends boolean = true>(options: Options<LintBranchSchemaData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<LintBranchSchemaResponses, LintBranchSchemaErrors, ThrowOnError, "fields">;
|
|
1173
|
+
/**
|
|
1174
|
+
* List IP restriction entries
|
|
1175
|
+
*
|
|
1176
|
+
* ### Authorization
|
|
1177
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1178
|
+
*
|
|
1179
|
+
* **OAuth Scopes**
|
|
1180
|
+
*
|
|
1181
|
+
* | Resource | Scopes |
|
|
1182
|
+
* | :------- | :---------- |
|
|
1183
|
+
* | Organization | `read_databases` |
|
|
1184
|
+
* | Database | `read_database` |
|
|
1185
|
+
*/
|
|
1186
|
+
listDatabasePostgresCidrs<ThrowOnError extends boolean = true>(options: Options<ListDatabasePostgresCidrsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDatabasePostgresCidrsResponses, ListDatabasePostgresCidrsErrors, ThrowOnError, "fields">;
|
|
1187
|
+
/**
|
|
1188
|
+
* Create an IP restriction entry
|
|
1189
|
+
*
|
|
1190
|
+
* ### Authorization
|
|
1191
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1192
|
+
*
|
|
1193
|
+
* **OAuth Scopes**
|
|
1194
|
+
*
|
|
1195
|
+
* | Resource | Scopes |
|
|
1196
|
+
* | :------- | :---------- |
|
|
1197
|
+
* | Organization | `write_databases` |
|
|
1198
|
+
* | Database | `write_database` |
|
|
1199
|
+
*/
|
|
1200
|
+
createDatabasePostgresCidr<ThrowOnError extends boolean = true>(options: Options<CreateDatabasePostgresCidrData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateDatabasePostgresCidrResponses, CreateDatabasePostgresCidrErrors, ThrowOnError, "fields">;
|
|
1201
|
+
/**
|
|
1202
|
+
* Delete an IP restriction entry
|
|
1203
|
+
*
|
|
1204
|
+
* ### Authorization
|
|
1205
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1206
|
+
*
|
|
1207
|
+
* **OAuth Scopes**
|
|
1208
|
+
*
|
|
1209
|
+
* | Resource | Scopes |
|
|
1210
|
+
* | :------- | :---------- |
|
|
1211
|
+
* | Organization | `write_databases` |
|
|
1212
|
+
* | Database | `write_database` |
|
|
1213
|
+
*/
|
|
1214
|
+
deleteDatabasePostgresCidr<ThrowOnError extends boolean = true>(options: Options<DeleteDatabasePostgresCidrData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteDatabasePostgresCidrResponses, DeleteDatabasePostgresCidrErrors, ThrowOnError, "fields">;
|
|
1215
|
+
/**
|
|
1216
|
+
* Get an IP restriction entry
|
|
1217
|
+
*
|
|
1218
|
+
* ### Authorization
|
|
1219
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1220
|
+
*
|
|
1221
|
+
* **OAuth Scopes**
|
|
1222
|
+
*
|
|
1223
|
+
* | Resource | Scopes |
|
|
1224
|
+
* | :------- | :---------- |
|
|
1225
|
+
* | Organization | `read_databases` |
|
|
1226
|
+
* | Database | `read_database` |
|
|
1227
|
+
*/
|
|
1228
|
+
getDatabasePostgresCidr<ThrowOnError extends boolean = true>(options: Options<GetDatabasePostgresCidrData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDatabasePostgresCidrResponses, GetDatabasePostgresCidrErrors, ThrowOnError, "fields">;
|
|
1229
|
+
/**
|
|
1230
|
+
* Update an IP restriction entry
|
|
1231
|
+
*
|
|
1232
|
+
* ### Authorization
|
|
1233
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1234
|
+
*
|
|
1235
|
+
* **OAuth Scopes**
|
|
1236
|
+
*
|
|
1237
|
+
* | Resource | Scopes |
|
|
1238
|
+
* | :------- | :---------- |
|
|
1239
|
+
* | Organization | `write_databases` |
|
|
1240
|
+
* | Database | `write_database` |
|
|
1241
|
+
*/
|
|
1242
|
+
updateDatabasePostgresCidr<ThrowOnError extends boolean = true>(options: Options<UpdateDatabasePostgresCidrData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateDatabasePostgresCidrResponses, UpdateDatabasePostgresCidrErrors, ThrowOnError, "fields">;
|
|
837
1243
|
/**
|
|
838
1244
|
* Get the deploy queue
|
|
839
1245
|
* The deploy queue returns the current list of deploy requests in the order they will be deployed.
|
|
@@ -942,6 +1348,23 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
942
1348
|
* | Database | `deploy_deploy_requests` |
|
|
943
1349
|
*/
|
|
944
1350
|
updateAutoApply<ThrowOnError extends boolean = true>(options: Options<UpdateAutoApplyData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateAutoApplyResponses, UpdateAutoApplyErrors, ThrowOnError, "fields">;
|
|
1351
|
+
/**
|
|
1352
|
+
* Update auto-delete branch for deploy request
|
|
1353
|
+
* Enables or disabled the auto-delete branch setting for a deploy request
|
|
1354
|
+
* ### Authorization
|
|
1355
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1356
|
+
*
|
|
1357
|
+
* **Service Token Accesses**
|
|
1358
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1359
|
+
*
|
|
1360
|
+
* **OAuth Scopes**
|
|
1361
|
+
*
|
|
1362
|
+
* | Resource | Scopes |
|
|
1363
|
+
* | :------- | :---------- |
|
|
1364
|
+
* | Organization | `deploy_deploy_requests` |
|
|
1365
|
+
* | Database | `deploy_deploy_requests` |
|
|
1366
|
+
*/
|
|
1367
|
+
updateAutoDeleteBranch<ThrowOnError extends boolean = true>(options: Options<UpdateAutoDeleteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateAutoDeleteBranchResponses, UpdateAutoDeleteBranchErrors, ThrowOnError, "fields">;
|
|
945
1368
|
/**
|
|
946
1369
|
* Cancel a queued deploy request
|
|
947
1370
|
*
|
|
@@ -1129,6 +1552,91 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
1129
1552
|
* | Database | `deploy_deploy_requests` |
|
|
1130
1553
|
*/
|
|
1131
1554
|
updateDeployRequestThrottler<ThrowOnError extends boolean = true>(options: Options<UpdateDeployRequestThrottlerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateDeployRequestThrottlerResponses, UpdateDeployRequestThrottlerErrors, ThrowOnError, "fields">;
|
|
1555
|
+
/**
|
|
1556
|
+
* List read-only regions
|
|
1557
|
+
* List read-only regions for the database's default branch
|
|
1558
|
+
* ### Authorization
|
|
1559
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1560
|
+
*
|
|
1561
|
+
* **Service Token Accesses**
|
|
1562
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
1563
|
+
*
|
|
1564
|
+
* **OAuth Scopes**
|
|
1565
|
+
*
|
|
1566
|
+
* | Resource | Scopes |
|
|
1567
|
+
* | :------- | :---------- |
|
|
1568
|
+
* | Organization | `read_branches` |
|
|
1569
|
+
* | Database | `read_branches` |
|
|
1570
|
+
*/
|
|
1571
|
+
listReadOnlyRegions<ThrowOnError extends boolean = true>(options: Options<ListReadOnlyRegionsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListReadOnlyRegionsResponses, ListReadOnlyRegionsErrors, ThrowOnError, "fields">;
|
|
1572
|
+
/**
|
|
1573
|
+
* List database regions
|
|
1574
|
+
*
|
|
1575
|
+
* ### Authorization
|
|
1576
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1577
|
+
*
|
|
1578
|
+
* **Service Token Accesses**
|
|
1579
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
1580
|
+
*
|
|
1581
|
+
* **OAuth Scopes**
|
|
1582
|
+
*
|
|
1583
|
+
* | Resource | Scopes |
|
|
1584
|
+
* | :------- | :---------- |
|
|
1585
|
+
* | Organization | `read_databases` |
|
|
1586
|
+
* | Database | `read_database` |
|
|
1587
|
+
*/
|
|
1588
|
+
listDatabaseRegions<ThrowOnError extends boolean = true>(options: Options<ListDatabaseRegionsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDatabaseRegionsResponses, ListDatabaseRegionsErrors, ThrowOnError, "fields">;
|
|
1589
|
+
/**
|
|
1590
|
+
* List schema recommendations
|
|
1591
|
+
*
|
|
1592
|
+
* ### Authorization
|
|
1593
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1594
|
+
*
|
|
1595
|
+
* **Service Token Accesses**
|
|
1596
|
+
* `read_database`
|
|
1597
|
+
*
|
|
1598
|
+
* **OAuth Scopes**
|
|
1599
|
+
*
|
|
1600
|
+
* | Resource | Scopes |
|
|
1601
|
+
* | :------- | :---------- |
|
|
1602
|
+
* | Organization | `read_databases` |
|
|
1603
|
+
* | Database | `read_database` |
|
|
1604
|
+
*/
|
|
1605
|
+
listSchemaRecommendations<ThrowOnError extends boolean = true>(options: Options<ListSchemaRecommendationsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListSchemaRecommendationsResponses, ListSchemaRecommendationsErrors, ThrowOnError, "fields">;
|
|
1606
|
+
/**
|
|
1607
|
+
* Get a schema recommendation
|
|
1608
|
+
*
|
|
1609
|
+
* ### Authorization
|
|
1610
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1611
|
+
*
|
|
1612
|
+
* **Service Token Accesses**
|
|
1613
|
+
* `read_database`
|
|
1614
|
+
*
|
|
1615
|
+
* **OAuth Scopes**
|
|
1616
|
+
*
|
|
1617
|
+
* | Resource | Scopes |
|
|
1618
|
+
* | :------- | :---------- |
|
|
1619
|
+
* | Organization | `read_databases` |
|
|
1620
|
+
* | Database | `read_database` |
|
|
1621
|
+
*/
|
|
1622
|
+
getSchemaRecommendation<ThrowOnError extends boolean = true>(options: Options<GetSchemaRecommendationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetSchemaRecommendationResponses, GetSchemaRecommendationErrors, ThrowOnError, "fields">;
|
|
1623
|
+
/**
|
|
1624
|
+
* Dismiss a schema recommendation
|
|
1625
|
+
*
|
|
1626
|
+
* ### Authorization
|
|
1627
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1628
|
+
*
|
|
1629
|
+
* **Service Token Accesses**
|
|
1630
|
+
* `write_database`
|
|
1631
|
+
*
|
|
1632
|
+
* **OAuth Scopes**
|
|
1633
|
+
*
|
|
1634
|
+
* | Resource | Scopes |
|
|
1635
|
+
* | :------- | :---------- |
|
|
1636
|
+
* | Organization | `write_databases` |
|
|
1637
|
+
* | Database | `write_database` |
|
|
1638
|
+
*/
|
|
1639
|
+
dismissSchemaRecommendation<ThrowOnError extends boolean = true>(options: Options<DismissSchemaRecommendationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DismissSchemaRecommendationResponses, DismissSchemaRecommendationErrors, ThrowOnError, "fields">;
|
|
1132
1640
|
/**
|
|
1133
1641
|
* Get database throttler configurations
|
|
1134
1642
|
*
|
|
@@ -1338,150 +1846,117 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
1338
1846
|
*/
|
|
1339
1847
|
verifyWorkflow<ThrowOnError extends boolean = true>(options: Options<VerifyWorkflowData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<VerifyWorkflowResponses, VerifyWorkflowErrors, ThrowOnError, "fields">;
|
|
1340
1848
|
/**
|
|
1341
|
-
*
|
|
1342
|
-
*
|
|
1343
|
-
* ### Authorization
|
|
1344
|
-
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1345
|
-
*
|
|
1346
|
-
* **Service Token Accesses**
|
|
1347
|
-
* `delete_database`
|
|
1348
|
-
*
|
|
1349
|
-
* **OAuth Scopes**
|
|
1350
|
-
*
|
|
1351
|
-
* | Resource | Scopes |
|
|
1352
|
-
* | :------- | :---------- |
|
|
1353
|
-
* | Organization | `delete_databases` |
|
|
1354
|
-
* | Database | `delete_database` |
|
|
1355
|
-
*/
|
|
1356
|
-
deleteDatabase<ThrowOnError extends boolean = true>(options: Options<DeleteDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteDatabaseResponses, DeleteDatabaseErrors, ThrowOnError, "fields">;
|
|
1357
|
-
/**
|
|
1358
|
-
* Get a database
|
|
1359
|
-
*
|
|
1849
|
+
* Get invoices
|
|
1850
|
+
* Get the invoices for an organization
|
|
1360
1851
|
* ### Authorization
|
|
1361
1852
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1362
1853
|
*
|
|
1363
1854
|
* **Service Token Accesses**
|
|
1364
|
-
* `
|
|
1855
|
+
* `read_invoices`
|
|
1365
1856
|
*
|
|
1366
1857
|
* **OAuth Scopes**
|
|
1367
1858
|
*
|
|
1368
1859
|
* | Resource | Scopes |
|
|
1369
1860
|
* | :------- | :---------- |
|
|
1370
|
-
* | Organization | `
|
|
1371
|
-
* | Database | `read_database` |
|
|
1861
|
+
* | Organization | `read_invoices` |
|
|
1372
1862
|
*/
|
|
1373
|
-
|
|
1863
|
+
listInvoices<ThrowOnError extends boolean = true>(options: Options<ListInvoicesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
1374
1864
|
/**
|
|
1375
|
-
*
|
|
1865
|
+
* Get an invoice
|
|
1376
1866
|
*
|
|
1377
1867
|
* ### Authorization
|
|
1378
1868
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1379
1869
|
*
|
|
1380
1870
|
* **Service Token Accesses**
|
|
1381
|
-
* `
|
|
1871
|
+
* `read_invoices`
|
|
1382
1872
|
*
|
|
1383
1873
|
* **OAuth Scopes**
|
|
1384
1874
|
*
|
|
1385
1875
|
* | Resource | Scopes |
|
|
1386
1876
|
* | :------- | :---------- |
|
|
1387
|
-
* | Organization | `
|
|
1388
|
-
* | Database | `write_database` |
|
|
1877
|
+
* | Organization | `read_invoices` |
|
|
1389
1878
|
*/
|
|
1390
|
-
|
|
1879
|
+
getInvoice<ThrowOnError extends boolean = true>(options: Options<GetInvoiceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetInvoiceResponses, GetInvoiceErrors, ThrowOnError, "fields">;
|
|
1391
1880
|
/**
|
|
1392
|
-
*
|
|
1393
|
-
*
|
|
1881
|
+
* Get invoice line items
|
|
1882
|
+
* Get the line items for an invoice
|
|
1394
1883
|
* ### Authorization
|
|
1395
1884
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1396
1885
|
*
|
|
1397
1886
|
* **Service Token Accesses**
|
|
1398
|
-
* `
|
|
1887
|
+
* `read_invoices`
|
|
1399
1888
|
*
|
|
1400
1889
|
* **OAuth Scopes**
|
|
1401
1890
|
*
|
|
1402
1891
|
* | Resource | Scopes |
|
|
1403
1892
|
* | :------- | :---------- |
|
|
1404
|
-
* | Organization | `
|
|
1405
|
-
* | Database | `read_branches` |
|
|
1893
|
+
* | Organization | `read_invoices` |
|
|
1406
1894
|
*/
|
|
1407
|
-
|
|
1895
|
+
getInvoiceLineItems<ThrowOnError extends boolean = true>(options: Options<GetInvoiceLineItemsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetInvoiceLineItemsResponses, GetInvoiceLineItemsErrors, ThrowOnError, "fields">;
|
|
1408
1896
|
/**
|
|
1409
|
-
* List
|
|
1897
|
+
* List organization members
|
|
1410
1898
|
*
|
|
1411
1899
|
* ### Authorization
|
|
1412
1900
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1413
1901
|
*
|
|
1414
1902
|
* **Service Token Accesses**
|
|
1415
|
-
* `
|
|
1903
|
+
* `read_organization`
|
|
1416
1904
|
*
|
|
1417
1905
|
* **OAuth Scopes**
|
|
1418
1906
|
*
|
|
1419
1907
|
* | Resource | Scopes |
|
|
1420
1908
|
* | :------- | :---------- |
|
|
1421
|
-
* | Organization | `
|
|
1422
|
-
* | Database | `read_database` |
|
|
1909
|
+
* | Organization | `read_organization` |
|
|
1423
1910
|
*/
|
|
1424
|
-
|
|
1911
|
+
listOrganizationMembers<ThrowOnError extends boolean = true>(options: Options<ListOrganizationMembersData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOrganizationMembersResponses, ListOrganizationMembersErrors, ThrowOnError, "fields">;
|
|
1425
1912
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
*
|
|
1913
|
+
* Remove a member from an organization
|
|
1914
|
+
*
|
|
1428
1915
|
* ### Authorization
|
|
1429
1916
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1430
1917
|
*
|
|
1431
1918
|
* **Service Token Accesses**
|
|
1432
|
-
* `
|
|
1919
|
+
* `write_organization`
|
|
1433
1920
|
*
|
|
1434
1921
|
* **OAuth Scopes**
|
|
1435
1922
|
*
|
|
1436
1923
|
* | Resource | Scopes |
|
|
1437
1924
|
* | :------- | :---------- |
|
|
1438
|
-
* | Organization | `
|
|
1925
|
+
* | Organization | `write_organization` |
|
|
1439
1926
|
*/
|
|
1440
|
-
|
|
1927
|
+
removeOrganizationMember<ThrowOnError extends boolean = true>(options: Options<RemoveOrganizationMemberData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<RemoveOrganizationMemberResponses, RemoveOrganizationMemberErrors, ThrowOnError, "fields">;
|
|
1441
1928
|
/**
|
|
1442
|
-
* Get an
|
|
1929
|
+
* Get an organization member
|
|
1443
1930
|
*
|
|
1444
1931
|
* ### Authorization
|
|
1445
1932
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1446
1933
|
*
|
|
1447
1934
|
* **Service Token Accesses**
|
|
1448
|
-
* `
|
|
1935
|
+
* `read_organization`
|
|
1449
1936
|
*
|
|
1450
1937
|
* **OAuth Scopes**
|
|
1451
1938
|
*
|
|
1452
1939
|
* | Resource | Scopes |
|
|
1453
1940
|
* | :------- | :---------- |
|
|
1454
|
-
* | Organization | `
|
|
1941
|
+
* | Organization | `read_organization` |
|
|
1455
1942
|
*/
|
|
1456
|
-
|
|
1943
|
+
getOrganizationMembership<ThrowOnError extends boolean = true>(options: Options<GetOrganizationMembershipData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetOrganizationMembershipResponses, GetOrganizationMembershipErrors, ThrowOnError, "fields">;
|
|
1457
1944
|
/**
|
|
1458
|
-
*
|
|
1459
|
-
*
|
|
1945
|
+
* Update organization member role
|
|
1946
|
+
*
|
|
1460
1947
|
* ### Authorization
|
|
1461
1948
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1462
1949
|
*
|
|
1463
1950
|
* **Service Token Accesses**
|
|
1464
|
-
* `
|
|
1951
|
+
* `write_organization`
|
|
1465
1952
|
*
|
|
1466
1953
|
* **OAuth Scopes**
|
|
1467
1954
|
*
|
|
1468
1955
|
* | Resource | Scopes |
|
|
1469
1956
|
* | :------- | :---------- |
|
|
1470
|
-
* | Organization | `
|
|
1471
|
-
*/
|
|
1472
|
-
getInvoiceLineItems<ThrowOnError extends boolean = true>(options: Options<GetInvoiceLineItemsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetInvoiceLineItemsResponses, GetInvoiceLineItemsErrors, ThrowOnError, "fields">;
|
|
1473
|
-
/**
|
|
1474
|
-
* List organization members
|
|
1475
|
-
*
|
|
1476
|
-
* ### Authorization
|
|
1477
|
-
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1478
|
-
*
|
|
1479
|
-
* **Service Token Accesses**
|
|
1480
|
-
* `read_organization`
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1957
|
+
* | Organization | `write_organization` |
|
|
1483
1958
|
*/
|
|
1484
|
-
|
|
1959
|
+
updateOrganizationMembership<ThrowOnError extends boolean = true>(options: Options<UpdateOrganizationMembershipData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateOrganizationMembershipResponses, UpdateOrganizationMembershipErrors, ThrowOnError, "fields">;
|
|
1485
1960
|
/**
|
|
1486
1961
|
* List OAuth applications
|
|
1487
1962
|
*
|
|
@@ -1554,6 +2029,215 @@ export declare class PlanetScaleClient extends _HeyApiClient {
|
|
|
1554
2029
|
*
|
|
1555
2030
|
*/
|
|
1556
2031
|
createOauthToken<ThrowOnError extends boolean = true>(options: Options<CreateOauthTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateOauthTokenResponses, CreateOauthTokenErrors, ThrowOnError, "fields">;
|
|
2032
|
+
/**
|
|
2033
|
+
* List regions for an organization
|
|
2034
|
+
*
|
|
2035
|
+
* ### Authorization
|
|
2036
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2037
|
+
*
|
|
2038
|
+
* **Service Token Accesses**
|
|
2039
|
+
* `read_organization`
|
|
2040
|
+
*
|
|
2041
|
+
* **OAuth Scopes**
|
|
2042
|
+
*
|
|
2043
|
+
* | Resource | Scopes |
|
|
2044
|
+
* | :------- | :---------- |
|
|
2045
|
+
* | User | `read_organizations` |
|
|
2046
|
+
* | Organization | `read_organization` |
|
|
2047
|
+
*/
|
|
2048
|
+
listRegionsForOrganization<ThrowOnError extends boolean = true>(options: Options<ListRegionsForOrganizationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListRegionsForOrganizationResponses, ListRegionsForOrganizationErrors, ThrowOnError, "fields">;
|
|
2049
|
+
/**
|
|
2050
|
+
* List service tokens
|
|
2051
|
+
* List service tokens for an organization.
|
|
2052
|
+
* ### Authorization
|
|
2053
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2054
|
+
*
|
|
2055
|
+
* **Service Token Accesses**
|
|
2056
|
+
* `read_service_tokens`
|
|
2057
|
+
*
|
|
2058
|
+
*
|
|
2059
|
+
*/
|
|
2060
|
+
listServiceTokens<ThrowOnError extends boolean = true>(options: Options<ListServiceTokensData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListServiceTokensResponses, ListServiceTokensErrors, ThrowOnError, "fields">;
|
|
2061
|
+
/**
|
|
2062
|
+
* Create a service token
|
|
2063
|
+
* Create a new service token for the organization.
|
|
2064
|
+
* ### Authorization
|
|
2065
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2066
|
+
*
|
|
2067
|
+
* **Service Token Accesses**
|
|
2068
|
+
* `write_service_tokens`
|
|
2069
|
+
*
|
|
2070
|
+
*
|
|
2071
|
+
*/
|
|
2072
|
+
createServiceToken<ThrowOnError extends boolean = true>(options: Options<CreateServiceTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateServiceTokenResponses, CreateServiceTokenErrors, ThrowOnError, "fields">;
|
|
2073
|
+
/**
|
|
2074
|
+
* Delete a service token
|
|
2075
|
+
* Delete a service token from the organization.
|
|
2076
|
+
* ### Authorization
|
|
2077
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2078
|
+
*
|
|
2079
|
+
* **Service Token Accesses**
|
|
2080
|
+
* `delete_service_tokens`
|
|
2081
|
+
*
|
|
2082
|
+
*
|
|
2083
|
+
*/
|
|
2084
|
+
deleteServiceToken<ThrowOnError extends boolean = true>(options: Options<DeleteServiceTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteServiceTokenResponses, DeleteServiceTokenErrors, ThrowOnError, "fields">;
|
|
2085
|
+
/**
|
|
2086
|
+
* Get a service token
|
|
2087
|
+
* Get information about a service token.
|
|
2088
|
+
* ### Authorization
|
|
2089
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2090
|
+
*
|
|
2091
|
+
* **Service Token Accesses**
|
|
2092
|
+
* `read_service_tokens`
|
|
2093
|
+
*
|
|
2094
|
+
*
|
|
2095
|
+
*/
|
|
2096
|
+
getServiceToken<ThrowOnError extends boolean = true>(options: Options<GetServiceTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetServiceTokenResponses, GetServiceTokenErrors, ThrowOnError, "fields">;
|
|
2097
|
+
/**
|
|
2098
|
+
* List teams in an organization
|
|
2099
|
+
*
|
|
2100
|
+
* ### Authorization
|
|
2101
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2102
|
+
*
|
|
2103
|
+
* **Service Token Accesses**
|
|
2104
|
+
* `read_organization`
|
|
2105
|
+
*
|
|
2106
|
+
* **OAuth Scopes**
|
|
2107
|
+
*
|
|
2108
|
+
* | Resource | Scopes |
|
|
2109
|
+
* | :------- | :---------- |
|
|
2110
|
+
* | Organization | `read_organization` |
|
|
2111
|
+
*/
|
|
2112
|
+
listOrganizationTeams<ThrowOnError extends boolean = true>(options: Options<ListOrganizationTeamsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOrganizationTeamsResponses, ListOrganizationTeamsErrors, ThrowOnError, "fields">;
|
|
2113
|
+
/**
|
|
2114
|
+
* Create an organization team
|
|
2115
|
+
*
|
|
2116
|
+
* ### Authorization
|
|
2117
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2118
|
+
*
|
|
2119
|
+
* **Service Token Accesses**
|
|
2120
|
+
* `write_teams`
|
|
2121
|
+
*
|
|
2122
|
+
* **OAuth Scopes**
|
|
2123
|
+
*
|
|
2124
|
+
* | Resource | Scopes |
|
|
2125
|
+
* | :------- | :---------- |
|
|
2126
|
+
* | Organization | `write_organization` |
|
|
2127
|
+
*/
|
|
2128
|
+
createOrganizationTeam<ThrowOnError extends boolean = true>(options: Options<CreateOrganizationTeamData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateOrganizationTeamResponses, CreateOrganizationTeamErrors, ThrowOnError, "fields">;
|
|
2129
|
+
/**
|
|
2130
|
+
* Delete an organization team
|
|
2131
|
+
*
|
|
2132
|
+
* ### Authorization
|
|
2133
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2134
|
+
*
|
|
2135
|
+
* **Service Token Accesses**
|
|
2136
|
+
* `write_teams`
|
|
2137
|
+
*
|
|
2138
|
+
* **OAuth Scopes**
|
|
2139
|
+
*
|
|
2140
|
+
* | Resource | Scopes |
|
|
2141
|
+
* | :------- | :---------- |
|
|
2142
|
+
* | Organization | `write_organization` |
|
|
2143
|
+
*/
|
|
2144
|
+
deleteOrganizationTeam<ThrowOnError extends boolean = true>(options: Options<DeleteOrganizationTeamData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteOrganizationTeamResponses, DeleteOrganizationTeamErrors, ThrowOnError, "fields">;
|
|
2145
|
+
/**
|
|
2146
|
+
* Get an organization team
|
|
2147
|
+
*
|
|
2148
|
+
* ### Authorization
|
|
2149
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2150
|
+
*
|
|
2151
|
+
* **Service Token Accesses**
|
|
2152
|
+
* `read_organization`
|
|
2153
|
+
*
|
|
2154
|
+
* **OAuth Scopes**
|
|
2155
|
+
*
|
|
2156
|
+
* | Resource | Scopes |
|
|
2157
|
+
* | :------- | :---------- |
|
|
2158
|
+
* | Organization | `read_organization` |
|
|
2159
|
+
*/
|
|
2160
|
+
getOrganizationTeam<ThrowOnError extends boolean = true>(options: Options<GetOrganizationTeamData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetOrganizationTeamResponses, GetOrganizationTeamErrors, ThrowOnError, "fields">;
|
|
2161
|
+
/**
|
|
2162
|
+
* Update an organization team
|
|
2163
|
+
*
|
|
2164
|
+
* ### Authorization
|
|
2165
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2166
|
+
*
|
|
2167
|
+
* **Service Token Accesses**
|
|
2168
|
+
* `write_teams`
|
|
2169
|
+
*
|
|
2170
|
+
* **OAuth Scopes**
|
|
2171
|
+
*
|
|
2172
|
+
* | Resource | Scopes |
|
|
2173
|
+
* | :------- | :---------- |
|
|
2174
|
+
* | Organization | `write_organization` |
|
|
2175
|
+
*/
|
|
2176
|
+
updateOrganizationTeam<ThrowOnError extends boolean = true>(options: Options<UpdateOrganizationTeamData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateOrganizationTeamResponses, UpdateOrganizationTeamErrors, ThrowOnError, "fields">;
|
|
2177
|
+
/**
|
|
2178
|
+
* List team members
|
|
2179
|
+
*
|
|
2180
|
+
* ### Authorization
|
|
2181
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2182
|
+
*
|
|
2183
|
+
* **Service Token Accesses**
|
|
2184
|
+
* `read_organization`
|
|
2185
|
+
*
|
|
2186
|
+
* **OAuth Scopes**
|
|
2187
|
+
*
|
|
2188
|
+
* | Resource | Scopes |
|
|
2189
|
+
* | :------- | :---------- |
|
|
2190
|
+
* | Organization | `read_organization` |
|
|
2191
|
+
*/
|
|
2192
|
+
listOrganizationTeamMembers<ThrowOnError extends boolean = true>(options: Options<ListOrganizationTeamMembersData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOrganizationTeamMembersResponses, ListOrganizationTeamMembersErrors, ThrowOnError, "fields">;
|
|
2193
|
+
/**
|
|
2194
|
+
* Add a member to a team
|
|
2195
|
+
*
|
|
2196
|
+
* ### Authorization
|
|
2197
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2198
|
+
*
|
|
2199
|
+
* **Service Token Accesses**
|
|
2200
|
+
* `write_teams`
|
|
2201
|
+
*
|
|
2202
|
+
* **OAuth Scopes**
|
|
2203
|
+
*
|
|
2204
|
+
* | Resource | Scopes |
|
|
2205
|
+
* | :------- | :---------- |
|
|
2206
|
+
* | Organization | `write_organization` |
|
|
2207
|
+
*/
|
|
2208
|
+
addOrganizationTeamMember<ThrowOnError extends boolean = true>(options: Options<AddOrganizationTeamMemberData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<AddOrganizationTeamMemberResponses, AddOrganizationTeamMemberErrors, ThrowOnError, "fields">;
|
|
2209
|
+
/**
|
|
2210
|
+
* Remove a member from a team
|
|
2211
|
+
*
|
|
2212
|
+
* ### Authorization
|
|
2213
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2214
|
+
*
|
|
2215
|
+
* **Service Token Accesses**
|
|
2216
|
+
* `write_teams`
|
|
2217
|
+
*
|
|
2218
|
+
* **OAuth Scopes**
|
|
2219
|
+
*
|
|
2220
|
+
* | Resource | Scopes |
|
|
2221
|
+
* | :------- | :---------- |
|
|
2222
|
+
* | Organization | `write_organization` |
|
|
2223
|
+
*/
|
|
2224
|
+
removeOrganizationTeamMember<ThrowOnError extends boolean = true>(options: Options<RemoveOrganizationTeamMemberData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<RemoveOrganizationTeamMemberResponses, RemoveOrganizationTeamMemberErrors, ThrowOnError, "fields">;
|
|
2225
|
+
/**
|
|
2226
|
+
* Get a team member
|
|
2227
|
+
*
|
|
2228
|
+
* ### Authorization
|
|
2229
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2230
|
+
*
|
|
2231
|
+
* **Service Token Accesses**
|
|
2232
|
+
* `read_organization`
|
|
2233
|
+
*
|
|
2234
|
+
* **OAuth Scopes**
|
|
2235
|
+
*
|
|
2236
|
+
* | Resource | Scopes |
|
|
2237
|
+
* | :------- | :---------- |
|
|
2238
|
+
* | Organization | `read_organization` |
|
|
2239
|
+
*/
|
|
2240
|
+
getOrganizationTeamMember<ThrowOnError extends boolean = true>(options: Options<GetOrganizationTeamMemberData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetOrganizationTeamMemberResponses, GetOrganizationTeamMemberErrors, ThrowOnError, "fields">;
|
|
1557
2241
|
/**
|
|
1558
2242
|
* List public regions
|
|
1559
2243
|
* Endpoint is available without authentication.
|