@appwrite.io/console 13.0.0 → 13.2.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/README.md +2 -2
- package/dist/cjs/sdk.js +5443 -1380
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +5438 -1381
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +5451 -1388
- package/package.json +1 -1
- package/types/channel.d.ts +8 -3
- package/types/client.d.ts +1 -1
- package/types/enums/account-key-scopes.d.ts +5 -0
- package/types/enums/addon.d.ts +2 -1
- package/types/enums/appwrite-migration-resource.d.ts +14 -1
- package/types/enums/backup-services.d.ts +1 -0
- package/types/enums/{resource-type.d.ts → block-resource-type.d.ts} +2 -6
- package/types/enums/{theme.d.ts → browser-theme.d.ts} +1 -1
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/cache-database.d.ts +5 -0
- package/types/enums/cache-target.d.ts +8 -0
- package/types/enums/{registration-type.d.ts → domain-registration-type.d.ts} +1 -1
- package/types/enums/{filter-type.d.ts → domain-suggestion-type.d.ts} +1 -1
- package/types/enums/embedding-model.d.ts +6 -0
- package/types/enums/function-template-use-case.d.ts +9 -0
- package/types/enums/{name.d.ts → health-queue-name.d.ts} +1 -1
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/organization-key-scopes.d.ts +12 -0
- package/types/enums/{auth-method.d.ts → project-auth-method-id.d.ts} +1 -1
- package/types/enums/{email-template-type.d.ts → project-email-template-id.d.ts} +1 -1
- package/types/enums/{email-template-locale.d.ts → project-email-template-locale.d.ts} +1 -1
- package/types/enums/{scopes.d.ts → project-key-scopes.d.ts} +12 -8
- package/types/enums/{prompt.d.ts → project-o-auth-2-google-prompt.d.ts} +1 -1
- package/types/enums/project-o-auth-provider-id.d.ts +45 -0
- package/types/enums/{project-policy.d.ts → project-policy-id.d.ts} +6 -2
- package/types/enums/{protocol-id.d.ts → project-protocol-id.d.ts} +1 -1
- package/types/enums/{service-id.d.ts → project-service-id.d.ts} +3 -2
- package/types/enums/project-smtp-secure.d.ts +4 -0
- package/types/enums/query-suggestion-resource.d.ts +13 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/schedule-resource-type.d.ts +6 -0
- package/types/enums/{use-cases.d.ts → site-template-use-case.d.ts} +3 -8
- package/types/enums/status-code.d.ts +4 -4
- package/types/index.d.ts +30 -19
- package/types/models.d.ts +2610 -1109
- package/types/services/account.d.ts +11 -11
- package/types/services/advisor.d.ts +123 -0
- package/types/services/apps.d.ts +266 -0
- package/types/services/avatars.d.ts +5 -5
- package/types/services/compute.d.ts +1171 -0
- package/types/services/console.d.ts +31 -0
- package/types/services/documents-db.d.ts +1 -4
- package/types/services/domains.d.ts +216 -216
- package/types/services/functions.d.ts +29 -18
- package/types/services/health.d.ts +13 -5
- package/types/services/manager.d.ts +49 -9
- package/types/services/messaging.d.ts +92 -0
- package/types/services/organization.d.ts +234 -0
- package/types/services/organizations.d.ts +0 -126
- package/types/services/presences.d.ts +166 -0
- package/types/services/project.d.ts +167 -89
- package/types/services/projects.d.ts +5 -154
- package/types/services/realtime.d.ts +45 -3
- package/types/services/sites.d.ts +22 -11
- package/types/services/usage.d.ts +50 -0
- package/types/services/vectors-db.d.ts +6 -9
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/model.d.ts +0 -3
- package/types/enums/runtimes.d.ts +0 -91
- package/types/enums/secure.d.ts +0 -4
package/types/models.d.ts
CHANGED
|
@@ -7,6 +7,9 @@ import { DetectionRuntimeType } from "./enums/detection-runtime-type";
|
|
|
7
7
|
import { DeploymentStatus } from "./enums/deployment-status";
|
|
8
8
|
import { ExecutionTrigger } from "./enums/execution-trigger";
|
|
9
9
|
import { ExecutionStatus } from "./enums/execution-status";
|
|
10
|
+
import { ProjectAuthMethodId } from "./enums/project-auth-method-id";
|
|
11
|
+
import { ProjectServiceId } from "./enums/project-service-id";
|
|
12
|
+
import { ProjectProtocolId } from "./enums/project-protocol-id";
|
|
10
13
|
import { OAuth2GooglePrompt } from "./enums/o-auth-2-google-prompt";
|
|
11
14
|
import { PlatformType } from "./enums/platform-type";
|
|
12
15
|
import { HealthAntivirusStatus } from "./enums/health-antivirus-status";
|
|
@@ -48,6 +51,19 @@ export declare namespace Models {
|
|
|
48
51
|
*/
|
|
49
52
|
documents: Document[];
|
|
50
53
|
};
|
|
54
|
+
/**
|
|
55
|
+
* Presences List
|
|
56
|
+
*/
|
|
57
|
+
export type PresenceList = {
|
|
58
|
+
/**
|
|
59
|
+
* Total number of presences that matched your query.
|
|
60
|
+
*/
|
|
61
|
+
total: number;
|
|
62
|
+
/**
|
|
63
|
+
* List of presences.
|
|
64
|
+
*/
|
|
65
|
+
presences: Presence[];
|
|
66
|
+
};
|
|
51
67
|
/**
|
|
52
68
|
* Tables List
|
|
53
69
|
*/
|
|
@@ -548,7 +564,7 @@ export declare namespace Models {
|
|
|
548
564
|
/**
|
|
549
565
|
* List of policies.
|
|
550
566
|
*/
|
|
551
|
-
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy)[];
|
|
567
|
+
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail)[];
|
|
552
568
|
};
|
|
553
569
|
/**
|
|
554
570
|
* Email Templates List
|
|
@@ -758,6 +774,32 @@ export declare namespace Models {
|
|
|
758
774
|
*/
|
|
759
775
|
embeddings: Embedding[];
|
|
760
776
|
};
|
|
777
|
+
/**
|
|
778
|
+
* Insights List
|
|
779
|
+
*/
|
|
780
|
+
export type InsightList = {
|
|
781
|
+
/**
|
|
782
|
+
* Total number of insights that matched your query.
|
|
783
|
+
*/
|
|
784
|
+
total: number;
|
|
785
|
+
/**
|
|
786
|
+
* List of insights.
|
|
787
|
+
*/
|
|
788
|
+
insights: Insight[];
|
|
789
|
+
};
|
|
790
|
+
/**
|
|
791
|
+
* Reports List
|
|
792
|
+
*/
|
|
793
|
+
export type ReportList = {
|
|
794
|
+
/**
|
|
795
|
+
* Total number of reports that matched your query.
|
|
796
|
+
*/
|
|
797
|
+
total: number;
|
|
798
|
+
/**
|
|
799
|
+
* List of reports.
|
|
800
|
+
*/
|
|
801
|
+
reports: Report[];
|
|
802
|
+
};
|
|
761
803
|
/**
|
|
762
804
|
* Database
|
|
763
805
|
*/
|
|
@@ -789,11 +831,11 @@ export declare namespace Models {
|
|
|
789
831
|
/**
|
|
790
832
|
* Database backup policies.
|
|
791
833
|
*/
|
|
792
|
-
policies:
|
|
834
|
+
policies: BackupPolicy[];
|
|
793
835
|
/**
|
|
794
836
|
* Database backup archives.
|
|
795
837
|
*/
|
|
796
|
-
archives:
|
|
838
|
+
archives: BackupArchive[];
|
|
797
839
|
};
|
|
798
840
|
/**
|
|
799
841
|
* Embedding
|
|
@@ -3070,6 +3112,47 @@ export declare namespace Models {
|
|
|
3070
3112
|
[key: string]: any;
|
|
3071
3113
|
[__default]: true;
|
|
3072
3114
|
};
|
|
3115
|
+
/**
|
|
3116
|
+
* Presence
|
|
3117
|
+
*/
|
|
3118
|
+
export type Presence = {
|
|
3119
|
+
/**
|
|
3120
|
+
* Presence ID.
|
|
3121
|
+
*/
|
|
3122
|
+
$id: string;
|
|
3123
|
+
/**
|
|
3124
|
+
* Presence creation date in ISO 8601 format.
|
|
3125
|
+
*/
|
|
3126
|
+
$createdAt: string;
|
|
3127
|
+
/**
|
|
3128
|
+
* Presence update date in ISO 8601 format.
|
|
3129
|
+
*/
|
|
3130
|
+
$updatedAt: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* Presence permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
3133
|
+
*/
|
|
3134
|
+
$permissions: string[];
|
|
3135
|
+
/**
|
|
3136
|
+
* User ID.
|
|
3137
|
+
*/
|
|
3138
|
+
userId: string;
|
|
3139
|
+
/**
|
|
3140
|
+
* Presence status.
|
|
3141
|
+
*/
|
|
3142
|
+
status?: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* Presence source.
|
|
3145
|
+
*/
|
|
3146
|
+
source: string;
|
|
3147
|
+
/**
|
|
3148
|
+
* Presence expiry date in ISO 8601 format.
|
|
3149
|
+
*/
|
|
3150
|
+
expiresAt?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* Presence metadata.
|
|
3153
|
+
*/
|
|
3154
|
+
metadata?: object;
|
|
3155
|
+
};
|
|
3073
3156
|
/**
|
|
3074
3157
|
* Log
|
|
3075
3158
|
*/
|
|
@@ -3653,6 +3736,10 @@ export declare namespace Models {
|
|
|
3653
3736
|
* File original size in bytes.
|
|
3654
3737
|
*/
|
|
3655
3738
|
sizeOriginal: number;
|
|
3739
|
+
/**
|
|
3740
|
+
* File actual stored size in bytes after compression and/or encryption.
|
|
3741
|
+
*/
|
|
3742
|
+
sizeActual: number;
|
|
3656
3743
|
/**
|
|
3657
3744
|
* Total number of chunks available
|
|
3658
3745
|
*/
|
|
@@ -3966,6 +4053,14 @@ export declare namespace Models {
|
|
|
3966
4053
|
* Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
|
|
3967
4054
|
*/
|
|
3968
4055
|
providerSilentMode: boolean;
|
|
4056
|
+
/**
|
|
4057
|
+
* List of branch name patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all branches.
|
|
4058
|
+
*/
|
|
4059
|
+
providerBranches: string[];
|
|
4060
|
+
/**
|
|
4061
|
+
* List of file path patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all file changes.
|
|
4062
|
+
*/
|
|
4063
|
+
providerPaths: string[];
|
|
3969
4064
|
/**
|
|
3970
4065
|
* Machine specification for deployment builds.
|
|
3971
4066
|
*/
|
|
@@ -4201,6 +4296,14 @@ export declare namespace Models {
|
|
|
4201
4296
|
* Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
|
|
4202
4297
|
*/
|
|
4203
4298
|
providerSilentMode: boolean;
|
|
4299
|
+
/**
|
|
4300
|
+
* List of branch name patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all branches.
|
|
4301
|
+
*/
|
|
4302
|
+
providerBranches: string[];
|
|
4303
|
+
/**
|
|
4304
|
+
* List of file path patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all file changes.
|
|
4305
|
+
*/
|
|
4306
|
+
providerPaths: string[];
|
|
4204
4307
|
/**
|
|
4205
4308
|
* Machine specification for deployment builds.
|
|
4206
4309
|
*/
|
|
@@ -4899,132 +5002,16 @@ export declare namespace Models {
|
|
|
4899
5002
|
* Project name.
|
|
4900
5003
|
*/
|
|
4901
5004
|
name: string;
|
|
4902
|
-
/**
|
|
4903
|
-
* Project description.
|
|
4904
|
-
*/
|
|
4905
|
-
description: string;
|
|
4906
5005
|
/**
|
|
4907
5006
|
* Project team ID.
|
|
4908
5007
|
*/
|
|
4909
5008
|
teamId: string;
|
|
4910
5009
|
/**
|
|
4911
|
-
* Project
|
|
4912
|
-
*/
|
|
4913
|
-
logo: string;
|
|
4914
|
-
/**
|
|
4915
|
-
* Project website URL.
|
|
4916
|
-
*/
|
|
4917
|
-
url: string;
|
|
4918
|
-
/**
|
|
4919
|
-
* Company legal name.
|
|
4920
|
-
*/
|
|
4921
|
-
legalName: string;
|
|
4922
|
-
/**
|
|
4923
|
-
* Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format.
|
|
4924
|
-
*/
|
|
4925
|
-
legalCountry: string;
|
|
4926
|
-
/**
|
|
4927
|
-
* State name.
|
|
4928
|
-
*/
|
|
4929
|
-
legalState: string;
|
|
4930
|
-
/**
|
|
4931
|
-
* City name.
|
|
4932
|
-
*/
|
|
4933
|
-
legalCity: string;
|
|
4934
|
-
/**
|
|
4935
|
-
* Company Address.
|
|
4936
|
-
*/
|
|
4937
|
-
legalAddress: string;
|
|
4938
|
-
/**
|
|
4939
|
-
* Company Tax ID.
|
|
4940
|
-
*/
|
|
4941
|
-
legalTaxId: string;
|
|
4942
|
-
/**
|
|
4943
|
-
* Session duration in seconds.
|
|
4944
|
-
*/
|
|
4945
|
-
authDuration: number;
|
|
4946
|
-
/**
|
|
4947
|
-
* Max users allowed. 0 is unlimited.
|
|
4948
|
-
*/
|
|
4949
|
-
authLimit: number;
|
|
4950
|
-
/**
|
|
4951
|
-
* Max sessions allowed per user. 100 maximum.
|
|
4952
|
-
*/
|
|
4953
|
-
authSessionsLimit: number;
|
|
4954
|
-
/**
|
|
4955
|
-
* Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.
|
|
4956
|
-
*/
|
|
4957
|
-
authPasswordHistory: number;
|
|
4958
|
-
/**
|
|
4959
|
-
* Whether or not to check user's password against most commonly used passwords.
|
|
4960
|
-
*/
|
|
4961
|
-
authPasswordDictionary: boolean;
|
|
4962
|
-
/**
|
|
4963
|
-
* Whether or not to check the user password for similarity with their personal data.
|
|
4964
|
-
*/
|
|
4965
|
-
authPersonalDataCheck: boolean;
|
|
4966
|
-
/**
|
|
4967
|
-
* Whether or not to disallow disposable email addresses during signup and email updates.
|
|
4968
|
-
*/
|
|
4969
|
-
authDisposableEmails: boolean;
|
|
4970
|
-
/**
|
|
4971
|
-
* Whether or not to require canonical email addresses during signup and email updates.
|
|
4972
|
-
*/
|
|
4973
|
-
authCanonicalEmails: boolean;
|
|
4974
|
-
/**
|
|
4975
|
-
* Whether or not to disallow free email addresses during signup and email updates.
|
|
4976
|
-
*/
|
|
4977
|
-
authFreeEmails: boolean;
|
|
4978
|
-
/**
|
|
4979
|
-
* An array of mock numbers and their corresponding verification codes (OTPs).
|
|
4980
|
-
*/
|
|
4981
|
-
authMockNumbers: MockNumber[];
|
|
4982
|
-
/**
|
|
4983
|
-
* Whether or not to send session alert emails to users.
|
|
4984
|
-
*/
|
|
4985
|
-
authSessionAlerts: boolean;
|
|
4986
|
-
/**
|
|
4987
|
-
* Whether or not to show user names in the teams membership response.
|
|
4988
|
-
*/
|
|
4989
|
-
authMembershipsUserName: boolean;
|
|
4990
|
-
/**
|
|
4991
|
-
* Whether or not to show user emails in the teams membership response.
|
|
4992
|
-
*/
|
|
4993
|
-
authMembershipsUserEmail: boolean;
|
|
4994
|
-
/**
|
|
4995
|
-
* Whether or not to show user MFA status in the teams membership response.
|
|
4996
|
-
*/
|
|
4997
|
-
authMembershipsMfa: boolean;
|
|
4998
|
-
/**
|
|
4999
|
-
* Whether or not to show user IDs in the teams membership response.
|
|
5000
|
-
*/
|
|
5001
|
-
authMembershipsUserId: boolean;
|
|
5002
|
-
/**
|
|
5003
|
-
* Whether or not to show user phone numbers in the teams membership response.
|
|
5004
|
-
*/
|
|
5005
|
-
authMembershipsUserPhone: boolean;
|
|
5006
|
-
/**
|
|
5007
|
-
* Whether or not all existing sessions should be invalidated on password change
|
|
5008
|
-
*/
|
|
5009
|
-
authInvalidateSessions: boolean;
|
|
5010
|
-
/**
|
|
5011
|
-
* List of Auth Providers.
|
|
5012
|
-
*/
|
|
5013
|
-
oAuthProviders: AuthProvider[];
|
|
5014
|
-
/**
|
|
5015
|
-
* List of Platforms.
|
|
5016
|
-
*/
|
|
5017
|
-
platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
|
|
5018
|
-
/**
|
|
5019
|
-
* List of Webhooks.
|
|
5020
|
-
*/
|
|
5021
|
-
webhooks: Webhook[];
|
|
5022
|
-
/**
|
|
5023
|
-
* List of API Keys.
|
|
5010
|
+
* Project region
|
|
5024
5011
|
*/
|
|
5025
|
-
|
|
5012
|
+
region: string;
|
|
5026
5013
|
/**
|
|
5027
|
-
* List of dev keys.
|
|
5014
|
+
* Deprecated since 1.9.5: List of dev keys.
|
|
5028
5015
|
*/
|
|
5029
5016
|
devKeys: DevKey[];
|
|
5030
5017
|
/**
|
|
@@ -5084,129 +5071,104 @@ export declare namespace Models {
|
|
|
5084
5071
|
*/
|
|
5085
5072
|
status: string;
|
|
5086
5073
|
/**
|
|
5087
|
-
*
|
|
5088
|
-
*/
|
|
5089
|
-
authEmailPassword: boolean;
|
|
5090
|
-
/**
|
|
5091
|
-
* Magic URL auth method status
|
|
5092
|
-
*/
|
|
5093
|
-
authUsersAuthMagicURL: boolean;
|
|
5094
|
-
/**
|
|
5095
|
-
* Email (OTP) auth method status
|
|
5096
|
-
*/
|
|
5097
|
-
authEmailOtp: boolean;
|
|
5098
|
-
/**
|
|
5099
|
-
* Anonymous auth method status
|
|
5100
|
-
*/
|
|
5101
|
-
authAnonymous: boolean;
|
|
5102
|
-
/**
|
|
5103
|
-
* Invites auth method status
|
|
5104
|
-
*/
|
|
5105
|
-
authInvites: boolean;
|
|
5106
|
-
/**
|
|
5107
|
-
* JWT auth method status
|
|
5108
|
-
*/
|
|
5109
|
-
authJWT: boolean;
|
|
5110
|
-
/**
|
|
5111
|
-
* Phone auth method status
|
|
5074
|
+
* List of auth methods.
|
|
5112
5075
|
*/
|
|
5113
|
-
|
|
5076
|
+
authMethods: ProjectAuthMethod[];
|
|
5114
5077
|
/**
|
|
5115
|
-
*
|
|
5078
|
+
* List of services.
|
|
5116
5079
|
*/
|
|
5117
|
-
|
|
5080
|
+
services: ProjectService[];
|
|
5118
5081
|
/**
|
|
5119
|
-
*
|
|
5082
|
+
* List of protocols.
|
|
5120
5083
|
*/
|
|
5121
|
-
|
|
5084
|
+
protocols: ProjectProtocol[];
|
|
5122
5085
|
/**
|
|
5123
|
-
*
|
|
5124
|
-
*/
|
|
5125
|
-
serviceStatusForDatabases: boolean;
|
|
5126
|
-
/**
|
|
5127
|
-
* TablesDB service status
|
|
5128
|
-
*/
|
|
5129
|
-
serviceStatusForTablesdb: boolean;
|
|
5130
|
-
/**
|
|
5131
|
-
* Locale service status
|
|
5132
|
-
*/
|
|
5133
|
-
serviceStatusForLocale: boolean;
|
|
5134
|
-
/**
|
|
5135
|
-
* Health service status
|
|
5136
|
-
*/
|
|
5137
|
-
serviceStatusForHealth: boolean;
|
|
5138
|
-
/**
|
|
5139
|
-
* Project service status
|
|
5086
|
+
* Project blocks information
|
|
5140
5087
|
*/
|
|
5141
|
-
|
|
5088
|
+
blocks: Block[];
|
|
5142
5089
|
/**
|
|
5143
|
-
*
|
|
5090
|
+
* Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.
|
|
5144
5091
|
*/
|
|
5145
|
-
|
|
5092
|
+
consoleAccessedAt: string;
|
|
5146
5093
|
/**
|
|
5147
|
-
*
|
|
5094
|
+
* Billing limits reached
|
|
5148
5095
|
*/
|
|
5149
|
-
|
|
5096
|
+
billingLimits?: BillingLimits;
|
|
5150
5097
|
/**
|
|
5151
|
-
*
|
|
5098
|
+
* OAuth2 server status
|
|
5152
5099
|
*/
|
|
5153
|
-
|
|
5100
|
+
oAuth2ServerEnabled: boolean;
|
|
5154
5101
|
/**
|
|
5155
|
-
*
|
|
5102
|
+
* OAuth2 server authorization URL
|
|
5156
5103
|
*/
|
|
5157
|
-
|
|
5104
|
+
oAuth2ServerAuthorizationUrl: string;
|
|
5158
5105
|
/**
|
|
5159
|
-
*
|
|
5106
|
+
* OAuth2 server allowed scopes
|
|
5160
5107
|
*/
|
|
5161
|
-
|
|
5108
|
+
oAuth2ServerScopes: string[];
|
|
5162
5109
|
/**
|
|
5163
|
-
*
|
|
5110
|
+
* OAuth2 server access token duration in seconds for confidential clients
|
|
5164
5111
|
*/
|
|
5165
|
-
|
|
5112
|
+
oAuth2ServerAccessTokenDuration: number;
|
|
5166
5113
|
/**
|
|
5167
|
-
*
|
|
5114
|
+
* OAuth2 server refresh token duration in seconds for confidential clients
|
|
5168
5115
|
*/
|
|
5169
|
-
|
|
5116
|
+
oAuth2ServerRefreshTokenDuration: number;
|
|
5170
5117
|
/**
|
|
5171
|
-
*
|
|
5118
|
+
* OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)
|
|
5172
5119
|
*/
|
|
5173
|
-
|
|
5120
|
+
oAuth2ServerPublicAccessTokenDuration: number;
|
|
5174
5121
|
/**
|
|
5175
|
-
*
|
|
5122
|
+
* OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)
|
|
5176
5123
|
*/
|
|
5177
|
-
|
|
5124
|
+
oAuth2ServerPublicRefreshTokenDuration: number;
|
|
5178
5125
|
/**
|
|
5179
|
-
*
|
|
5126
|
+
* When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
|
|
5180
5127
|
*/
|
|
5181
|
-
|
|
5128
|
+
oAuth2ServerConfidentialPkce: boolean;
|
|
5182
5129
|
/**
|
|
5183
|
-
*
|
|
5130
|
+
* OAuth2 server discovery URL
|
|
5184
5131
|
*/
|
|
5185
|
-
|
|
5132
|
+
oAuth2ServerDiscoveryUrl: string;
|
|
5133
|
+
};
|
|
5134
|
+
/**
|
|
5135
|
+
* ProjectAuthMethod
|
|
5136
|
+
*/
|
|
5137
|
+
export type ProjectAuthMethod = {
|
|
5186
5138
|
/**
|
|
5187
|
-
*
|
|
5139
|
+
* Auth method ID.
|
|
5188
5140
|
*/
|
|
5189
|
-
|
|
5141
|
+
$id: ProjectAuthMethodId;
|
|
5190
5142
|
/**
|
|
5191
|
-
*
|
|
5143
|
+
* Auth method status.
|
|
5192
5144
|
*/
|
|
5193
|
-
|
|
5145
|
+
enabled: boolean;
|
|
5146
|
+
};
|
|
5147
|
+
/**
|
|
5148
|
+
* ProjectService
|
|
5149
|
+
*/
|
|
5150
|
+
export type ProjectService = {
|
|
5194
5151
|
/**
|
|
5195
|
-
*
|
|
5152
|
+
* Service ID.
|
|
5196
5153
|
*/
|
|
5197
|
-
|
|
5154
|
+
$id: ProjectServiceId;
|
|
5198
5155
|
/**
|
|
5199
|
-
*
|
|
5156
|
+
* Service status.
|
|
5200
5157
|
*/
|
|
5201
|
-
|
|
5158
|
+
enabled: boolean;
|
|
5159
|
+
};
|
|
5160
|
+
/**
|
|
5161
|
+
* ProjectProtocol
|
|
5162
|
+
*/
|
|
5163
|
+
export type ProjectProtocol = {
|
|
5202
5164
|
/**
|
|
5203
|
-
*
|
|
5165
|
+
* Protocol ID.
|
|
5204
5166
|
*/
|
|
5205
|
-
|
|
5167
|
+
$id: ProjectProtocolId;
|
|
5206
5168
|
/**
|
|
5207
|
-
*
|
|
5169
|
+
* Protocol status.
|
|
5208
5170
|
*/
|
|
5209
|
-
|
|
5171
|
+
enabled: boolean;
|
|
5210
5172
|
};
|
|
5211
5173
|
/**
|
|
5212
5174
|
* Webhook
|
|
@@ -6348,6 +6310,35 @@ export declare namespace Models {
|
|
|
6348
6310
|
*/
|
|
6349
6311
|
total: number;
|
|
6350
6312
|
};
|
|
6313
|
+
/**
|
|
6314
|
+
* Policy Password Strength
|
|
6315
|
+
*/
|
|
6316
|
+
export type PolicyPasswordStrength = {
|
|
6317
|
+
/**
|
|
6318
|
+
* Policy ID.
|
|
6319
|
+
*/
|
|
6320
|
+
$id: string;
|
|
6321
|
+
/**
|
|
6322
|
+
* Minimum password length required for user passwords.
|
|
6323
|
+
*/
|
|
6324
|
+
min: number;
|
|
6325
|
+
/**
|
|
6326
|
+
* Whether passwords must include at least one uppercase letter.
|
|
6327
|
+
*/
|
|
6328
|
+
uppercase: boolean;
|
|
6329
|
+
/**
|
|
6330
|
+
* Whether passwords must include at least one lowercase letter.
|
|
6331
|
+
*/
|
|
6332
|
+
lowercase: boolean;
|
|
6333
|
+
/**
|
|
6334
|
+
* Whether passwords must include at least one number.
|
|
6335
|
+
*/
|
|
6336
|
+
number: boolean;
|
|
6337
|
+
/**
|
|
6338
|
+
* Whether passwords must include at least one symbol.
|
|
6339
|
+
*/
|
|
6340
|
+
symbols: boolean;
|
|
6341
|
+
};
|
|
6351
6342
|
/**
|
|
6352
6343
|
* Policy Password Personal Data
|
|
6353
6344
|
*/
|
|
@@ -6455,31 +6446,6 @@ export declare namespace Models {
|
|
|
6455
6446
|
*/
|
|
6456
6447
|
userMFA: boolean;
|
|
6457
6448
|
};
|
|
6458
|
-
/**
|
|
6459
|
-
* AuthProvider
|
|
6460
|
-
*/
|
|
6461
|
-
export type AuthProvider = {
|
|
6462
|
-
/**
|
|
6463
|
-
* Auth Provider.
|
|
6464
|
-
*/
|
|
6465
|
-
key: string;
|
|
6466
|
-
/**
|
|
6467
|
-
* Auth Provider name.
|
|
6468
|
-
*/
|
|
6469
|
-
name: string;
|
|
6470
|
-
/**
|
|
6471
|
-
* OAuth 2.0 application ID.
|
|
6472
|
-
*/
|
|
6473
|
-
appId: string;
|
|
6474
|
-
/**
|
|
6475
|
-
* OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.
|
|
6476
|
-
*/
|
|
6477
|
-
secret: string;
|
|
6478
|
-
/**
|
|
6479
|
-
* Auth Provider is active and can be used to create session.
|
|
6480
|
-
*/
|
|
6481
|
-
enabled: boolean;
|
|
6482
|
-
};
|
|
6483
6449
|
/**
|
|
6484
6450
|
* Platform Web
|
|
6485
6451
|
*/
|
|
@@ -7084,6 +7050,23 @@ export declare namespace Models {
|
|
|
7084
7050
|
*/
|
|
7085
7051
|
sessions: Metric[];
|
|
7086
7052
|
};
|
|
7053
|
+
/**
|
|
7054
|
+
* UsagePresence
|
|
7055
|
+
*/
|
|
7056
|
+
export type UsagePresence = {
|
|
7057
|
+
/**
|
|
7058
|
+
* Time range of the usage stats.
|
|
7059
|
+
*/
|
|
7060
|
+
range: string;
|
|
7061
|
+
/**
|
|
7062
|
+
* Current total number of online users.
|
|
7063
|
+
*/
|
|
7064
|
+
usersOnlineTotal: number;
|
|
7065
|
+
/**
|
|
7066
|
+
* Aggregated number of online users per period.
|
|
7067
|
+
*/
|
|
7068
|
+
presences: Metric[];
|
|
7069
|
+
};
|
|
7087
7070
|
/**
|
|
7088
7071
|
* StorageUsage
|
|
7089
7072
|
*/
|
|
@@ -7611,7 +7594,7 @@ export declare namespace Models {
|
|
|
7611
7594
|
outbound: Metric[];
|
|
7612
7595
|
};
|
|
7613
7596
|
/**
|
|
7614
|
-
*
|
|
7597
|
+
* Project
|
|
7615
7598
|
*/
|
|
7616
7599
|
export type UsageProject = {
|
|
7617
7600
|
/**
|
|
@@ -8697,6 +8680,54 @@ export declare namespace Models {
|
|
|
8697
8680
|
* Number of functions to be migrated.
|
|
8698
8681
|
*/
|
|
8699
8682
|
function: number;
|
|
8683
|
+
/**
|
|
8684
|
+
* Number of platforms to be migrated.
|
|
8685
|
+
*/
|
|
8686
|
+
platform: number;
|
|
8687
|
+
/**
|
|
8688
|
+
* Number of API keys to be migrated.
|
|
8689
|
+
*/
|
|
8690
|
+
apikey: number;
|
|
8691
|
+
/**
|
|
8692
|
+
* Number of project variables to be migrated.
|
|
8693
|
+
*/
|
|
8694
|
+
projectvariable: number;
|
|
8695
|
+
/**
|
|
8696
|
+
* Number of webhooks to be migrated.
|
|
8697
|
+
*/
|
|
8698
|
+
webhook: number;
|
|
8699
|
+
/**
|
|
8700
|
+
* Number of auth-method configs to be migrated (always 0 or 1 — the project-level flag bundle).
|
|
8701
|
+
*/
|
|
8702
|
+
authmethods: number;
|
|
8703
|
+
/**
|
|
8704
|
+
* Number of protocol configs to be migrated (always 0 or 1 — the project-level REST/GraphQL/WebSocket flags).
|
|
8705
|
+
*/
|
|
8706
|
+
projectprotocols: number;
|
|
8707
|
+
/**
|
|
8708
|
+
* Number of label sets to be migrated (always 0 or 1 — the project-level RBAC label array).
|
|
8709
|
+
*/
|
|
8710
|
+
projectlabels: number;
|
|
8711
|
+
/**
|
|
8712
|
+
* Number of service configs to be migrated (always 0 or 1 — the project-level enable/disable flags for all 17 services).
|
|
8713
|
+
*/
|
|
8714
|
+
projectservices: number;
|
|
8715
|
+
/**
|
|
8716
|
+
* Number of policy bundles to be migrated (always 0 or 1 — the project-level security policies covering password rules, session behavior, user limits, and membership privacy).
|
|
8717
|
+
*/
|
|
8718
|
+
policies: number;
|
|
8719
|
+
/**
|
|
8720
|
+
* Number of SMTP configurations to be migrated (always 0 or 1 — the project-level custom SMTP settings; password is not exposed by the source API).
|
|
8721
|
+
*/
|
|
8722
|
+
smtp: number;
|
|
8723
|
+
/**
|
|
8724
|
+
* Number of custom-domain proxy rules to be migrated. Auto-generated `.appwrite.network` rules are skipped — they are recreated by parent Function/Site migration.
|
|
8725
|
+
*/
|
|
8726
|
+
rule: number;
|
|
8727
|
+
/**
|
|
8728
|
+
* Number of custom email templates to be migrated (one per templateId × locale pair).
|
|
8729
|
+
*/
|
|
8730
|
+
projectemailtemplate: number;
|
|
8700
8731
|
/**
|
|
8701
8732
|
* Number of sites to be migrated.
|
|
8702
8733
|
*/
|
|
@@ -8725,31 +8756,186 @@ export declare namespace Models {
|
|
|
8725
8756
|
* Version of the Appwrite instance to be migrated.
|
|
8726
8757
|
*/
|
|
8727
8758
|
version: string;
|
|
8759
|
+
/**
|
|
8760
|
+
* Number of OAuth2 provider configurations to be migrated. Secrets (clientSecret, p8File) are never migrated — destination admin must re-enter them per provider.
|
|
8761
|
+
*/
|
|
8762
|
+
oauth2provider: number;
|
|
8763
|
+
/**
|
|
8764
|
+
* Number of backup policies to be migrated.
|
|
8765
|
+
*/
|
|
8766
|
+
backuppolicy: number;
|
|
8728
8767
|
};
|
|
8729
8768
|
/**
|
|
8730
|
-
*
|
|
8769
|
+
* Insight
|
|
8731
8770
|
*/
|
|
8732
|
-
export type
|
|
8771
|
+
export type Insight = {
|
|
8733
8772
|
/**
|
|
8734
|
-
*
|
|
8773
|
+
* Insight ID.
|
|
8735
8774
|
*/
|
|
8736
8775
|
$id: string;
|
|
8737
8776
|
/**
|
|
8738
|
-
*
|
|
8777
|
+
* Insight creation date in ISO 8601 format.
|
|
8739
8778
|
*/
|
|
8740
|
-
|
|
8779
|
+
$createdAt: string;
|
|
8741
8780
|
/**
|
|
8742
|
-
*
|
|
8781
|
+
* Insight update date in ISO 8601 format.
|
|
8743
8782
|
*/
|
|
8744
|
-
|
|
8783
|
+
$updatedAt: string;
|
|
8745
8784
|
/**
|
|
8746
|
-
*
|
|
8785
|
+
* Parent report ID. Insights always belong to a report.
|
|
8747
8786
|
*/
|
|
8748
|
-
|
|
8787
|
+
reportId: string;
|
|
8749
8788
|
/**
|
|
8750
|
-
*
|
|
8789
|
+
* Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).
|
|
8751
8790
|
*/
|
|
8752
|
-
|
|
8791
|
+
type: string;
|
|
8792
|
+
/**
|
|
8793
|
+
* Insight severity. One of info, warning, critical.
|
|
8794
|
+
*/
|
|
8795
|
+
severity: string;
|
|
8796
|
+
/**
|
|
8797
|
+
* Insight status. One of active, dismissed.
|
|
8798
|
+
*/
|
|
8799
|
+
status: string;
|
|
8800
|
+
/**
|
|
8801
|
+
* Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.
|
|
8802
|
+
*/
|
|
8803
|
+
resourceType: string;
|
|
8804
|
+
/**
|
|
8805
|
+
* ID of the resource the insight is about.
|
|
8806
|
+
*/
|
|
8807
|
+
resourceId: string;
|
|
8808
|
+
/**
|
|
8809
|
+
* Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table → resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.
|
|
8810
|
+
*/
|
|
8811
|
+
parentResourceType: string;
|
|
8812
|
+
/**
|
|
8813
|
+
* ID of the parent resource. Empty when the resource has no parent.
|
|
8814
|
+
*/
|
|
8815
|
+
parentResourceId: string;
|
|
8816
|
+
/**
|
|
8817
|
+
* Insight title.
|
|
8818
|
+
*/
|
|
8819
|
+
title: string;
|
|
8820
|
+
/**
|
|
8821
|
+
* Short markdown summary describing the insight.
|
|
8822
|
+
*/
|
|
8823
|
+
summary: string;
|
|
8824
|
+
/**
|
|
8825
|
+
* List of call-to-action buttons attached to this insight.
|
|
8826
|
+
*/
|
|
8827
|
+
ctas: InsightCTA[];
|
|
8828
|
+
/**
|
|
8829
|
+
* Time the insight was analyzed in ISO 8601 format.
|
|
8830
|
+
*/
|
|
8831
|
+
analyzedAt?: string;
|
|
8832
|
+
/**
|
|
8833
|
+
* Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.
|
|
8834
|
+
*/
|
|
8835
|
+
dismissedAt?: string;
|
|
8836
|
+
/**
|
|
8837
|
+
* User ID that dismissed the insight. Empty when not dismissed.
|
|
8838
|
+
*/
|
|
8839
|
+
dismissedBy?: string;
|
|
8840
|
+
};
|
|
8841
|
+
/**
|
|
8842
|
+
* InsightCTA
|
|
8843
|
+
*/
|
|
8844
|
+
export type InsightCTA = {
|
|
8845
|
+
/**
|
|
8846
|
+
* Human-readable label for the CTA, used in UI.
|
|
8847
|
+
*/
|
|
8848
|
+
label: string;
|
|
8849
|
+
/**
|
|
8850
|
+
* Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource — for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.
|
|
8851
|
+
*/
|
|
8852
|
+
service: string;
|
|
8853
|
+
/**
|
|
8854
|
+
* Public API method on the chosen service the client should invoke when this CTA is triggered.
|
|
8855
|
+
*/
|
|
8856
|
+
method: string;
|
|
8857
|
+
/**
|
|
8858
|
+
* Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId/tableId/columns for tablesDB, databaseId/collectionId/attributes for the legacy Databases API).
|
|
8859
|
+
*/
|
|
8860
|
+
params: object;
|
|
8861
|
+
};
|
|
8862
|
+
/**
|
|
8863
|
+
* Report
|
|
8864
|
+
*/
|
|
8865
|
+
export type Report = {
|
|
8866
|
+
/**
|
|
8867
|
+
* Report ID.
|
|
8868
|
+
*/
|
|
8869
|
+
$id: string;
|
|
8870
|
+
/**
|
|
8871
|
+
* Report creation date in ISO 8601 format.
|
|
8872
|
+
*/
|
|
8873
|
+
$createdAt: string;
|
|
8874
|
+
/**
|
|
8875
|
+
* Report update date in ISO 8601 format.
|
|
8876
|
+
*/
|
|
8877
|
+
$updatedAt: string;
|
|
8878
|
+
/**
|
|
8879
|
+
* ID of the third-party app that submitted the report.
|
|
8880
|
+
*/
|
|
8881
|
+
appId: string;
|
|
8882
|
+
/**
|
|
8883
|
+
* Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.
|
|
8884
|
+
*/
|
|
8885
|
+
type: string;
|
|
8886
|
+
/**
|
|
8887
|
+
* Short, human-readable title for the report.
|
|
8888
|
+
*/
|
|
8889
|
+
title: string;
|
|
8890
|
+
/**
|
|
8891
|
+
* Markdown summary describing the report.
|
|
8892
|
+
*/
|
|
8893
|
+
summary: string;
|
|
8894
|
+
/**
|
|
8895
|
+
* Plural noun describing what the report analyzes, e.g. databases, sites, urls.
|
|
8896
|
+
*/
|
|
8897
|
+
targetType: string;
|
|
8898
|
+
/**
|
|
8899
|
+
* Free-form target identifier (URL for lighthouse, resource ID for db).
|
|
8900
|
+
*/
|
|
8901
|
+
target: string;
|
|
8902
|
+
/**
|
|
8903
|
+
* Categories covered by the report, e.g. performance, accessibility.
|
|
8904
|
+
*/
|
|
8905
|
+
categories: string[];
|
|
8906
|
+
/**
|
|
8907
|
+
* Insights nested under this report.
|
|
8908
|
+
*/
|
|
8909
|
+
insights: Insight[];
|
|
8910
|
+
/**
|
|
8911
|
+
* Time the report was analyzed in ISO 8601 format.
|
|
8912
|
+
*/
|
|
8913
|
+
analyzedAt?: string;
|
|
8914
|
+
};
|
|
8915
|
+
/**
|
|
8916
|
+
* ActivityEvent
|
|
8917
|
+
*/
|
|
8918
|
+
export type ActivityEvent = {
|
|
8919
|
+
/**
|
|
8920
|
+
* Event ID.
|
|
8921
|
+
*/
|
|
8922
|
+
$id: string;
|
|
8923
|
+
/**
|
|
8924
|
+
* Actor type.
|
|
8925
|
+
*/
|
|
8926
|
+
actorType: string;
|
|
8927
|
+
/**
|
|
8928
|
+
* Actor ID.
|
|
8929
|
+
*/
|
|
8930
|
+
actorId: string;
|
|
8931
|
+
/**
|
|
8932
|
+
* Actor Email.
|
|
8933
|
+
*/
|
|
8934
|
+
actorEmail: string;
|
|
8935
|
+
/**
|
|
8936
|
+
* Actor Name.
|
|
8937
|
+
*/
|
|
8938
|
+
actorName: string;
|
|
8753
8939
|
/**
|
|
8754
8940
|
* Resource parent.
|
|
8755
8941
|
*/
|
|
@@ -8889,7 +9075,114 @@ export declare namespace Models {
|
|
|
8889
9075
|
invoiceDesc: string;
|
|
8890
9076
|
};
|
|
8891
9077
|
/**
|
|
8892
|
-
*
|
|
9078
|
+
* Addon
|
|
9079
|
+
*/
|
|
9080
|
+
export type Addon = {
|
|
9081
|
+
/**
|
|
9082
|
+
* Addon ID.
|
|
9083
|
+
*/
|
|
9084
|
+
$id: string;
|
|
9085
|
+
/**
|
|
9086
|
+
* Addon creation time in ISO 8601 format.
|
|
9087
|
+
*/
|
|
9088
|
+
$createdAt: string;
|
|
9089
|
+
/**
|
|
9090
|
+
* Addon update date in ISO 8601 format.
|
|
9091
|
+
*/
|
|
9092
|
+
$updatedAt: string;
|
|
9093
|
+
/**
|
|
9094
|
+
* Addon permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
9095
|
+
*/
|
|
9096
|
+
$permissions: string[];
|
|
9097
|
+
/**
|
|
9098
|
+
* Addon key
|
|
9099
|
+
*/
|
|
9100
|
+
key: string;
|
|
9101
|
+
/**
|
|
9102
|
+
* Resource type (organization or project)
|
|
9103
|
+
*/
|
|
9104
|
+
resourceType: string;
|
|
9105
|
+
/**
|
|
9106
|
+
* Resource ID
|
|
9107
|
+
*/
|
|
9108
|
+
resourceId: string;
|
|
9109
|
+
/**
|
|
9110
|
+
* Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).
|
|
9111
|
+
*/
|
|
9112
|
+
status: string;
|
|
9113
|
+
/**
|
|
9114
|
+
* Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.
|
|
9115
|
+
*/
|
|
9116
|
+
currentValue: number;
|
|
9117
|
+
/**
|
|
9118
|
+
* Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.
|
|
9119
|
+
*/
|
|
9120
|
+
nextValue?: number;
|
|
9121
|
+
};
|
|
9122
|
+
/**
|
|
9123
|
+
* AddonPrice
|
|
9124
|
+
*/
|
|
9125
|
+
export type AddonPrice = {
|
|
9126
|
+
/**
|
|
9127
|
+
* Addon key.
|
|
9128
|
+
*/
|
|
9129
|
+
addonKey: string;
|
|
9130
|
+
/**
|
|
9131
|
+
* Addon display name.
|
|
9132
|
+
*/
|
|
9133
|
+
name: string;
|
|
9134
|
+
/**
|
|
9135
|
+
* Full monthly price of the addon.
|
|
9136
|
+
*/
|
|
9137
|
+
monthlyPrice: number;
|
|
9138
|
+
/**
|
|
9139
|
+
* Calculated prorated amount for the current billing cycle.
|
|
9140
|
+
*/
|
|
9141
|
+
proratedAmount: number;
|
|
9142
|
+
/**
|
|
9143
|
+
* Days remaining in the current billing cycle.
|
|
9144
|
+
*/
|
|
9145
|
+
remainingDays: number;
|
|
9146
|
+
/**
|
|
9147
|
+
* Total days in the billing cycle.
|
|
9148
|
+
*/
|
|
9149
|
+
totalCycleDays: number;
|
|
9150
|
+
/**
|
|
9151
|
+
* Currency code.
|
|
9152
|
+
*/
|
|
9153
|
+
currency: string;
|
|
9154
|
+
/**
|
|
9155
|
+
* When the current billing cycle ends.
|
|
9156
|
+
*/
|
|
9157
|
+
billingCycleEnd: string;
|
|
9158
|
+
};
|
|
9159
|
+
/**
|
|
9160
|
+
* Breakdown
|
|
9161
|
+
*/
|
|
9162
|
+
export type AggregationBreakdown = {
|
|
9163
|
+
/**
|
|
9164
|
+
* Aggregation ID.
|
|
9165
|
+
*/
|
|
9166
|
+
$id: string;
|
|
9167
|
+
/**
|
|
9168
|
+
* Project name
|
|
9169
|
+
*/
|
|
9170
|
+
name: string;
|
|
9171
|
+
/**
|
|
9172
|
+
* Project region
|
|
9173
|
+
*/
|
|
9174
|
+
region: string;
|
|
9175
|
+
/**
|
|
9176
|
+
* Aggregated amount
|
|
9177
|
+
*/
|
|
9178
|
+
amount: number;
|
|
9179
|
+
/**
|
|
9180
|
+
*
|
|
9181
|
+
*/
|
|
9182
|
+
resources: UsageResources[];
|
|
9183
|
+
};
|
|
9184
|
+
/**
|
|
9185
|
+
* Team
|
|
8893
9186
|
*/
|
|
8894
9187
|
export type AggregationTeam = {
|
|
8895
9188
|
/**
|
|
@@ -9009,31 +9302,6 @@ export declare namespace Models {
|
|
|
9009
9302
|
*/
|
|
9010
9303
|
resources: UsageResources[];
|
|
9011
9304
|
};
|
|
9012
|
-
/**
|
|
9013
|
-
* AggregationBreakdown
|
|
9014
|
-
*/
|
|
9015
|
-
export type AggregationBreakdown = {
|
|
9016
|
-
/**
|
|
9017
|
-
* Aggregation ID.
|
|
9018
|
-
*/
|
|
9019
|
-
$id: string;
|
|
9020
|
-
/**
|
|
9021
|
-
* Project name
|
|
9022
|
-
*/
|
|
9023
|
-
name: string;
|
|
9024
|
-
/**
|
|
9025
|
-
* Project region
|
|
9026
|
-
*/
|
|
9027
|
-
region: string;
|
|
9028
|
-
/**
|
|
9029
|
-
* Aggregated amount
|
|
9030
|
-
*/
|
|
9031
|
-
amount: number;
|
|
9032
|
-
/**
|
|
9033
|
-
*
|
|
9034
|
-
*/
|
|
9035
|
-
resources: UsageResources[];
|
|
9036
|
-
};
|
|
9037
9305
|
/**
|
|
9038
9306
|
* Archive
|
|
9039
9307
|
*/
|
|
@@ -9088,46 +9356,182 @@ export declare namespace Models {
|
|
|
9088
9356
|
resourceType?: string;
|
|
9089
9357
|
};
|
|
9090
9358
|
/**
|
|
9091
|
-
*
|
|
9359
|
+
* Backup
|
|
9092
9360
|
*/
|
|
9093
|
-
export type
|
|
9361
|
+
export type DedicatedDatabaseBackup = {
|
|
9094
9362
|
/**
|
|
9095
|
-
*
|
|
9363
|
+
* Backup ID.
|
|
9096
9364
|
*/
|
|
9097
9365
|
$id: string;
|
|
9098
9366
|
/**
|
|
9099
|
-
*
|
|
9367
|
+
* Backup creation time in ISO 8601 format.
|
|
9100
9368
|
*/
|
|
9101
|
-
|
|
9369
|
+
$createdAt: string;
|
|
9102
9370
|
/**
|
|
9103
|
-
*
|
|
9371
|
+
* Database ID this backup belongs to.
|
|
9104
9372
|
*/
|
|
9105
|
-
|
|
9373
|
+
databaseId: string;
|
|
9106
9374
|
/**
|
|
9107
|
-
*
|
|
9375
|
+
* Project ID.
|
|
9108
9376
|
*/
|
|
9109
|
-
|
|
9377
|
+
projectId: string;
|
|
9110
9378
|
/**
|
|
9111
|
-
*
|
|
9379
|
+
* Backup policy ID when the backup was created by a schedule.
|
|
9112
9380
|
*/
|
|
9113
|
-
|
|
9381
|
+
policyId: string;
|
|
9114
9382
|
/**
|
|
9115
|
-
*
|
|
9383
|
+
* Backup trigger. Possible values: manual, schedule.
|
|
9116
9384
|
*/
|
|
9117
|
-
|
|
9385
|
+
trigger: string;
|
|
9118
9386
|
/**
|
|
9119
|
-
*
|
|
9387
|
+
* Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).
|
|
9120
9388
|
*/
|
|
9121
|
-
|
|
9389
|
+
type: string;
|
|
9122
9390
|
/**
|
|
9123
|
-
*
|
|
9391
|
+
* Backup status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error), verified (integrity check passed).
|
|
9124
9392
|
*/
|
|
9125
|
-
|
|
9126
|
-
|
|
9127
|
-
|
|
9128
|
-
|
|
9129
|
-
|
|
9130
|
-
|
|
9393
|
+
status: string;
|
|
9394
|
+
/**
|
|
9395
|
+
* Backup size in bytes.
|
|
9396
|
+
*/
|
|
9397
|
+
sizeBytes: number;
|
|
9398
|
+
/**
|
|
9399
|
+
* Backup start time in ISO 8601 format.
|
|
9400
|
+
*/
|
|
9401
|
+
startedAt: string;
|
|
9402
|
+
/**
|
|
9403
|
+
* Backup completion time in ISO 8601 format.
|
|
9404
|
+
*/
|
|
9405
|
+
completedAt: string;
|
|
9406
|
+
/**
|
|
9407
|
+
* Backup verification time in ISO 8601 format.
|
|
9408
|
+
*/
|
|
9409
|
+
verifiedAt: string;
|
|
9410
|
+
/**
|
|
9411
|
+
* Backup expiration time in ISO 8601 format.
|
|
9412
|
+
*/
|
|
9413
|
+
expiresAt: string;
|
|
9414
|
+
/**
|
|
9415
|
+
* Error message if backup failed.
|
|
9416
|
+
*/
|
|
9417
|
+
error: string;
|
|
9418
|
+
};
|
|
9419
|
+
/**
|
|
9420
|
+
* BackupList
|
|
9421
|
+
*/
|
|
9422
|
+
export type DedicatedDatabaseBackupList = {
|
|
9423
|
+
/**
|
|
9424
|
+
* Total number of backups.
|
|
9425
|
+
*/
|
|
9426
|
+
total: number;
|
|
9427
|
+
/**
|
|
9428
|
+
* List of backups.
|
|
9429
|
+
*/
|
|
9430
|
+
backups: DedicatedDatabaseBackup[];
|
|
9431
|
+
};
|
|
9432
|
+
/**
|
|
9433
|
+
* BackupStorageConfig
|
|
9434
|
+
*/
|
|
9435
|
+
export type DedicatedDatabaseBackupStorage = {
|
|
9436
|
+
/**
|
|
9437
|
+
* Storage provider. Possible values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).
|
|
9438
|
+
*/
|
|
9439
|
+
provider: string;
|
|
9440
|
+
/**
|
|
9441
|
+
* Storage bucket or container name.
|
|
9442
|
+
*/
|
|
9443
|
+
bucket: string;
|
|
9444
|
+
/**
|
|
9445
|
+
* Storage region.
|
|
9446
|
+
*/
|
|
9447
|
+
region: string;
|
|
9448
|
+
/**
|
|
9449
|
+
* Object key prefix for backups.
|
|
9450
|
+
*/
|
|
9451
|
+
prefix: string;
|
|
9452
|
+
/**
|
|
9453
|
+
* Custom endpoint for S3-compatible storage.
|
|
9454
|
+
*/
|
|
9455
|
+
endpoint: string;
|
|
9456
|
+
};
|
|
9457
|
+
/**
|
|
9458
|
+
* Address
|
|
9459
|
+
*/
|
|
9460
|
+
export type BillingAddress = {
|
|
9461
|
+
/**
|
|
9462
|
+
* Region ID
|
|
9463
|
+
*/
|
|
9464
|
+
$id: string;
|
|
9465
|
+
/**
|
|
9466
|
+
* User ID
|
|
9467
|
+
*/
|
|
9468
|
+
userId: string;
|
|
9469
|
+
/**
|
|
9470
|
+
* Street address
|
|
9471
|
+
*/
|
|
9472
|
+
streetAddress: string;
|
|
9473
|
+
/**
|
|
9474
|
+
* Address line 2
|
|
9475
|
+
*/
|
|
9476
|
+
addressLine2: string;
|
|
9477
|
+
/**
|
|
9478
|
+
* Address country
|
|
9479
|
+
*/
|
|
9480
|
+
country: string;
|
|
9481
|
+
/**
|
|
9482
|
+
* city
|
|
9483
|
+
*/
|
|
9484
|
+
city: string;
|
|
9485
|
+
/**
|
|
9486
|
+
* state
|
|
9487
|
+
*/
|
|
9488
|
+
state: string;
|
|
9489
|
+
/**
|
|
9490
|
+
* postal code
|
|
9491
|
+
*/
|
|
9492
|
+
postalCode: string;
|
|
9493
|
+
};
|
|
9494
|
+
/**
|
|
9495
|
+
* Limits
|
|
9496
|
+
*/
|
|
9497
|
+
export type BillingLimits = {
|
|
9498
|
+
/**
|
|
9499
|
+
* Bandwidth limit
|
|
9500
|
+
*/
|
|
9501
|
+
bandwidth?: number;
|
|
9502
|
+
/**
|
|
9503
|
+
* Storage limit
|
|
9504
|
+
*/
|
|
9505
|
+
storage?: number;
|
|
9506
|
+
/**
|
|
9507
|
+
* Users limit
|
|
9508
|
+
*/
|
|
9509
|
+
users?: number;
|
|
9510
|
+
/**
|
|
9511
|
+
* Executions limit
|
|
9512
|
+
*/
|
|
9513
|
+
executions?: number;
|
|
9514
|
+
/**
|
|
9515
|
+
* GBHours limit
|
|
9516
|
+
*/
|
|
9517
|
+
GBHours?: number;
|
|
9518
|
+
/**
|
|
9519
|
+
* Image transformations limit
|
|
9520
|
+
*/
|
|
9521
|
+
imageTransformations?: number;
|
|
9522
|
+
/**
|
|
9523
|
+
* Auth phone limit
|
|
9524
|
+
*/
|
|
9525
|
+
authPhone?: number;
|
|
9526
|
+
/**
|
|
9527
|
+
* Budget limit percentage
|
|
9528
|
+
*/
|
|
9529
|
+
budgetLimit?: number;
|
|
9530
|
+
};
|
|
9531
|
+
/**
|
|
9532
|
+
* billingPlan
|
|
9533
|
+
*/
|
|
9534
|
+
export type BillingPlan = {
|
|
9131
9535
|
/**
|
|
9132
9536
|
* Plan ID.
|
|
9133
9537
|
*/
|
|
@@ -9340,6 +9744,10 @@ export declare namespace Models {
|
|
|
9340
9744
|
* Does plan support blocking free email addresses.
|
|
9341
9745
|
*/
|
|
9342
9746
|
supportsFreeEmailValidation: boolean;
|
|
9747
|
+
/**
|
|
9748
|
+
* Does plan support project-specific member roles.
|
|
9749
|
+
*/
|
|
9750
|
+
supportsProjectSpecificRoles: boolean;
|
|
9343
9751
|
/**
|
|
9344
9752
|
* Does plan support backup policies.
|
|
9345
9753
|
*/
|
|
@@ -9382,7 +9790,7 @@ export declare namespace Models {
|
|
|
9382
9790
|
program?: Program;
|
|
9383
9791
|
};
|
|
9384
9792
|
/**
|
|
9385
|
-
*
|
|
9793
|
+
* Addon
|
|
9386
9794
|
*/
|
|
9387
9795
|
export type BillingPlanAddon = {
|
|
9388
9796
|
/**
|
|
@@ -9395,7 +9803,7 @@ export declare namespace Models {
|
|
|
9395
9803
|
projects: BillingPlanAddonDetails;
|
|
9396
9804
|
};
|
|
9397
9805
|
/**
|
|
9398
|
-
*
|
|
9806
|
+
* Details
|
|
9399
9807
|
*/
|
|
9400
9808
|
export type BillingPlanAddonDetails = {
|
|
9401
9809
|
/**
|
|
@@ -9432,7 +9840,7 @@ export declare namespace Models {
|
|
|
9432
9840
|
invoiceDesc: string;
|
|
9433
9841
|
};
|
|
9434
9842
|
/**
|
|
9435
|
-
*
|
|
9843
|
+
* PlanLimits
|
|
9436
9844
|
*/
|
|
9437
9845
|
export type BillingPlanLimits = {
|
|
9438
9846
|
/**
|
|
@@ -9453,43 +9861,6 @@ export declare namespace Models {
|
|
|
9453
9861
|
*/
|
|
9454
9862
|
baa: boolean;
|
|
9455
9863
|
};
|
|
9456
|
-
/**
|
|
9457
|
-
* BillingLimits
|
|
9458
|
-
*/
|
|
9459
|
-
export type BillingLimits = {
|
|
9460
|
-
/**
|
|
9461
|
-
* Bandwidth limit
|
|
9462
|
-
*/
|
|
9463
|
-
bandwidth: number;
|
|
9464
|
-
/**
|
|
9465
|
-
* Storage limit
|
|
9466
|
-
*/
|
|
9467
|
-
storage: number;
|
|
9468
|
-
/**
|
|
9469
|
-
* Users limit
|
|
9470
|
-
*/
|
|
9471
|
-
users: number;
|
|
9472
|
-
/**
|
|
9473
|
-
* Executions limit
|
|
9474
|
-
*/
|
|
9475
|
-
executions: number;
|
|
9476
|
-
/**
|
|
9477
|
-
* GBHours limit
|
|
9478
|
-
*/
|
|
9479
|
-
GBHours: number;
|
|
9480
|
-
/**
|
|
9481
|
-
* Image transformations limit
|
|
9482
|
-
*/
|
|
9483
|
-
imageTransformations: number;
|
|
9484
|
-
/**
|
|
9485
|
-
* Auth phone limit
|
|
9486
|
-
*/
|
|
9487
|
-
authPhone: number;
|
|
9488
|
-
/**
|
|
9489
|
-
* Budget limit percentage
|
|
9490
|
-
*/
|
|
9491
|
-
budgetLimit: number;
|
|
9492
|
-
};
|
|
9493
9864
|
/**
|
|
9494
9865
|
* Block
|
|
9495
9866
|
*/
|
|
@@ -9548,6 +9919,36 @@ export declare namespace Models {
|
|
|
9548
9919
|
*/
|
|
9549
9920
|
blocks: Block[];
|
|
9550
9921
|
};
|
|
9922
|
+
/**
|
|
9923
|
+
* Branch
|
|
9924
|
+
*/
|
|
9925
|
+
export type DedicatedDatabaseBranch = {
|
|
9926
|
+
/**
|
|
9927
|
+
* Branch identifier.
|
|
9928
|
+
*/
|
|
9929
|
+
branchId: string;
|
|
9930
|
+
/**
|
|
9931
|
+
* Branch name.
|
|
9932
|
+
*/
|
|
9933
|
+
branchName: string;
|
|
9934
|
+
/**
|
|
9935
|
+
* Kubernetes namespace where the branch is deployed.
|
|
9936
|
+
*/
|
|
9937
|
+
namespace: string;
|
|
9938
|
+
/**
|
|
9939
|
+
* Unix timestamp when the branch expires.
|
|
9940
|
+
*/
|
|
9941
|
+
expiresAt: number;
|
|
9942
|
+
};
|
|
9943
|
+
/**
|
|
9944
|
+
* BranchList
|
|
9945
|
+
*/
|
|
9946
|
+
export type DedicatedDatabaseBranchList = {
|
|
9947
|
+
/**
|
|
9948
|
+
* List of branches.
|
|
9949
|
+
*/
|
|
9950
|
+
branches: DedicatedDatabaseBranch[];
|
|
9951
|
+
};
|
|
9551
9952
|
/**
|
|
9552
9953
|
* Campaign
|
|
9553
9954
|
*/
|
|
@@ -9602,45 +10003,29 @@ export declare namespace Models {
|
|
|
9602
10003
|
footer?: boolean;
|
|
9603
10004
|
};
|
|
9604
10005
|
/**
|
|
9605
|
-
*
|
|
10006
|
+
* Connection
|
|
9606
10007
|
*/
|
|
9607
|
-
export type
|
|
10008
|
+
export type DedicatedDatabaseConnection = {
|
|
9608
10009
|
/**
|
|
9609
|
-
*
|
|
10010
|
+
* Connection ID.
|
|
9610
10011
|
*/
|
|
9611
10012
|
$id: string;
|
|
9612
10013
|
/**
|
|
9613
|
-
*
|
|
9614
|
-
*/
|
|
9615
|
-
title: string;
|
|
9616
|
-
/**
|
|
9617
|
-
* Program description
|
|
9618
|
-
*/
|
|
9619
|
-
description: string;
|
|
9620
|
-
/**
|
|
9621
|
-
* Program tag for highlighting on console
|
|
9622
|
-
*/
|
|
9623
|
-
tag: string;
|
|
9624
|
-
/**
|
|
9625
|
-
* Program icon for highlighting on console
|
|
9626
|
-
*/
|
|
9627
|
-
icon: string;
|
|
9628
|
-
/**
|
|
9629
|
-
* URL for more information on this program
|
|
10014
|
+
* Connection username.
|
|
9630
10015
|
*/
|
|
9631
|
-
|
|
10016
|
+
username: string;
|
|
9632
10017
|
/**
|
|
9633
|
-
*
|
|
10018
|
+
* Database name.
|
|
9634
10019
|
*/
|
|
9635
|
-
|
|
10020
|
+
database: string;
|
|
9636
10021
|
/**
|
|
9637
|
-
*
|
|
10022
|
+
* Connection role. Common values: readonly, readwrite.
|
|
9638
10023
|
*/
|
|
9639
|
-
|
|
10024
|
+
role: string;
|
|
9640
10025
|
/**
|
|
9641
|
-
*
|
|
10026
|
+
* Connection creation date in ISO 8601 format.
|
|
9642
10027
|
*/
|
|
9643
|
-
|
|
10028
|
+
$createdAt: string;
|
|
9644
10029
|
};
|
|
9645
10030
|
/**
|
|
9646
10031
|
* Coupon
|
|
@@ -9679,6 +10064,47 @@ export declare namespace Models {
|
|
|
9679
10064
|
*/
|
|
9680
10065
|
onlyNewOrgs: boolean;
|
|
9681
10066
|
};
|
|
10067
|
+
/**
|
|
10068
|
+
* Credentials
|
|
10069
|
+
*/
|
|
10070
|
+
export type DedicatedDatabaseCredentials = {
|
|
10071
|
+
/**
|
|
10072
|
+
* Database ID.
|
|
10073
|
+
*/
|
|
10074
|
+
$id: string;
|
|
10075
|
+
/**
|
|
10076
|
+
* Database hostname.
|
|
10077
|
+
*/
|
|
10078
|
+
host: string;
|
|
10079
|
+
/**
|
|
10080
|
+
* Database port.
|
|
10081
|
+
*/
|
|
10082
|
+
port: number;
|
|
10083
|
+
/**
|
|
10084
|
+
* Database username.
|
|
10085
|
+
*/
|
|
10086
|
+
username: string;
|
|
10087
|
+
/**
|
|
10088
|
+
* Database password.
|
|
10089
|
+
*/
|
|
10090
|
+
password: string;
|
|
10091
|
+
/**
|
|
10092
|
+
* Database name.
|
|
10093
|
+
*/
|
|
10094
|
+
database: string;
|
|
10095
|
+
/**
|
|
10096
|
+
* Database engine. Possible values: postgres, mysql, mariadb, mongodb.
|
|
10097
|
+
*/
|
|
10098
|
+
engine: string;
|
|
10099
|
+
/**
|
|
10100
|
+
* Whether SSL is required.
|
|
10101
|
+
*/
|
|
10102
|
+
ssl: boolean;
|
|
10103
|
+
/**
|
|
10104
|
+
* Full connection string.
|
|
10105
|
+
*/
|
|
10106
|
+
connectionString: string;
|
|
10107
|
+
};
|
|
9682
10108
|
/**
|
|
9683
10109
|
* Credit
|
|
9684
10110
|
*/
|
|
@@ -9755,516 +10181,1423 @@ export declare namespace Models {
|
|
|
9755
10181
|
available: number;
|
|
9756
10182
|
};
|
|
9757
10183
|
/**
|
|
9758
|
-
*
|
|
10184
|
+
* DatabaseMetrics
|
|
9759
10185
|
*/
|
|
9760
|
-
export type
|
|
10186
|
+
export type DedicatedDatabaseMetrics = {
|
|
9761
10187
|
/**
|
|
9762
|
-
*
|
|
10188
|
+
* Metrics aggregation period. Possible values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).
|
|
9763
10189
|
*/
|
|
9764
|
-
|
|
10190
|
+
period: string;
|
|
9765
10191
|
/**
|
|
9766
|
-
*
|
|
10192
|
+
* Average CPU usage percentage.
|
|
9767
10193
|
*/
|
|
9768
|
-
|
|
10194
|
+
cpuPercent: number;
|
|
9769
10195
|
/**
|
|
9770
|
-
*
|
|
10196
|
+
* Average memory usage percentage.
|
|
9771
10197
|
*/
|
|
9772
|
-
|
|
10198
|
+
memoryPercent: number;
|
|
9773
10199
|
/**
|
|
9774
|
-
*
|
|
10200
|
+
* Memory used in bytes.
|
|
9775
10201
|
*/
|
|
9776
|
-
|
|
10202
|
+
memoryUsedBytes: number;
|
|
9777
10203
|
/**
|
|
9778
|
-
*
|
|
10204
|
+
* Maximum memory available in bytes.
|
|
9779
10205
|
*/
|
|
9780
|
-
|
|
10206
|
+
memoryMaxBytes: number;
|
|
9781
10207
|
/**
|
|
9782
|
-
*
|
|
10208
|
+
* Storage used in bytes.
|
|
9783
10209
|
*/
|
|
9784
|
-
|
|
10210
|
+
storageUsedBytes: number;
|
|
9785
10211
|
/**
|
|
9786
|
-
*
|
|
10212
|
+
* Current active connections.
|
|
9787
10213
|
*/
|
|
9788
|
-
|
|
10214
|
+
connectionsActive: number;
|
|
9789
10215
|
/**
|
|
9790
|
-
*
|
|
10216
|
+
* Maximum connections configured.
|
|
9791
10217
|
*/
|
|
9792
|
-
|
|
10218
|
+
connectionsMax: number;
|
|
9793
10219
|
/**
|
|
9794
|
-
*
|
|
10220
|
+
* Average read IOPS.
|
|
9795
10221
|
*/
|
|
9796
|
-
|
|
10222
|
+
iopsRead: number;
|
|
9797
10223
|
/**
|
|
9798
|
-
*
|
|
10224
|
+
* Average write IOPS.
|
|
9799
10225
|
*/
|
|
9800
|
-
|
|
10226
|
+
iopsWrite: number;
|
|
10227
|
+
/**
|
|
10228
|
+
* Queries per second.
|
|
10229
|
+
*/
|
|
10230
|
+
qps: number;
|
|
9801
10231
|
};
|
|
9802
10232
|
/**
|
|
9803
|
-
*
|
|
10233
|
+
* DedicatedDatabase
|
|
9804
10234
|
*/
|
|
9805
|
-
export type
|
|
10235
|
+
export type DedicatedDatabase = {
|
|
9806
10236
|
/**
|
|
9807
|
-
*
|
|
10237
|
+
* Dedicated database ID.
|
|
9808
10238
|
*/
|
|
9809
10239
|
$id: string;
|
|
9810
10240
|
/**
|
|
9811
|
-
*
|
|
10241
|
+
* Database creation time in ISO 8601 format.
|
|
9812
10242
|
*/
|
|
9813
10243
|
$createdAt: string;
|
|
9814
10244
|
/**
|
|
9815
|
-
*
|
|
10245
|
+
* Database update date in ISO 8601 format.
|
|
9816
10246
|
*/
|
|
9817
10247
|
$updatedAt: string;
|
|
9818
10248
|
/**
|
|
9819
|
-
*
|
|
10249
|
+
* Project ID that owns this database.
|
|
9820
10250
|
*/
|
|
9821
|
-
|
|
10251
|
+
projectId: string;
|
|
9822
10252
|
/**
|
|
9823
|
-
*
|
|
10253
|
+
* Database display name.
|
|
9824
10254
|
*/
|
|
9825
|
-
|
|
10255
|
+
name: string;
|
|
9826
10256
|
/**
|
|
9827
|
-
*
|
|
10257
|
+
* Database type: shared (serverless) or dedicated (always-on).
|
|
9828
10258
|
*/
|
|
9829
|
-
|
|
10259
|
+
type: string;
|
|
9830
10260
|
/**
|
|
9831
|
-
*
|
|
10261
|
+
* Product API that owns this database: compute, documentsdb, or vectorsdb.
|
|
9832
10262
|
*/
|
|
9833
|
-
|
|
10263
|
+
api: string;
|
|
9834
10264
|
/**
|
|
9835
|
-
*
|
|
10265
|
+
* Region identifier (e.g., fra, nyc, syd).
|
|
9836
10266
|
*/
|
|
9837
|
-
|
|
10267
|
+
region: string;
|
|
9838
10268
|
/**
|
|
9839
|
-
*
|
|
10269
|
+
* Database engine: postgres, mysql, mariadb, or mongodb.
|
|
9840
10270
|
*/
|
|
9841
|
-
|
|
10271
|
+
engine: string;
|
|
9842
10272
|
/**
|
|
9843
|
-
*
|
|
10273
|
+
* Database engine version.
|
|
9844
10274
|
*/
|
|
9845
|
-
|
|
10275
|
+
version: string;
|
|
9846
10276
|
/**
|
|
9847
|
-
*
|
|
10277
|
+
* Specification identifier.
|
|
9848
10278
|
*/
|
|
9849
|
-
|
|
10279
|
+
specification: string;
|
|
9850
10280
|
/**
|
|
9851
|
-
*
|
|
10281
|
+
* Database backend provider. Possible values: prisma, edge.
|
|
9852
10282
|
*/
|
|
9853
|
-
|
|
10283
|
+
backend: string;
|
|
9854
10284
|
/**
|
|
9855
|
-
*
|
|
10285
|
+
* Database hostname for connections.
|
|
9856
10286
|
*/
|
|
9857
|
-
|
|
10287
|
+
hostname: string;
|
|
9858
10288
|
/**
|
|
9859
|
-
*
|
|
10289
|
+
* Database port for connections.
|
|
9860
10290
|
*/
|
|
9861
|
-
|
|
10291
|
+
connectionPort: number;
|
|
9862
10292
|
/**
|
|
9863
|
-
*
|
|
10293
|
+
* Database username for connections.
|
|
9864
10294
|
*/
|
|
9865
|
-
|
|
10295
|
+
connectionUser: string;
|
|
9866
10296
|
/**
|
|
9867
|
-
*
|
|
10297
|
+
* Database password for connections.
|
|
9868
10298
|
*/
|
|
9869
|
-
|
|
10299
|
+
connectionPassword: string;
|
|
9870
10300
|
/**
|
|
9871
|
-
*
|
|
10301
|
+
* Full database connection string (URI format).
|
|
9872
10302
|
*/
|
|
9873
|
-
|
|
10303
|
+
connectionString: string;
|
|
9874
10304
|
/**
|
|
9875
|
-
*
|
|
10305
|
+
* Database status. Possible values: provisioning, ready, inactive, paused, failed, deleted, restoring, scaling.
|
|
9876
10306
|
*/
|
|
9877
10307
|
status: string;
|
|
9878
10308
|
/**
|
|
9879
|
-
*
|
|
9880
|
-
*/
|
|
9881
|
-
type: string;
|
|
9882
|
-
/**
|
|
9883
|
-
* Last payment error associated with the invoice
|
|
10309
|
+
* Container status for shared databases: active or inactive.
|
|
9884
10310
|
*/
|
|
9885
|
-
|
|
10311
|
+
containerStatus: string;
|
|
9886
10312
|
/**
|
|
9887
|
-
*
|
|
10313
|
+
* Last activity timestamp in ISO 8601 format.
|
|
9888
10314
|
*/
|
|
9889
|
-
|
|
10315
|
+
lastAccessedAt: string;
|
|
9890
10316
|
/**
|
|
9891
|
-
*
|
|
10317
|
+
* Timestamp when container will be considered idle and scale to zero (ISO 8601 format).
|
|
9892
10318
|
*/
|
|
9893
|
-
|
|
10319
|
+
idleUntil: string;
|
|
9894
10320
|
/**
|
|
9895
|
-
*
|
|
10321
|
+
* Minutes of inactivity before container scales to zero.
|
|
9896
10322
|
*/
|
|
9897
|
-
|
|
9898
|
-
};
|
|
9899
|
-
/**
|
|
9900
|
-
* Organization
|
|
9901
|
-
*/
|
|
9902
|
-
export type Organization<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
10323
|
+
idleTimeoutMinutes: number;
|
|
9903
10324
|
/**
|
|
9904
|
-
*
|
|
10325
|
+
* CPU allocated in millicores.
|
|
9905
10326
|
*/
|
|
9906
|
-
|
|
10327
|
+
cpu: number;
|
|
9907
10328
|
/**
|
|
9908
|
-
*
|
|
10329
|
+
* Memory allocated in MB.
|
|
9909
10330
|
*/
|
|
9910
|
-
|
|
10331
|
+
memory: number;
|
|
9911
10332
|
/**
|
|
9912
|
-
*
|
|
10333
|
+
* Storage allocated in GB.
|
|
9913
10334
|
*/
|
|
9914
|
-
|
|
10335
|
+
storage: number;
|
|
9915
10336
|
/**
|
|
9916
|
-
*
|
|
10337
|
+
* Storage class: ssd, nvme, or hdd.
|
|
9917
10338
|
*/
|
|
9918
|
-
|
|
10339
|
+
storageClass: string;
|
|
9919
10340
|
/**
|
|
9920
|
-
*
|
|
10341
|
+
* Maximum storage allowed in GB. 0 means use system default.
|
|
9921
10342
|
*/
|
|
9922
|
-
|
|
10343
|
+
storageMaxGb: number;
|
|
9923
10344
|
/**
|
|
9924
|
-
*
|
|
10345
|
+
* Kubernetes node pool where the database is scheduled.
|
|
9925
10346
|
*/
|
|
9926
|
-
|
|
10347
|
+
nodePool: string;
|
|
9927
10348
|
/**
|
|
9928
|
-
*
|
|
10349
|
+
* Whether high availability is enabled.
|
|
9929
10350
|
*/
|
|
9930
|
-
|
|
10351
|
+
highAvailability: boolean;
|
|
9931
10352
|
/**
|
|
9932
|
-
*
|
|
10353
|
+
* Number of high availability replicas.
|
|
9933
10354
|
*/
|
|
9934
|
-
|
|
10355
|
+
highAvailabilityReplicaCount: number;
|
|
9935
10356
|
/**
|
|
9936
|
-
*
|
|
10357
|
+
* Replication sync mode: async, sync, or quorum.
|
|
9937
10358
|
*/
|
|
9938
|
-
|
|
10359
|
+
highAvailabilitySyncMode: string;
|
|
9939
10360
|
/**
|
|
9940
|
-
*
|
|
10361
|
+
* Maximum concurrent connections.
|
|
9941
10362
|
*/
|
|
9942
|
-
|
|
10363
|
+
networkMaxConnections: number;
|
|
9943
10364
|
/**
|
|
9944
|
-
*
|
|
10365
|
+
* Connection idle timeout in seconds.
|
|
9945
10366
|
*/
|
|
9946
|
-
|
|
10367
|
+
networkIdleTimeoutSeconds: number;
|
|
9947
10368
|
/**
|
|
9948
|
-
*
|
|
10369
|
+
* IP addresses/CIDR ranges allowed to connect.
|
|
9949
10370
|
*/
|
|
9950
|
-
|
|
10371
|
+
networkIPAllowlist: string[];
|
|
9951
10372
|
/**
|
|
9952
|
-
*
|
|
10373
|
+
* Whether automatic backups are enabled.
|
|
9953
10374
|
*/
|
|
9954
|
-
|
|
10375
|
+
backupEnabled: boolean;
|
|
9955
10376
|
/**
|
|
9956
|
-
*
|
|
10377
|
+
* Whether point-in-time recovery is enabled.
|
|
9957
10378
|
*/
|
|
9958
|
-
|
|
10379
|
+
backupPitr: boolean;
|
|
9959
10380
|
/**
|
|
9960
|
-
*
|
|
10381
|
+
* Backup schedule in cron format.
|
|
9961
10382
|
*/
|
|
9962
|
-
|
|
10383
|
+
backupCron: string;
|
|
9963
10384
|
/**
|
|
9964
|
-
*
|
|
10385
|
+
* Number of days to retain backups.
|
|
9965
10386
|
*/
|
|
9966
|
-
|
|
10387
|
+
backupRetentionDays: number;
|
|
9967
10388
|
/**
|
|
9968
|
-
* Number of
|
|
10389
|
+
* Number of days to retain PITR data.
|
|
9969
10390
|
*/
|
|
9970
|
-
|
|
10391
|
+
pitrRetentionDays: number;
|
|
9971
10392
|
/**
|
|
9972
|
-
*
|
|
10393
|
+
* Whether automatic storage expansion is enabled.
|
|
9973
10394
|
*/
|
|
9974
|
-
|
|
10395
|
+
storageAutoscaling: boolean;
|
|
9975
10396
|
/**
|
|
9976
|
-
*
|
|
10397
|
+
* Storage usage percentage that triggers automatic expansion.
|
|
9977
10398
|
*/
|
|
9978
|
-
|
|
10399
|
+
storageAutoscalingThresholdPercent: number;
|
|
9979
10400
|
/**
|
|
9980
|
-
*
|
|
10401
|
+
* Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
9981
10402
|
*/
|
|
9982
|
-
|
|
10403
|
+
storageAutoscalingMaxGb: number;
|
|
9983
10404
|
/**
|
|
9984
|
-
*
|
|
10405
|
+
* Day of the week for the maintenance window. Possible values: sun, mon, tue, wed, thu, fri, sat.
|
|
9985
10406
|
*/
|
|
9986
|
-
|
|
10407
|
+
maintenanceWindowDay: string;
|
|
9987
10408
|
/**
|
|
9988
|
-
*
|
|
10409
|
+
* Hour in UTC (0-23) when the maintenance window starts.
|
|
9989
10410
|
*/
|
|
9990
|
-
|
|
10411
|
+
maintenanceWindowHourUtc: number;
|
|
9991
10412
|
/**
|
|
9992
|
-
*
|
|
10413
|
+
* Whether metrics collection is enabled.
|
|
9993
10414
|
*/
|
|
9994
|
-
|
|
10415
|
+
metricsEnabled: boolean;
|
|
9995
10416
|
/**
|
|
9996
|
-
*
|
|
10417
|
+
* Whether the SQL API sidecar is enabled for this database.
|
|
9997
10418
|
*/
|
|
9998
|
-
|
|
10419
|
+
sqlApiEnabled: boolean;
|
|
9999
10420
|
/**
|
|
10000
|
-
*
|
|
10421
|
+
* Statement types accepted by the SQL API. Allowed values: SELECT, INSERT, UPDATE, DELETE.
|
|
10001
10422
|
*/
|
|
10002
|
-
|
|
10423
|
+
sqlApiAllowedStatements: string[];
|
|
10003
10424
|
/**
|
|
10004
|
-
*
|
|
10425
|
+
* Maximum rows returned per SQL API execution. Results larger than this are truncated.
|
|
10005
10426
|
*/
|
|
10006
|
-
|
|
10427
|
+
sqlApiMaxRows: number;
|
|
10007
10428
|
/**
|
|
10008
|
-
*
|
|
10429
|
+
* Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.
|
|
10009
10430
|
*/
|
|
10010
|
-
|
|
10431
|
+
sqlApiMaxBytes: number;
|
|
10011
10432
|
/**
|
|
10012
|
-
*
|
|
10433
|
+
* Maximum server-side SQL API execution time in seconds before the query is cancelled.
|
|
10013
10434
|
*/
|
|
10014
|
-
|
|
10435
|
+
sqlApiTimeoutSeconds: number;
|
|
10015
10436
|
/**
|
|
10016
|
-
*
|
|
10437
|
+
* Error message if status is failed.
|
|
10017
10438
|
*/
|
|
10018
|
-
|
|
10439
|
+
error: string;
|
|
10440
|
+
};
|
|
10441
|
+
/**
|
|
10442
|
+
* Execution
|
|
10443
|
+
*/
|
|
10444
|
+
export type DedicatedDatabaseExecution = {
|
|
10019
10445
|
/**
|
|
10020
|
-
*
|
|
10446
|
+
* Result rows as a list of column-name => value maps. Empty for non-returning statements.
|
|
10021
10447
|
*/
|
|
10022
|
-
|
|
10448
|
+
rows: object;
|
|
10023
10449
|
/**
|
|
10024
|
-
*
|
|
10450
|
+
* Number of rows returned (for SELECT) or affected (for INSERT/UPDATE/DELETE).
|
|
10025
10451
|
*/
|
|
10026
|
-
|
|
10452
|
+
rowCount: number;
|
|
10027
10453
|
/**
|
|
10028
|
-
*
|
|
10454
|
+
* Column metadata in result-set order.
|
|
10029
10455
|
*/
|
|
10030
|
-
|
|
10456
|
+
columns: DedicatedDatabaseExecutionColumn[];
|
|
10031
10457
|
/**
|
|
10032
|
-
*
|
|
10458
|
+
* Server-side execution time in milliseconds.
|
|
10033
10459
|
*/
|
|
10034
|
-
|
|
10460
|
+
durationMs: number;
|
|
10035
10461
|
/**
|
|
10036
|
-
*
|
|
10462
|
+
* True when the configured row or byte cap was hit and the result was truncated.
|
|
10037
10463
|
*/
|
|
10038
|
-
|
|
10464
|
+
truncated: boolean;
|
|
10039
10465
|
/**
|
|
10040
|
-
*
|
|
10466
|
+
* Serialised payload size in bytes.
|
|
10041
10467
|
*/
|
|
10042
|
-
|
|
10468
|
+
bytes: number;
|
|
10043
10469
|
};
|
|
10044
10470
|
/**
|
|
10045
|
-
*
|
|
10471
|
+
* ExecutionColumn
|
|
10046
10472
|
*/
|
|
10047
|
-
export type
|
|
10048
|
-
/**
|
|
10049
|
-
* Message for the end user to show on Console.
|
|
10050
|
-
*/
|
|
10051
|
-
message: string;
|
|
10052
|
-
/**
|
|
10053
|
-
* Stripe client secret to use for validation.
|
|
10054
|
-
*/
|
|
10055
|
-
clientSecret: string;
|
|
10056
|
-
/**
|
|
10057
|
-
* Organization ID for which the payment authentication is needed.
|
|
10058
|
-
*/
|
|
10059
|
-
organizationId: string;
|
|
10473
|
+
export type DedicatedDatabaseExecutionColumn = {
|
|
10060
10474
|
/**
|
|
10061
|
-
*
|
|
10475
|
+
* Column name as returned by the database.
|
|
10062
10476
|
*/
|
|
10063
|
-
|
|
10477
|
+
name: string;
|
|
10064
10478
|
/**
|
|
10065
|
-
*
|
|
10479
|
+
* Engine-specific column type (e.g. int4, text, timestamptz).
|
|
10066
10480
|
*/
|
|
10067
|
-
|
|
10481
|
+
type: string;
|
|
10068
10482
|
};
|
|
10069
10483
|
/**
|
|
10070
|
-
*
|
|
10484
|
+
* Restoration
|
|
10071
10485
|
*/
|
|
10072
|
-
export type
|
|
10486
|
+
export type DedicatedDatabaseRestoration = {
|
|
10073
10487
|
/**
|
|
10074
|
-
*
|
|
10488
|
+
* Restoration ID.
|
|
10075
10489
|
*/
|
|
10076
10490
|
$id: string;
|
|
10077
10491
|
/**
|
|
10078
|
-
*
|
|
10492
|
+
* Restoration creation time in ISO 8601 format.
|
|
10079
10493
|
*/
|
|
10080
10494
|
$createdAt: string;
|
|
10081
10495
|
/**
|
|
10082
|
-
*
|
|
10083
|
-
*/
|
|
10084
|
-
$updatedAt: string;
|
|
10085
|
-
/**
|
|
10086
|
-
* Payment method permissions. [Learn more about permissions](/docs/permissions).
|
|
10496
|
+
* Database ID being restored.
|
|
10087
10497
|
*/
|
|
10088
|
-
|
|
10498
|
+
databaseId: string;
|
|
10089
10499
|
/**
|
|
10090
|
-
*
|
|
10500
|
+
* Project ID.
|
|
10091
10501
|
*/
|
|
10092
|
-
|
|
10502
|
+
projectId: string;
|
|
10093
10503
|
/**
|
|
10094
|
-
*
|
|
10504
|
+
* Backup ID used for restoration (null for PITR).
|
|
10095
10505
|
*/
|
|
10096
|
-
|
|
10506
|
+
backupId: string;
|
|
10097
10507
|
/**
|
|
10098
|
-
*
|
|
10508
|
+
* Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).
|
|
10099
10509
|
*/
|
|
10100
|
-
|
|
10510
|
+
type: string;
|
|
10101
10511
|
/**
|
|
10102
|
-
*
|
|
10512
|
+
* Restoration status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error).
|
|
10103
10513
|
*/
|
|
10104
|
-
|
|
10514
|
+
status: string;
|
|
10105
10515
|
/**
|
|
10106
|
-
*
|
|
10516
|
+
* Target time for PITR restoration in ISO 8601 format.
|
|
10107
10517
|
*/
|
|
10108
|
-
|
|
10518
|
+
targetTime: string;
|
|
10109
10519
|
/**
|
|
10110
|
-
*
|
|
10520
|
+
* Restoration start time in ISO 8601 format.
|
|
10111
10521
|
*/
|
|
10112
|
-
|
|
10522
|
+
startedAt: string;
|
|
10113
10523
|
/**
|
|
10114
|
-
*
|
|
10524
|
+
* Restoration completion time in ISO 8601 format.
|
|
10115
10525
|
*/
|
|
10116
|
-
|
|
10526
|
+
completedAt: string;
|
|
10117
10527
|
/**
|
|
10118
|
-
*
|
|
10528
|
+
* Error message if restoration failed.
|
|
10119
10529
|
*/
|
|
10120
|
-
|
|
10530
|
+
error: string;
|
|
10531
|
+
};
|
|
10532
|
+
/**
|
|
10533
|
+
* Status
|
|
10534
|
+
*/
|
|
10535
|
+
export type DatabaseStatus = {
|
|
10121
10536
|
/**
|
|
10122
|
-
*
|
|
10537
|
+
* Overall health status: healthy, degraded, or unhealthy.
|
|
10123
10538
|
*/
|
|
10124
|
-
|
|
10539
|
+
health: string;
|
|
10125
10540
|
/**
|
|
10126
|
-
*
|
|
10541
|
+
* Whether the database is ready to accept connections.
|
|
10127
10542
|
*/
|
|
10128
|
-
|
|
10543
|
+
ready: boolean;
|
|
10129
10544
|
/**
|
|
10130
|
-
*
|
|
10545
|
+
* Database engine: postgres, mysql, mariadb, or mongodb.
|
|
10131
10546
|
*/
|
|
10132
|
-
|
|
10547
|
+
engine: string;
|
|
10133
10548
|
/**
|
|
10134
|
-
*
|
|
10549
|
+
* Database engine version.
|
|
10135
10550
|
*/
|
|
10136
|
-
|
|
10551
|
+
version: string;
|
|
10137
10552
|
/**
|
|
10138
|
-
*
|
|
10553
|
+
* Database uptime in seconds.
|
|
10139
10554
|
*/
|
|
10140
|
-
|
|
10555
|
+
uptime: number;
|
|
10141
10556
|
/**
|
|
10142
|
-
*
|
|
10557
|
+
* Connection statistics.
|
|
10143
10558
|
*/
|
|
10144
|
-
|
|
10559
|
+
connections: DatabaseStatusConnections;
|
|
10145
10560
|
/**
|
|
10146
|
-
*
|
|
10561
|
+
* List of database replicas and their status.
|
|
10147
10562
|
*/
|
|
10148
|
-
|
|
10563
|
+
replicas: DatabaseStatusReplica[];
|
|
10149
10564
|
/**
|
|
10150
|
-
*
|
|
10565
|
+
* Storage volume information.
|
|
10151
10566
|
*/
|
|
10152
|
-
|
|
10567
|
+
volumes: DatabaseStatusVolume[];
|
|
10153
10568
|
};
|
|
10154
10569
|
/**
|
|
10155
|
-
*
|
|
10570
|
+
* DNSRecord
|
|
10156
10571
|
*/
|
|
10157
|
-
export type
|
|
10572
|
+
export type DnsRecord = {
|
|
10158
10573
|
/**
|
|
10159
|
-
*
|
|
10574
|
+
* DNS Record ID.
|
|
10160
10575
|
*/
|
|
10161
10576
|
$id: string;
|
|
10162
10577
|
/**
|
|
10163
|
-
*
|
|
10164
|
-
*/
|
|
10165
|
-
name: string;
|
|
10166
|
-
/**
|
|
10167
|
-
* Policy creation date in ISO 8601 format.
|
|
10578
|
+
* DNS Record creation time in ISO 8601 format.
|
|
10168
10579
|
*/
|
|
10169
10580
|
$createdAt: string;
|
|
10170
10581
|
/**
|
|
10171
|
-
*
|
|
10582
|
+
* DNS Record update date in ISO 8601 format.
|
|
10172
10583
|
*/
|
|
10173
10584
|
$updatedAt: string;
|
|
10174
10585
|
/**
|
|
10175
|
-
*
|
|
10586
|
+
* DNS record type (e.g. A, CNAME, MX).
|
|
10176
10587
|
*/
|
|
10177
|
-
|
|
10588
|
+
type: string;
|
|
10178
10589
|
/**
|
|
10179
|
-
*
|
|
10590
|
+
* Record name or subdomain.
|
|
10180
10591
|
*/
|
|
10181
|
-
|
|
10592
|
+
name: string;
|
|
10182
10593
|
/**
|
|
10183
|
-
*
|
|
10594
|
+
* Value of the record (IP address, domain, etc.).
|
|
10184
10595
|
*/
|
|
10185
|
-
|
|
10596
|
+
value: string;
|
|
10186
10597
|
/**
|
|
10187
|
-
*
|
|
10598
|
+
* Time to live (in seconds).
|
|
10188
10599
|
*/
|
|
10189
|
-
|
|
10600
|
+
ttl: number;
|
|
10190
10601
|
/**
|
|
10191
|
-
*
|
|
10602
|
+
* Record priority (commonly used for MX).
|
|
10192
10603
|
*/
|
|
10193
|
-
|
|
10604
|
+
priority: number;
|
|
10194
10605
|
/**
|
|
10195
|
-
*
|
|
10606
|
+
* Whether this record is locked (read-only).
|
|
10196
10607
|
*/
|
|
10197
|
-
|
|
10608
|
+
lock: boolean;
|
|
10198
10609
|
/**
|
|
10199
|
-
*
|
|
10610
|
+
* Record weight (used for SRV records).
|
|
10200
10611
|
*/
|
|
10201
|
-
|
|
10612
|
+
weight: number;
|
|
10613
|
+
/**
|
|
10614
|
+
* Target port (used for SRV records).
|
|
10615
|
+
*/
|
|
10616
|
+
port: number;
|
|
10617
|
+
/**
|
|
10618
|
+
* Comment for the DNS record.
|
|
10619
|
+
*/
|
|
10620
|
+
comment: string;
|
|
10202
10621
|
};
|
|
10203
10622
|
/**
|
|
10204
|
-
*
|
|
10623
|
+
* Domain
|
|
10205
10624
|
*/
|
|
10206
|
-
export type
|
|
10625
|
+
export type Domain = {
|
|
10207
10626
|
/**
|
|
10208
|
-
*
|
|
10627
|
+
* Domain ID.
|
|
10209
10628
|
*/
|
|
10210
10629
|
$id: string;
|
|
10211
10630
|
/**
|
|
10212
|
-
*
|
|
10631
|
+
* Domain creation time in ISO 8601 format.
|
|
10213
10632
|
*/
|
|
10214
|
-
|
|
10633
|
+
$createdAt: string;
|
|
10634
|
+
/**
|
|
10635
|
+
* Domain update date in ISO 8601 format.
|
|
10636
|
+
*/
|
|
10637
|
+
$updatedAt: string;
|
|
10638
|
+
/**
|
|
10639
|
+
* Domain name.
|
|
10640
|
+
*/
|
|
10641
|
+
domain: string;
|
|
10642
|
+
/**
|
|
10643
|
+
* Domain registrar (e.g. "appwrite" or "third_party").
|
|
10644
|
+
*/
|
|
10645
|
+
registrar: string;
|
|
10646
|
+
/**
|
|
10647
|
+
* Nameservers setting. "Appwrite" or empty string.
|
|
10648
|
+
*/
|
|
10649
|
+
nameservers: string;
|
|
10650
|
+
/**
|
|
10651
|
+
* Domain expiry date in ISO 8601 format.
|
|
10652
|
+
*/
|
|
10653
|
+
expire: string;
|
|
10654
|
+
/**
|
|
10655
|
+
* Domain renewal date in ISO 8601 format.
|
|
10656
|
+
*/
|
|
10657
|
+
renewal: string;
|
|
10658
|
+
/**
|
|
10659
|
+
* If set to true, the domain will automatically renew.
|
|
10660
|
+
*/
|
|
10661
|
+
autoRenewal: boolean;
|
|
10662
|
+
/**
|
|
10663
|
+
* Renewal price (in cents).
|
|
10664
|
+
*/
|
|
10665
|
+
renewalPrice: number;
|
|
10666
|
+
/**
|
|
10667
|
+
* Transfer status for domains being transferred in.
|
|
10668
|
+
*/
|
|
10669
|
+
transferStatus: DomainTransferStatusEnum;
|
|
10670
|
+
/**
|
|
10671
|
+
* Team ID.
|
|
10672
|
+
*/
|
|
10673
|
+
teamId: string;
|
|
10674
|
+
/**
|
|
10675
|
+
* Dns records
|
|
10676
|
+
*/
|
|
10677
|
+
dnsRecords: DnsRecord[];
|
|
10678
|
+
};
|
|
10679
|
+
/**
|
|
10680
|
+
* DomainPrice
|
|
10681
|
+
*/
|
|
10682
|
+
export type DomainPrice = {
|
|
10683
|
+
/**
|
|
10684
|
+
* Domain name.
|
|
10685
|
+
*/
|
|
10686
|
+
domain: string;
|
|
10687
|
+
/**
|
|
10688
|
+
* Top-level domain for the requested domain.
|
|
10689
|
+
*/
|
|
10690
|
+
tld: string;
|
|
10691
|
+
/**
|
|
10692
|
+
* Whether the domain is currently available for registration.
|
|
10693
|
+
*/
|
|
10694
|
+
available: boolean;
|
|
10695
|
+
/**
|
|
10696
|
+
* Domain registration price.
|
|
10697
|
+
*/
|
|
10698
|
+
price: number;
|
|
10699
|
+
/**
|
|
10700
|
+
* Price period in years.
|
|
10701
|
+
*/
|
|
10702
|
+
periodYears: number;
|
|
10703
|
+
/**
|
|
10704
|
+
* Whether the domain is a premium domain.
|
|
10705
|
+
*/
|
|
10706
|
+
premium: boolean;
|
|
10707
|
+
};
|
|
10708
|
+
/**
|
|
10709
|
+
* DomainPurchase
|
|
10710
|
+
*/
|
|
10711
|
+
export type DomainPurchase = {
|
|
10712
|
+
/**
|
|
10713
|
+
* Purchase/invoice ID.
|
|
10714
|
+
*/
|
|
10715
|
+
$id: string;
|
|
10716
|
+
/**
|
|
10717
|
+
* Purchase creation time in ISO 8601 format.
|
|
10718
|
+
*/
|
|
10719
|
+
$createdAt: string;
|
|
10720
|
+
/**
|
|
10721
|
+
* Purchase update date in ISO 8601 format.
|
|
10722
|
+
*/
|
|
10723
|
+
$updatedAt: string;
|
|
10724
|
+
/**
|
|
10725
|
+
* Domain document ID.
|
|
10726
|
+
*/
|
|
10727
|
+
domainId: string;
|
|
10728
|
+
/**
|
|
10729
|
+
* Domain name.
|
|
10730
|
+
*/
|
|
10731
|
+
domain: string;
|
|
10732
|
+
/**
|
|
10733
|
+
* Team ID that owns the domain.
|
|
10734
|
+
*/
|
|
10735
|
+
organizationId: string;
|
|
10736
|
+
/**
|
|
10737
|
+
* Domain purchase status.
|
|
10738
|
+
*/
|
|
10739
|
+
status: DomainPurchaseStatus;
|
|
10740
|
+
/**
|
|
10741
|
+
* Stripe client secret for 3DS; empty when not applicable.
|
|
10742
|
+
*/
|
|
10743
|
+
clientSecret: string;
|
|
10744
|
+
/**
|
|
10745
|
+
* Purchase amount.
|
|
10746
|
+
*/
|
|
10747
|
+
amount: number;
|
|
10748
|
+
/**
|
|
10749
|
+
* Currency code.
|
|
10750
|
+
*/
|
|
10751
|
+
currency: string;
|
|
10752
|
+
};
|
|
10753
|
+
/**
|
|
10754
|
+
* DomainSuggestion
|
|
10755
|
+
*/
|
|
10756
|
+
export type DomainSuggestion = {
|
|
10757
|
+
/**
|
|
10758
|
+
* Domain suggestion.
|
|
10759
|
+
*/
|
|
10760
|
+
domain: string;
|
|
10761
|
+
/**
|
|
10762
|
+
* Is the domain premium?
|
|
10763
|
+
*/
|
|
10764
|
+
premium: boolean;
|
|
10765
|
+
/**
|
|
10766
|
+
* Domain price.
|
|
10767
|
+
*/
|
|
10768
|
+
price?: number;
|
|
10769
|
+
/**
|
|
10770
|
+
* Is the domain available?
|
|
10771
|
+
*/
|
|
10772
|
+
available: boolean;
|
|
10773
|
+
};
|
|
10774
|
+
/**
|
|
10775
|
+
* domainTransferOut
|
|
10776
|
+
*/
|
|
10777
|
+
export type DomainTransferOut = {
|
|
10778
|
+
/**
|
|
10779
|
+
* Domain transfer authorization code.
|
|
10780
|
+
*/
|
|
10781
|
+
authCode: string;
|
|
10782
|
+
};
|
|
10783
|
+
/**
|
|
10784
|
+
* domainTransferStatus
|
|
10785
|
+
*/
|
|
10786
|
+
export type DomainTransferStatus = {
|
|
10787
|
+
/**
|
|
10788
|
+
* Transfer status.
|
|
10789
|
+
*/
|
|
10790
|
+
status: DomainTransferStatusEnum;
|
|
10791
|
+
/**
|
|
10792
|
+
* Additional transfer status information.
|
|
10793
|
+
*/
|
|
10794
|
+
reason: string;
|
|
10795
|
+
/**
|
|
10796
|
+
* Transfer status timestamp in ISO 8601 format.
|
|
10797
|
+
*/
|
|
10798
|
+
timestamp: string;
|
|
10799
|
+
};
|
|
10800
|
+
/**
|
|
10801
|
+
* Downgrade Feedback
|
|
10802
|
+
*/
|
|
10803
|
+
export type DowngradeFeedback = {
|
|
10804
|
+
/**
|
|
10805
|
+
* Feedback ID.
|
|
10806
|
+
*/
|
|
10807
|
+
$id: string;
|
|
10808
|
+
/**
|
|
10809
|
+
* Feedback creation date in ISO 8601 format.
|
|
10810
|
+
*/
|
|
10811
|
+
$createdAt: string;
|
|
10812
|
+
/**
|
|
10813
|
+
* Feedback update date in ISO 8601 format.
|
|
10814
|
+
*/
|
|
10815
|
+
$updatedAt: string;
|
|
10816
|
+
/**
|
|
10817
|
+
* Feedback reason
|
|
10818
|
+
*/
|
|
10819
|
+
title: string;
|
|
10820
|
+
/**
|
|
10821
|
+
* Feedback message
|
|
10822
|
+
*/
|
|
10823
|
+
message: string;
|
|
10824
|
+
/**
|
|
10825
|
+
* Plan ID downgrading from
|
|
10826
|
+
*/
|
|
10827
|
+
fromPlanId: string;
|
|
10828
|
+
/**
|
|
10829
|
+
* Plan ID downgrading to
|
|
10830
|
+
*/
|
|
10831
|
+
toPlanId: string;
|
|
10832
|
+
/**
|
|
10833
|
+
* Organization ID
|
|
10834
|
+
*/
|
|
10835
|
+
teamId: string;
|
|
10836
|
+
/**
|
|
10837
|
+
* User ID who submitted feedback
|
|
10838
|
+
*/
|
|
10839
|
+
userId: string;
|
|
10840
|
+
/**
|
|
10841
|
+
* Console version
|
|
10842
|
+
*/
|
|
10843
|
+
version: string;
|
|
10844
|
+
};
|
|
10845
|
+
/**
|
|
10846
|
+
* Estimation
|
|
10847
|
+
*/
|
|
10848
|
+
export type Estimation = {
|
|
10849
|
+
/**
|
|
10850
|
+
* Total amount
|
|
10851
|
+
*/
|
|
10852
|
+
amount: number;
|
|
10853
|
+
/**
|
|
10854
|
+
* Gross payable amount
|
|
10855
|
+
*/
|
|
10856
|
+
grossAmount: number;
|
|
10857
|
+
/**
|
|
10858
|
+
* Discount amount
|
|
10859
|
+
*/
|
|
10860
|
+
discount: number;
|
|
10861
|
+
/**
|
|
10862
|
+
* Credits amount
|
|
10863
|
+
*/
|
|
10864
|
+
credits: number;
|
|
10865
|
+
/**
|
|
10866
|
+
* Estimation items
|
|
10867
|
+
*/
|
|
10868
|
+
items: EstimationItem[];
|
|
10869
|
+
/**
|
|
10870
|
+
* Estimation discount items
|
|
10871
|
+
*/
|
|
10872
|
+
discounts: EstimationItem[];
|
|
10873
|
+
/**
|
|
10874
|
+
* Trial days
|
|
10875
|
+
*/
|
|
10876
|
+
trialDays: number;
|
|
10877
|
+
/**
|
|
10878
|
+
* Trial end date
|
|
10879
|
+
*/
|
|
10880
|
+
trialEndDate?: string;
|
|
10881
|
+
};
|
|
10882
|
+
/**
|
|
10883
|
+
* DeleteOrganization
|
|
10884
|
+
*/
|
|
10885
|
+
export type EstimationDeleteOrganization = {
|
|
10886
|
+
/**
|
|
10887
|
+
* List of unpaid invoices
|
|
10888
|
+
*/
|
|
10889
|
+
unpaidInvoices: Invoice[];
|
|
10890
|
+
};
|
|
10891
|
+
/**
|
|
10892
|
+
* Item
|
|
10893
|
+
*/
|
|
10894
|
+
export type EstimationItem = {
|
|
10895
|
+
/**
|
|
10896
|
+
* Label
|
|
10897
|
+
*/
|
|
10898
|
+
label: string;
|
|
10899
|
+
/**
|
|
10900
|
+
* Gross payable amount
|
|
10901
|
+
*/
|
|
10902
|
+
value: number;
|
|
10903
|
+
};
|
|
10904
|
+
/**
|
|
10905
|
+
* EstimationPlanChange
|
|
10906
|
+
*/
|
|
10907
|
+
export type EstimationPlanChange = {
|
|
10908
|
+
/**
|
|
10909
|
+
* Current billing plan ID
|
|
10910
|
+
*/
|
|
10911
|
+
currentBillingPlanId: string;
|
|
10912
|
+
/**
|
|
10913
|
+
* Target billing plan ID
|
|
10914
|
+
*/
|
|
10915
|
+
targetBillingPlanId: string;
|
|
10916
|
+
/**
|
|
10917
|
+
* Direction of plan change: upgrade, downgrade, or same
|
|
10918
|
+
*/
|
|
10919
|
+
direction: string;
|
|
10920
|
+
/**
|
|
10921
|
+
* Cost estimation details
|
|
10922
|
+
*/
|
|
10923
|
+
estimation: PlanChangeEstimationDetails;
|
|
10924
|
+
/**
|
|
10925
|
+
* Plan limits and compliance information
|
|
10926
|
+
*/
|
|
10927
|
+
limits: PlanChangeLimits;
|
|
10928
|
+
};
|
|
10929
|
+
/**
|
|
10930
|
+
* UpdatePlan
|
|
10931
|
+
*/
|
|
10932
|
+
export type EstimationUpdatePlan = {
|
|
10933
|
+
/**
|
|
10934
|
+
* Total amount
|
|
10935
|
+
*/
|
|
10936
|
+
amount: number;
|
|
10937
|
+
/**
|
|
10938
|
+
* Gross payable amount
|
|
10939
|
+
*/
|
|
10940
|
+
grossAmount: number;
|
|
10941
|
+
/**
|
|
10942
|
+
* Discount amount
|
|
10943
|
+
*/
|
|
10944
|
+
discount: number;
|
|
10945
|
+
/**
|
|
10946
|
+
* Credits amount
|
|
10947
|
+
*/
|
|
10948
|
+
credits: number;
|
|
10949
|
+
/**
|
|
10950
|
+
* Estimation items
|
|
10951
|
+
*/
|
|
10952
|
+
items: EstimationItem[];
|
|
10953
|
+
/**
|
|
10954
|
+
* Estimation discount items
|
|
10955
|
+
*/
|
|
10956
|
+
discounts: EstimationItem[];
|
|
10957
|
+
/**
|
|
10958
|
+
* Trial days
|
|
10959
|
+
*/
|
|
10960
|
+
trialDays: number;
|
|
10961
|
+
/**
|
|
10962
|
+
* Trial end date
|
|
10963
|
+
*/
|
|
10964
|
+
trialEndDate?: string;
|
|
10965
|
+
/**
|
|
10966
|
+
* Organization's existing credits
|
|
10967
|
+
*/
|
|
10968
|
+
organizationCredits: number;
|
|
10969
|
+
};
|
|
10970
|
+
/**
|
|
10971
|
+
* Extensions
|
|
10972
|
+
*/
|
|
10973
|
+
export type DedicatedDatabaseExtensions = {
|
|
10974
|
+
/**
|
|
10975
|
+
* List of installed extensions.
|
|
10976
|
+
*/
|
|
10977
|
+
installed: string[];
|
|
10978
|
+
/**
|
|
10979
|
+
* List of available extensions that can be installed.
|
|
10980
|
+
*/
|
|
10981
|
+
available: string[];
|
|
10982
|
+
};
|
|
10983
|
+
/**
|
|
10984
|
+
* HAReplica
|
|
10985
|
+
*/
|
|
10986
|
+
export type DedicatedDatabaseHAReplica = {
|
|
10987
|
+
/**
|
|
10988
|
+
* Replica identifier.
|
|
10989
|
+
*/
|
|
10990
|
+
$id: string;
|
|
10991
|
+
/**
|
|
10992
|
+
* Replica role. Possible values: primary (accepts reads and writes), replica (read-only follower).
|
|
10993
|
+
*/
|
|
10994
|
+
role: string;
|
|
10995
|
+
/**
|
|
10996
|
+
* Replica health status. Possible values: healthy (fully synced), degraded (lagging behind primary), unhealthy (replication broken or unreachable).
|
|
10997
|
+
*/
|
|
10998
|
+
status: string;
|
|
10999
|
+
/**
|
|
11000
|
+
* Replication lag in seconds.
|
|
11001
|
+
*/
|
|
11002
|
+
lagSeconds: number;
|
|
11003
|
+
};
|
|
11004
|
+
/**
|
|
11005
|
+
* HAStatus
|
|
11006
|
+
*/
|
|
11007
|
+
export type DedicatedDatabaseHAStatus = {
|
|
11008
|
+
/**
|
|
11009
|
+
* Whether high availability is enabled.
|
|
11010
|
+
*/
|
|
11011
|
+
enabled: boolean;
|
|
11012
|
+
/**
|
|
11013
|
+
* Number of configured replicas.
|
|
11014
|
+
*/
|
|
11015
|
+
replicaCount: number;
|
|
11016
|
+
/**
|
|
11017
|
+
* Replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm).
|
|
11018
|
+
*/
|
|
11019
|
+
syncMode: string;
|
|
11020
|
+
/**
|
|
11021
|
+
* List of replica statuses.
|
|
11022
|
+
*/
|
|
11023
|
+
replicas: DedicatedDatabaseHAReplica[];
|
|
11024
|
+
};
|
|
11025
|
+
/**
|
|
11026
|
+
* Invoice
|
|
11027
|
+
*/
|
|
11028
|
+
export type Invoice = {
|
|
11029
|
+
/**
|
|
11030
|
+
* Invoice ID.
|
|
11031
|
+
*/
|
|
11032
|
+
$id: string;
|
|
11033
|
+
/**
|
|
11034
|
+
* Invoice creation time in ISO 8601 format.
|
|
11035
|
+
*/
|
|
11036
|
+
$createdAt: string;
|
|
11037
|
+
/**
|
|
11038
|
+
* Invoice update date in ISO 8601 format.
|
|
11039
|
+
*/
|
|
11040
|
+
$updatedAt: string;
|
|
11041
|
+
/**
|
|
11042
|
+
* Invoice permissions. [Learn more about permissions](/docs/permissions).
|
|
11043
|
+
*/
|
|
11044
|
+
$permissions: string[];
|
|
11045
|
+
/**
|
|
11046
|
+
* Project ID
|
|
11047
|
+
*/
|
|
11048
|
+
teamId: string;
|
|
11049
|
+
/**
|
|
11050
|
+
* Aggregation ID
|
|
11051
|
+
*/
|
|
11052
|
+
aggregationId: string;
|
|
11053
|
+
/**
|
|
11054
|
+
* Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.
|
|
11055
|
+
*/
|
|
11056
|
+
plan: string;
|
|
11057
|
+
/**
|
|
11058
|
+
* Usage breakdown per resource
|
|
11059
|
+
*/
|
|
11060
|
+
usage: UsageResources[];
|
|
11061
|
+
/**
|
|
11062
|
+
* Invoice Amount
|
|
11063
|
+
*/
|
|
11064
|
+
amount: number;
|
|
11065
|
+
/**
|
|
11066
|
+
* Tax percentage
|
|
11067
|
+
*/
|
|
11068
|
+
tax: number;
|
|
11069
|
+
/**
|
|
11070
|
+
* Tax amount
|
|
11071
|
+
*/
|
|
11072
|
+
taxAmount: number;
|
|
11073
|
+
/**
|
|
11074
|
+
* VAT percentage
|
|
11075
|
+
*/
|
|
11076
|
+
vat: number;
|
|
11077
|
+
/**
|
|
11078
|
+
* VAT amount
|
|
11079
|
+
*/
|
|
11080
|
+
vatAmount: number;
|
|
11081
|
+
/**
|
|
11082
|
+
* Gross amount after vat, tax, and discounts applied.
|
|
11083
|
+
*/
|
|
11084
|
+
grossAmount: number;
|
|
11085
|
+
/**
|
|
11086
|
+
* Credits used.
|
|
11087
|
+
*/
|
|
11088
|
+
creditsUsed: number;
|
|
11089
|
+
/**
|
|
11090
|
+
* Currency the invoice is in
|
|
11091
|
+
*/
|
|
11092
|
+
currency: string;
|
|
11093
|
+
/**
|
|
11094
|
+
* Client secret for processing failed payments in front-end
|
|
11095
|
+
*/
|
|
11096
|
+
clientSecret: string;
|
|
11097
|
+
/**
|
|
11098
|
+
* Invoice status
|
|
11099
|
+
*/
|
|
11100
|
+
status: string;
|
|
11101
|
+
/**
|
|
11102
|
+
* Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.
|
|
11103
|
+
*/
|
|
11104
|
+
type: string;
|
|
11105
|
+
/**
|
|
11106
|
+
* Last payment error associated with the invoice
|
|
11107
|
+
*/
|
|
11108
|
+
lastError: string;
|
|
11109
|
+
/**
|
|
11110
|
+
* Invoice due date.
|
|
11111
|
+
*/
|
|
11112
|
+
dueAt: string;
|
|
11113
|
+
/**
|
|
11114
|
+
* Beginning date of the invoice
|
|
11115
|
+
*/
|
|
11116
|
+
from: string;
|
|
11117
|
+
/**
|
|
11118
|
+
* End date of the invoice
|
|
11119
|
+
*/
|
|
11120
|
+
to: string;
|
|
11121
|
+
};
|
|
11122
|
+
/**
|
|
11123
|
+
* Organization
|
|
11124
|
+
*/
|
|
11125
|
+
export type Organization<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
11126
|
+
/**
|
|
11127
|
+
* Team ID.
|
|
11128
|
+
*/
|
|
11129
|
+
$id: string;
|
|
11130
|
+
/**
|
|
11131
|
+
* Team creation date in ISO 8601 format.
|
|
11132
|
+
*/
|
|
11133
|
+
$createdAt: string;
|
|
11134
|
+
/**
|
|
11135
|
+
* Team update date in ISO 8601 format.
|
|
11136
|
+
*/
|
|
11137
|
+
$updatedAt: string;
|
|
11138
|
+
/**
|
|
11139
|
+
* Team name.
|
|
11140
|
+
*/
|
|
11141
|
+
name: string;
|
|
11142
|
+
/**
|
|
11143
|
+
* Total number of team members.
|
|
11144
|
+
*/
|
|
11145
|
+
total: number;
|
|
11146
|
+
/**
|
|
11147
|
+
* Team preferences as a key-value object
|
|
11148
|
+
*/
|
|
11149
|
+
prefs: Preferences;
|
|
11150
|
+
/**
|
|
11151
|
+
* Project budget limit
|
|
11152
|
+
*/
|
|
11153
|
+
billingBudget: number;
|
|
11154
|
+
/**
|
|
11155
|
+
* Project budget limit
|
|
11156
|
+
*/
|
|
11157
|
+
budgetAlerts: number[];
|
|
11158
|
+
/**
|
|
11159
|
+
* Organization's billing plan ID.
|
|
11160
|
+
*/
|
|
11161
|
+
billingPlan: string;
|
|
11162
|
+
/**
|
|
11163
|
+
* Organization's billing plan ID.
|
|
11164
|
+
*/
|
|
11165
|
+
billingPlanId: string;
|
|
11166
|
+
/**
|
|
11167
|
+
* Organization's billing plan.
|
|
11168
|
+
*/
|
|
11169
|
+
billingPlanDetails: BillingPlan;
|
|
11170
|
+
/**
|
|
11171
|
+
* Billing email set for the organization.
|
|
11172
|
+
*/
|
|
11173
|
+
billingEmail: string;
|
|
11174
|
+
/**
|
|
11175
|
+
* Billing cycle start date.
|
|
11176
|
+
*/
|
|
11177
|
+
billingStartDate: string;
|
|
11178
|
+
/**
|
|
11179
|
+
* Current invoice cycle start date.
|
|
11180
|
+
*/
|
|
11181
|
+
billingCurrentInvoiceDate: string;
|
|
11182
|
+
/**
|
|
11183
|
+
* Next invoice cycle start date.
|
|
11184
|
+
*/
|
|
11185
|
+
billingNextInvoiceDate: string;
|
|
11186
|
+
/**
|
|
11187
|
+
* Start date of trial.
|
|
11188
|
+
*/
|
|
11189
|
+
billingTrialStartDate: string;
|
|
11190
|
+
/**
|
|
11191
|
+
* Number of trial days.
|
|
11192
|
+
*/
|
|
11193
|
+
billingTrialDays: number;
|
|
11194
|
+
/**
|
|
11195
|
+
* Current active aggregation id.
|
|
11196
|
+
*/
|
|
11197
|
+
billingAggregationId: string;
|
|
11198
|
+
/**
|
|
11199
|
+
* Current active aggregation id.
|
|
11200
|
+
*/
|
|
11201
|
+
billingInvoiceId: string;
|
|
11202
|
+
/**
|
|
11203
|
+
* Default payment method.
|
|
11204
|
+
*/
|
|
11205
|
+
paymentMethodId: string;
|
|
11206
|
+
/**
|
|
11207
|
+
* Default payment method.
|
|
11208
|
+
*/
|
|
11209
|
+
billingAddressId: string;
|
|
11210
|
+
/**
|
|
11211
|
+
* Backup payment method.
|
|
11212
|
+
*/
|
|
11213
|
+
backupPaymentMethodId: string;
|
|
11214
|
+
/**
|
|
11215
|
+
* Team status.
|
|
11216
|
+
*/
|
|
11217
|
+
status: string;
|
|
11218
|
+
/**
|
|
11219
|
+
* Remarks on team status.
|
|
11220
|
+
*/
|
|
11221
|
+
remarks: string;
|
|
11222
|
+
/**
|
|
11223
|
+
* Organization agreements
|
|
11224
|
+
*/
|
|
11225
|
+
agreementBAA: string;
|
|
11226
|
+
/**
|
|
11227
|
+
* Program manager's name.
|
|
11228
|
+
*/
|
|
11229
|
+
programManagerName: string;
|
|
11230
|
+
/**
|
|
11231
|
+
* Program manager's calendar link.
|
|
11232
|
+
*/
|
|
11233
|
+
programManagerCalendar: string;
|
|
11234
|
+
/**
|
|
11235
|
+
* Program's discord channel name.
|
|
11236
|
+
*/
|
|
11237
|
+
programDiscordChannelName: string;
|
|
11238
|
+
/**
|
|
11239
|
+
* Program's discord channel URL.
|
|
11240
|
+
*/
|
|
11241
|
+
programDiscordChannelUrl: string;
|
|
11242
|
+
/**
|
|
11243
|
+
* Billing limits reached
|
|
11244
|
+
*/
|
|
11245
|
+
billingLimits?: BillingLimits;
|
|
11246
|
+
/**
|
|
11247
|
+
* Billing plan selected for downgrade.
|
|
11248
|
+
*/
|
|
11249
|
+
billingPlanDowngrade: string;
|
|
11250
|
+
/**
|
|
11251
|
+
* Tax Id
|
|
11252
|
+
*/
|
|
11253
|
+
billingTaxId: string;
|
|
11254
|
+
/**
|
|
11255
|
+
* Marked for deletion
|
|
11256
|
+
*/
|
|
11257
|
+
markedForDeletion: boolean;
|
|
11258
|
+
/**
|
|
11259
|
+
* Product with which the organization is associated (appwrite or imagine)
|
|
11260
|
+
*/
|
|
11261
|
+
platform: string;
|
|
11262
|
+
/**
|
|
11263
|
+
* Selected projects
|
|
11264
|
+
*/
|
|
11265
|
+
projects: string[];
|
|
11266
|
+
};
|
|
11267
|
+
/**
|
|
11268
|
+
* PaymentAuthentication
|
|
11269
|
+
*/
|
|
11270
|
+
export type PaymentAuthentication = {
|
|
11271
|
+
/**
|
|
11272
|
+
* Message for the end user to show on Console.
|
|
11273
|
+
*/
|
|
11274
|
+
message: string;
|
|
11275
|
+
/**
|
|
11276
|
+
* Stripe client secret to use for validation.
|
|
11277
|
+
*/
|
|
11278
|
+
clientSecret: string;
|
|
11279
|
+
/**
|
|
11280
|
+
* Organization ID for which the payment authentication is needed.
|
|
11281
|
+
*/
|
|
11282
|
+
organizationId: string;
|
|
11283
|
+
/**
|
|
11284
|
+
* Invoice ID against which the payment needs to be validated.
|
|
11285
|
+
*/
|
|
11286
|
+
invoiceId: string;
|
|
11287
|
+
/**
|
|
11288
|
+
* Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.
|
|
11289
|
+
*/
|
|
11290
|
+
addonId: string;
|
|
11291
|
+
};
|
|
11292
|
+
/**
|
|
11293
|
+
* paymentMethod
|
|
11294
|
+
*/
|
|
11295
|
+
export type PaymentMethod = {
|
|
11296
|
+
/**
|
|
11297
|
+
* Payment Method ID.
|
|
11298
|
+
*/
|
|
11299
|
+
$id: string;
|
|
11300
|
+
/**
|
|
11301
|
+
* Payment method creation time in ISO 8601 format.
|
|
11302
|
+
*/
|
|
11303
|
+
$createdAt: string;
|
|
11304
|
+
/**
|
|
11305
|
+
* Payment method update date in ISO 8601 format.
|
|
11306
|
+
*/
|
|
11307
|
+
$updatedAt: string;
|
|
11308
|
+
/**
|
|
11309
|
+
* Payment method permissions. [Learn more about permissions](/docs/permissions).
|
|
11310
|
+
*/
|
|
11311
|
+
$permissions: string[];
|
|
11312
|
+
/**
|
|
11313
|
+
* Payment method ID from the payment provider
|
|
11314
|
+
*/
|
|
11315
|
+
providerMethodId: string;
|
|
11316
|
+
/**
|
|
11317
|
+
* Client secret hash for payment setup
|
|
11318
|
+
*/
|
|
11319
|
+
clientSecret: string;
|
|
11320
|
+
/**
|
|
11321
|
+
* User ID from the payment provider.
|
|
11322
|
+
*/
|
|
11323
|
+
providerUserId: string;
|
|
11324
|
+
/**
|
|
11325
|
+
* ID of the Team.
|
|
11326
|
+
*/
|
|
11327
|
+
userId: string;
|
|
11328
|
+
/**
|
|
11329
|
+
* Expiry month of the payment method.
|
|
11330
|
+
*/
|
|
11331
|
+
expiryMonth: number;
|
|
11332
|
+
/**
|
|
11333
|
+
* Expiry year of the payment method.
|
|
11334
|
+
*/
|
|
11335
|
+
expiryYear: number;
|
|
11336
|
+
/**
|
|
11337
|
+
* Last 4 digit of the payment method
|
|
11338
|
+
*/
|
|
11339
|
+
last4: string;
|
|
11340
|
+
/**
|
|
11341
|
+
* Payment method brand
|
|
11342
|
+
*/
|
|
11343
|
+
brand: string;
|
|
11344
|
+
/**
|
|
11345
|
+
* Name of the owner
|
|
11346
|
+
*/
|
|
11347
|
+
name: string;
|
|
11348
|
+
/**
|
|
11349
|
+
* Mandate ID of the payment method
|
|
11350
|
+
*/
|
|
11351
|
+
mandateId: string;
|
|
11352
|
+
/**
|
|
11353
|
+
* Country of the payment method
|
|
11354
|
+
*/
|
|
11355
|
+
country: string;
|
|
11356
|
+
/**
|
|
11357
|
+
* State of the payment method
|
|
11358
|
+
*/
|
|
11359
|
+
state: string;
|
|
11360
|
+
/**
|
|
11361
|
+
* Last payment error associated with the payment method.
|
|
11362
|
+
*/
|
|
11363
|
+
lastError: string;
|
|
11364
|
+
/**
|
|
11365
|
+
* True when it's the default payment method.
|
|
11366
|
+
*/
|
|
11367
|
+
default: boolean;
|
|
11368
|
+
/**
|
|
11369
|
+
* True when payment method has expired.
|
|
11370
|
+
*/
|
|
11371
|
+
expired: boolean;
|
|
11372
|
+
/**
|
|
11373
|
+
* True when payment method has failed to process multiple times.
|
|
11374
|
+
*/
|
|
11375
|
+
failed: boolean;
|
|
11376
|
+
};
|
|
11377
|
+
/**
|
|
11378
|
+
* PerformanceInsights
|
|
11379
|
+
*/
|
|
11380
|
+
export type DedicatedDatabasePerformanceInsights = {
|
|
11381
|
+
/**
|
|
11382
|
+
* Top queries by total execution time.
|
|
11383
|
+
*/
|
|
11384
|
+
topQueries: DedicatedDatabasePerformanceInsightsQuery[];
|
|
11385
|
+
/**
|
|
11386
|
+
* Active wait events.
|
|
11387
|
+
*/
|
|
11388
|
+
waitEvents: DedicatedDatabasePerformanceInsightsWaitEvent[];
|
|
11389
|
+
/**
|
|
11390
|
+
* Total number of query calls.
|
|
11391
|
+
*/
|
|
11392
|
+
totalCalls: number;
|
|
11393
|
+
/**
|
|
11394
|
+
* Total query execution time in milliseconds.
|
|
11395
|
+
*/
|
|
11396
|
+
totalTimeMs: number;
|
|
11397
|
+
/**
|
|
11398
|
+
* Average query execution time in milliseconds.
|
|
11399
|
+
*/
|
|
11400
|
+
avgTimeMs: number;
|
|
11401
|
+
};
|
|
11402
|
+
/**
|
|
11403
|
+
* PerformanceInsightsQuery
|
|
11404
|
+
*/
|
|
11405
|
+
export type DedicatedDatabasePerformanceInsightsQuery = {
|
|
11406
|
+
/**
|
|
11407
|
+
* The SQL query text.
|
|
11408
|
+
*/
|
|
11409
|
+
query: string;
|
|
11410
|
+
/**
|
|
11411
|
+
* Number of times this query has been executed.
|
|
11412
|
+
*/
|
|
11413
|
+
calls: number;
|
|
11414
|
+
/**
|
|
11415
|
+
* Total execution time in milliseconds.
|
|
11416
|
+
*/
|
|
11417
|
+
totalTimeMs: number;
|
|
11418
|
+
/**
|
|
11419
|
+
* Mean execution time in milliseconds.
|
|
11420
|
+
*/
|
|
11421
|
+
meanTimeMs: number;
|
|
11422
|
+
/**
|
|
11423
|
+
* Total rows returned or affected.
|
|
11424
|
+
*/
|
|
11425
|
+
rows: number;
|
|
11426
|
+
};
|
|
11427
|
+
/**
|
|
11428
|
+
* PerformanceInsightsWaitEvent
|
|
11429
|
+
*/
|
|
11430
|
+
export type DedicatedDatabasePerformanceInsightsWaitEvent = {
|
|
11431
|
+
/**
|
|
11432
|
+
* Wait event name.
|
|
11433
|
+
*/
|
|
11434
|
+
event: string;
|
|
11435
|
+
/**
|
|
11436
|
+
* Wait event type or category.
|
|
11437
|
+
*/
|
|
11438
|
+
type: string;
|
|
11439
|
+
/**
|
|
11440
|
+
* Number of occurrences.
|
|
11441
|
+
*/
|
|
11442
|
+
count: number;
|
|
11443
|
+
/**
|
|
11444
|
+
* Total wait time in milliseconds.
|
|
11445
|
+
*/
|
|
11446
|
+
totalWaitMs: number;
|
|
11447
|
+
};
|
|
11448
|
+
/**
|
|
11449
|
+
* PITRWindows
|
|
11450
|
+
*/
|
|
11451
|
+
export type DedicatedDatabasePITRWindows = {
|
|
11452
|
+
/**
|
|
11453
|
+
* Earliest available recovery point.
|
|
11454
|
+
*/
|
|
11455
|
+
earliest: string;
|
|
11456
|
+
/**
|
|
11457
|
+
* Latest available recovery point.
|
|
11458
|
+
*/
|
|
11459
|
+
latest: string;
|
|
11460
|
+
};
|
|
11461
|
+
/**
|
|
11462
|
+
* PlanChangeEstimationDetails
|
|
11463
|
+
*/
|
|
11464
|
+
export type PlanChangeEstimationDetails = {
|
|
11465
|
+
/**
|
|
11466
|
+
* Currency code
|
|
11467
|
+
*/
|
|
11468
|
+
currency: string;
|
|
11469
|
+
/**
|
|
11470
|
+
* Gross amount after all discounts and credits
|
|
11471
|
+
*/
|
|
11472
|
+
grossAmount: number;
|
|
11473
|
+
/**
|
|
11474
|
+
* Credits applied from coupon
|
|
11475
|
+
*/
|
|
11476
|
+
credits: number;
|
|
11477
|
+
/**
|
|
11478
|
+
* Organization's existing credits applied
|
|
11479
|
+
*/
|
|
11480
|
+
organizationCredits: number;
|
|
11481
|
+
/**
|
|
11482
|
+
* Discount amount from prorated invoices
|
|
11483
|
+
*/
|
|
11484
|
+
discount: number;
|
|
11485
|
+
/**
|
|
11486
|
+
* Total amount before discounts and credits
|
|
11487
|
+
*/
|
|
11488
|
+
amount: number;
|
|
11489
|
+
/**
|
|
11490
|
+
* Next invoice date
|
|
11491
|
+
*/
|
|
11492
|
+
nextInvoiceDate: string;
|
|
11493
|
+
/**
|
|
11494
|
+
* Line items breakdown
|
|
11495
|
+
*/
|
|
11496
|
+
items: object;
|
|
11497
|
+
/**
|
|
11498
|
+
* Applied discounts breakdown
|
|
11499
|
+
*/
|
|
11500
|
+
discounts: object;
|
|
11501
|
+
};
|
|
11502
|
+
/**
|
|
11503
|
+
* PlanChangeLimits
|
|
11504
|
+
*/
|
|
11505
|
+
export type PlanChangeLimits = {
|
|
11506
|
+
/**
|
|
11507
|
+
* Total number of projects in the organization
|
|
11508
|
+
*/
|
|
11509
|
+
totalProjects: number;
|
|
10215
11510
|
/**
|
|
10216
|
-
*
|
|
11511
|
+
* Number of projects exceeding target plan limits
|
|
10217
11512
|
*/
|
|
10218
|
-
|
|
11513
|
+
nonCompliantProjects: number;
|
|
10219
11514
|
/**
|
|
10220
|
-
*
|
|
11515
|
+
* Whether the plan change is allowed
|
|
10221
11516
|
*/
|
|
10222
|
-
|
|
11517
|
+
canChangePlan: boolean;
|
|
10223
11518
|
/**
|
|
10224
|
-
*
|
|
11519
|
+
* Project compliance details
|
|
10225
11520
|
*/
|
|
10226
|
-
|
|
11521
|
+
projects: PlanChangeProjectCompliance[];
|
|
10227
11522
|
/**
|
|
10228
|
-
*
|
|
11523
|
+
* Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.
|
|
10229
11524
|
*/
|
|
10230
|
-
|
|
11525
|
+
unsupportedAddons: string[];
|
|
10231
11526
|
};
|
|
10232
11527
|
/**
|
|
10233
|
-
*
|
|
11528
|
+
* PlanChangeProjectCompliance
|
|
10234
11529
|
*/
|
|
10235
|
-
export type
|
|
11530
|
+
export type PlanChangeProjectCompliance = {
|
|
10236
11531
|
/**
|
|
10237
|
-
*
|
|
11532
|
+
* Project ID
|
|
10238
11533
|
*/
|
|
10239
11534
|
$id: string;
|
|
10240
11535
|
/**
|
|
10241
|
-
*
|
|
11536
|
+
* Project name
|
|
10242
11537
|
*/
|
|
10243
|
-
|
|
11538
|
+
name: string;
|
|
10244
11539
|
/**
|
|
10245
|
-
*
|
|
11540
|
+
* Whether the project complies with target plan limits
|
|
10246
11541
|
*/
|
|
10247
|
-
|
|
11542
|
+
isCompliant: boolean;
|
|
10248
11543
|
/**
|
|
10249
|
-
*
|
|
11544
|
+
* Resource compliance details
|
|
10250
11545
|
*/
|
|
10251
|
-
|
|
11546
|
+
resources: PlanChangeResourceCompliance[];
|
|
10252
11547
|
/**
|
|
10253
|
-
*
|
|
11548
|
+
* Failure reason when compliance could not be evaluated. Present only when the project DB or Regions API was unreachable; in that case `isCompliant` is false (fail closed) and `resources` is empty.
|
|
10254
11549
|
*/
|
|
10255
|
-
|
|
11550
|
+
error?: string;
|
|
11551
|
+
};
|
|
11552
|
+
/**
|
|
11553
|
+
* PlanChangeResourceCompliance
|
|
11554
|
+
*/
|
|
11555
|
+
export type PlanChangeResourceCompliance = {
|
|
10256
11556
|
/**
|
|
10257
|
-
*
|
|
11557
|
+
* Resource type
|
|
11558
|
+
*/
|
|
11559
|
+
type: string;
|
|
11560
|
+
/**
|
|
11561
|
+
* Current usage count
|
|
11562
|
+
*/
|
|
11563
|
+
currentUsage: number;
|
|
11564
|
+
/**
|
|
11565
|
+
* Allowed limit in target plan
|
|
11566
|
+
*/
|
|
11567
|
+
limit: number;
|
|
11568
|
+
/**
|
|
11569
|
+
* Compliance status
|
|
10258
11570
|
*/
|
|
10259
11571
|
status: string;
|
|
10260
11572
|
/**
|
|
10261
|
-
*
|
|
11573
|
+
* Number of resources exceeding the limit
|
|
10262
11574
|
*/
|
|
10263
|
-
|
|
11575
|
+
excess: number;
|
|
10264
11576
|
/**
|
|
10265
|
-
*
|
|
11577
|
+
* Suggestion for resolving the compliance issue
|
|
10266
11578
|
*/
|
|
10267
|
-
|
|
11579
|
+
resolutionHint: string;
|
|
11580
|
+
};
|
|
11581
|
+
/**
|
|
11582
|
+
* backup
|
|
11583
|
+
*/
|
|
11584
|
+
export type BackupPolicy = {
|
|
11585
|
+
/**
|
|
11586
|
+
* Backup policy ID.
|
|
11587
|
+
*/
|
|
11588
|
+
$id: string;
|
|
11589
|
+
/**
|
|
11590
|
+
* Backup policy name.
|
|
11591
|
+
*/
|
|
11592
|
+
name: string;
|
|
11593
|
+
/**
|
|
11594
|
+
* Policy creation date in ISO 8601 format.
|
|
11595
|
+
*/
|
|
11596
|
+
$createdAt: string;
|
|
11597
|
+
/**
|
|
11598
|
+
* Policy update date in ISO 8601 format.
|
|
11599
|
+
*/
|
|
11600
|
+
$updatedAt: string;
|
|
10268
11601
|
/**
|
|
10269
11602
|
* The services that are backed up by this policy.
|
|
10270
11603
|
*/
|
|
@@ -10274,449 +11607,485 @@ export declare namespace Models {
|
|
|
10274
11607
|
*/
|
|
10275
11608
|
resources: string[];
|
|
10276
11609
|
/**
|
|
10277
|
-
*
|
|
11610
|
+
* The resource ID to backup. Set only if this policy should backup a single resource.
|
|
10278
11611
|
*/
|
|
10279
|
-
|
|
10280
|
-
};
|
|
10281
|
-
/**
|
|
10282
|
-
* Review
|
|
10283
|
-
*/
|
|
10284
|
-
export type Review = {
|
|
11612
|
+
resourceId?: string;
|
|
10285
11613
|
/**
|
|
10286
|
-
*
|
|
11614
|
+
* The resource type to backup. Set only if this policy should backup a single resource.
|
|
10287
11615
|
*/
|
|
10288
|
-
|
|
11616
|
+
resourceType?: string;
|
|
10289
11617
|
/**
|
|
10290
|
-
*
|
|
11618
|
+
* How many days to keep the backup before it will be automatically deleted.
|
|
10291
11619
|
*/
|
|
10292
|
-
|
|
11620
|
+
retention: number;
|
|
10293
11621
|
/**
|
|
10294
|
-
*
|
|
11622
|
+
* Policy backup schedule in CRON format.
|
|
10295
11623
|
*/
|
|
10296
|
-
|
|
11624
|
+
schedule: string;
|
|
10297
11625
|
/**
|
|
10298
|
-
*
|
|
11626
|
+
* Is this policy enabled.
|
|
10299
11627
|
*/
|
|
10300
|
-
|
|
11628
|
+
enabled: boolean;
|
|
10301
11629
|
};
|
|
10302
11630
|
/**
|
|
10303
|
-
*
|
|
11631
|
+
* Policy Deny Aliased Email
|
|
10304
11632
|
*/
|
|
10305
|
-
export type
|
|
11633
|
+
export type PolicyDenyAliasedEmail = {
|
|
10306
11634
|
/**
|
|
10307
|
-
*
|
|
11635
|
+
* Policy ID.
|
|
10308
11636
|
*/
|
|
10309
|
-
|
|
11637
|
+
$id: string;
|
|
10310
11638
|
/**
|
|
10311
|
-
*
|
|
11639
|
+
* Whether the deny aliased email policy is enabled.
|
|
10312
11640
|
*/
|
|
10313
|
-
|
|
11641
|
+
enabled: boolean;
|
|
10314
11642
|
};
|
|
10315
11643
|
/**
|
|
10316
|
-
*
|
|
11644
|
+
* Policy Deny Disposable Email
|
|
10317
11645
|
*/
|
|
10318
|
-
export type
|
|
10319
|
-
/**
|
|
10320
|
-
* Aggregated stats for number of requests.
|
|
10321
|
-
*/
|
|
10322
|
-
bandwidth: Metric[];
|
|
11646
|
+
export type PolicyDenyDisposableEmail = {
|
|
10323
11647
|
/**
|
|
10324
|
-
*
|
|
11648
|
+
* Policy ID.
|
|
10325
11649
|
*/
|
|
10326
|
-
|
|
11650
|
+
$id: string;
|
|
10327
11651
|
/**
|
|
10328
|
-
*
|
|
11652
|
+
* Whether the deny disposable email policy is enabled.
|
|
10329
11653
|
*/
|
|
10330
|
-
|
|
11654
|
+
enabled: boolean;
|
|
11655
|
+
};
|
|
11656
|
+
/**
|
|
11657
|
+
* Policy Deny Free Email
|
|
11658
|
+
*/
|
|
11659
|
+
export type PolicyDenyFreeEmail = {
|
|
10331
11660
|
/**
|
|
10332
|
-
*
|
|
11661
|
+
* Policy ID.
|
|
10333
11662
|
*/
|
|
10334
|
-
|
|
11663
|
+
$id: string;
|
|
10335
11664
|
/**
|
|
10336
|
-
*
|
|
11665
|
+
* Whether the deny free email policy is enabled.
|
|
10337
11666
|
*/
|
|
10338
|
-
|
|
11667
|
+
enabled: boolean;
|
|
11668
|
+
};
|
|
11669
|
+
/**
|
|
11670
|
+
* PoolerConfig
|
|
11671
|
+
*/
|
|
11672
|
+
export type DedicatedDatabasePooler = {
|
|
10339
11673
|
/**
|
|
10340
|
-
*
|
|
11674
|
+
* Whether connection pooling is enabled.
|
|
10341
11675
|
*/
|
|
10342
|
-
|
|
11676
|
+
enabled: boolean;
|
|
10343
11677
|
/**
|
|
10344
|
-
*
|
|
11678
|
+
* Connection pool mode. Possible values: transaction (releases connections back to pool after each transaction), session (holds connections for the entire client session).
|
|
10345
11679
|
*/
|
|
10346
|
-
|
|
11680
|
+
mode: string;
|
|
10347
11681
|
/**
|
|
10348
|
-
*
|
|
11682
|
+
* Maximum number of pooled connections.
|
|
10349
11683
|
*/
|
|
10350
|
-
|
|
11684
|
+
maxConnections: number;
|
|
10351
11685
|
/**
|
|
10352
|
-
*
|
|
11686
|
+
* Default pool size per user.
|
|
10353
11687
|
*/
|
|
10354
|
-
|
|
11688
|
+
defaultPoolSize: number;
|
|
10355
11689
|
/**
|
|
10356
|
-
*
|
|
11690
|
+
* Pooler listening port.
|
|
10357
11691
|
*/
|
|
10358
|
-
|
|
11692
|
+
port: number;
|
|
10359
11693
|
/**
|
|
10360
|
-
*
|
|
11694
|
+
* Whether SELECTs are routed to HA replicas while writes and locked reads stay on the primary. Active only when HA is enabled.
|
|
10361
11695
|
*/
|
|
10362
|
-
|
|
11696
|
+
readWriteSplitting: boolean;
|
|
10363
11697
|
/**
|
|
10364
|
-
*
|
|
11698
|
+
* Effective CPU request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (5% of DB CPU, floor 100m) unless overridden.
|
|
10365
11699
|
*/
|
|
10366
|
-
|
|
11700
|
+
poolerCpuRequest: string;
|
|
10367
11701
|
/**
|
|
10368
|
-
*
|
|
11702
|
+
* Effective CPU limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (10% of DB CPU, floor 200m) unless overridden.
|
|
10369
11703
|
*/
|
|
10370
|
-
|
|
11704
|
+
poolerCpuLimit: string;
|
|
10371
11705
|
/**
|
|
10372
|
-
*
|
|
11706
|
+
* Effective memory request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (7.5% of DB memory, floor 64Mi) unless overridden.
|
|
10373
11707
|
*/
|
|
10374
|
-
|
|
11708
|
+
poolerMemoryRequest: string;
|
|
10375
11709
|
/**
|
|
10376
|
-
*
|
|
11710
|
+
* Effective memory limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (15% of DB memory, floor 128Mi) unless overridden.
|
|
10377
11711
|
*/
|
|
10378
|
-
|
|
11712
|
+
poolerMemoryLimit: string;
|
|
11713
|
+
};
|
|
11714
|
+
/**
|
|
11715
|
+
* Program
|
|
11716
|
+
*/
|
|
11717
|
+
export type Program = {
|
|
10379
11718
|
/**
|
|
10380
|
-
*
|
|
11719
|
+
* Program ID
|
|
10381
11720
|
*/
|
|
10382
|
-
|
|
11721
|
+
$id: string;
|
|
10383
11722
|
/**
|
|
10384
|
-
*
|
|
11723
|
+
* Program title
|
|
10385
11724
|
*/
|
|
10386
|
-
|
|
11725
|
+
title: string;
|
|
10387
11726
|
/**
|
|
10388
|
-
*
|
|
11727
|
+
* Program description
|
|
10389
11728
|
*/
|
|
10390
|
-
|
|
11729
|
+
description: string;
|
|
10391
11730
|
/**
|
|
10392
|
-
*
|
|
11731
|
+
* Program tag for highlighting on console
|
|
10393
11732
|
*/
|
|
10394
|
-
|
|
11733
|
+
tag: string;
|
|
10395
11734
|
/**
|
|
10396
|
-
*
|
|
11735
|
+
* Program icon for highlighting on console
|
|
10397
11736
|
*/
|
|
10398
|
-
|
|
11737
|
+
icon: string;
|
|
10399
11738
|
/**
|
|
10400
|
-
*
|
|
11739
|
+
* URL for more information on this program
|
|
10401
11740
|
*/
|
|
10402
|
-
|
|
11741
|
+
url: string;
|
|
10403
11742
|
/**
|
|
10404
|
-
*
|
|
11743
|
+
* Whether this program is active
|
|
10405
11744
|
*/
|
|
10406
|
-
|
|
11745
|
+
active: boolean;
|
|
10407
11746
|
/**
|
|
10408
|
-
*
|
|
11747
|
+
* Whether this program is external
|
|
10409
11748
|
*/
|
|
10410
|
-
|
|
11749
|
+
external: boolean;
|
|
10411
11750
|
/**
|
|
10412
|
-
*
|
|
11751
|
+
* Billing plan ID that this is program is associated with.
|
|
10413
11752
|
*/
|
|
10414
|
-
|
|
11753
|
+
billingPlanId: string;
|
|
11754
|
+
};
|
|
11755
|
+
/**
|
|
11756
|
+
* QueryExplanation
|
|
11757
|
+
*/
|
|
11758
|
+
export type DedicatedDatabaseQueryExplanation = {
|
|
10415
11759
|
/**
|
|
10416
|
-
*
|
|
11760
|
+
* Structured query execution plan. Contents are engine-specific.
|
|
10417
11761
|
*/
|
|
10418
|
-
|
|
11762
|
+
plan: Record<string, any>[];
|
|
10419
11763
|
/**
|
|
10420
|
-
*
|
|
11764
|
+
* Raw EXPLAIN output from the database engine.
|
|
10421
11765
|
*/
|
|
10422
|
-
|
|
11766
|
+
raw: string;
|
|
11767
|
+
};
|
|
11768
|
+
/**
|
|
11769
|
+
* Region
|
|
11770
|
+
*/
|
|
11771
|
+
export type ConsoleRegion = {
|
|
10423
11772
|
/**
|
|
10424
|
-
*
|
|
11773
|
+
* Region ID
|
|
10425
11774
|
*/
|
|
10426
|
-
|
|
11775
|
+
$id: string;
|
|
10427
11776
|
/**
|
|
10428
|
-
*
|
|
11777
|
+
* Region name
|
|
10429
11778
|
*/
|
|
10430
|
-
|
|
11779
|
+
name: string;
|
|
10431
11780
|
/**
|
|
10432
|
-
*
|
|
11781
|
+
* Does the organization have access to this region.
|
|
10433
11782
|
*/
|
|
10434
|
-
|
|
11783
|
+
available: boolean;
|
|
10435
11784
|
/**
|
|
10436
|
-
*
|
|
11785
|
+
* Does the backend support this region.
|
|
10437
11786
|
*/
|
|
10438
|
-
|
|
11787
|
+
disabled: boolean;
|
|
10439
11788
|
/**
|
|
10440
|
-
*
|
|
11789
|
+
* Is this the region default.
|
|
10441
11790
|
*/
|
|
10442
|
-
|
|
11791
|
+
default: boolean;
|
|
10443
11792
|
/**
|
|
10444
|
-
*
|
|
11793
|
+
* Region flag code.
|
|
10445
11794
|
*/
|
|
10446
|
-
|
|
11795
|
+
flag: string;
|
|
10447
11796
|
};
|
|
10448
11797
|
/**
|
|
10449
|
-
*
|
|
11798
|
+
* Restoration
|
|
10450
11799
|
*/
|
|
10451
|
-
export type
|
|
10452
|
-
/**
|
|
10453
|
-
* projectId
|
|
10454
|
-
*/
|
|
10455
|
-
projectId: string;
|
|
10456
|
-
/**
|
|
10457
|
-
* Aggregated stats for number of requests.
|
|
10458
|
-
*/
|
|
10459
|
-
bandwidth: Metric[];
|
|
11800
|
+
export type BackupRestoration = {
|
|
10460
11801
|
/**
|
|
10461
|
-
*
|
|
11802
|
+
* Restoration ID.
|
|
10462
11803
|
*/
|
|
10463
|
-
|
|
11804
|
+
$id: string;
|
|
10464
11805
|
/**
|
|
10465
|
-
*
|
|
11806
|
+
* Restoration creation time in ISO 8601 format.
|
|
10466
11807
|
*/
|
|
10467
|
-
|
|
11808
|
+
$createdAt: string;
|
|
10468
11809
|
/**
|
|
10469
|
-
*
|
|
11810
|
+
* Restoration update date in ISO 8601 format.
|
|
10470
11811
|
*/
|
|
10471
|
-
|
|
11812
|
+
$updatedAt: string;
|
|
10472
11813
|
/**
|
|
10473
|
-
*
|
|
11814
|
+
* Backup archive ID.
|
|
10474
11815
|
*/
|
|
10475
|
-
|
|
11816
|
+
archiveId: string;
|
|
10476
11817
|
/**
|
|
10477
|
-
*
|
|
11818
|
+
* Backup policy ID.
|
|
10478
11819
|
*/
|
|
10479
|
-
|
|
11820
|
+
policyId: string;
|
|
10480
11821
|
/**
|
|
10481
|
-
*
|
|
11822
|
+
* The status of the restoration. Possible values: pending, downloading, processing, completed, failed.
|
|
10482
11823
|
*/
|
|
10483
|
-
|
|
11824
|
+
status: string;
|
|
10484
11825
|
/**
|
|
10485
|
-
*
|
|
11826
|
+
* The backup start time.
|
|
10486
11827
|
*/
|
|
10487
|
-
|
|
11828
|
+
startedAt: string;
|
|
10488
11829
|
/**
|
|
10489
|
-
*
|
|
11830
|
+
* Migration ID.
|
|
10490
11831
|
*/
|
|
10491
|
-
|
|
11832
|
+
migrationId: string;
|
|
10492
11833
|
/**
|
|
10493
|
-
*
|
|
11834
|
+
* The services that are backed up by this policy.
|
|
10494
11835
|
*/
|
|
10495
|
-
|
|
11836
|
+
services: string[];
|
|
10496
11837
|
/**
|
|
10497
|
-
*
|
|
11838
|
+
* The resources that are backed up by this policy.
|
|
10498
11839
|
*/
|
|
10499
|
-
|
|
11840
|
+
resources: string[];
|
|
10500
11841
|
/**
|
|
10501
|
-
*
|
|
11842
|
+
* Optional data in key-value object.
|
|
10502
11843
|
*/
|
|
10503
|
-
|
|
11844
|
+
options: string;
|
|
11845
|
+
};
|
|
11846
|
+
/**
|
|
11847
|
+
* Dedicated database restorations list
|
|
11848
|
+
*/
|
|
11849
|
+
export type DedicatedDatabaseRestorationList = {
|
|
10504
11850
|
/**
|
|
10505
|
-
*
|
|
11851
|
+
* Total number of restorations that matched your query.
|
|
10506
11852
|
*/
|
|
10507
|
-
|
|
11853
|
+
total: number;
|
|
10508
11854
|
/**
|
|
10509
|
-
*
|
|
11855
|
+
* List of restorations.
|
|
10510
11856
|
*/
|
|
10511
|
-
|
|
11857
|
+
restorations: DedicatedDatabaseRestoration[];
|
|
11858
|
+
};
|
|
11859
|
+
/**
|
|
11860
|
+
* Review
|
|
11861
|
+
*/
|
|
11862
|
+
export type Review = {
|
|
10512
11863
|
/**
|
|
10513
|
-
*
|
|
11864
|
+
* Name of user
|
|
10514
11865
|
*/
|
|
10515
|
-
|
|
11866
|
+
name: string;
|
|
10516
11867
|
/**
|
|
10517
|
-
*
|
|
11868
|
+
* Reviewer image
|
|
10518
11869
|
*/
|
|
10519
|
-
|
|
11870
|
+
image: string;
|
|
10520
11871
|
/**
|
|
10521
|
-
*
|
|
11872
|
+
* Reviewer description
|
|
10522
11873
|
*/
|
|
10523
|
-
|
|
11874
|
+
description: string;
|
|
10524
11875
|
/**
|
|
10525
|
-
*
|
|
11876
|
+
* Review
|
|
10526
11877
|
*/
|
|
10527
|
-
|
|
11878
|
+
review: string;
|
|
11879
|
+
};
|
|
11880
|
+
/**
|
|
11881
|
+
* Roles
|
|
11882
|
+
*/
|
|
11883
|
+
export type Roles = {
|
|
10528
11884
|
/**
|
|
10529
|
-
*
|
|
11885
|
+
* Array of scopes accessible to current user.
|
|
10530
11886
|
*/
|
|
10531
|
-
|
|
11887
|
+
scopes: string[];
|
|
10532
11888
|
/**
|
|
10533
|
-
*
|
|
11889
|
+
* Array of roles assigned to current user.
|
|
10534
11890
|
*/
|
|
10535
|
-
|
|
11891
|
+
roles: string[];
|
|
10536
11892
|
};
|
|
10537
11893
|
/**
|
|
10538
|
-
*
|
|
11894
|
+
* Schema
|
|
10539
11895
|
*/
|
|
10540
|
-
export type
|
|
10541
|
-
/**
|
|
10542
|
-
* Domain ID.
|
|
10543
|
-
*/
|
|
10544
|
-
$id: string;
|
|
11896
|
+
export type DedicatedDatabaseSchema = {
|
|
10545
11897
|
/**
|
|
10546
|
-
*
|
|
11898
|
+
* List of tables with columns, types, and constraints.
|
|
10547
11899
|
*/
|
|
10548
|
-
|
|
11900
|
+
tables: Record<string, any>[];
|
|
10549
11901
|
/**
|
|
10550
|
-
*
|
|
11902
|
+
* List of indexes across all tables.
|
|
10551
11903
|
*/
|
|
10552
|
-
|
|
11904
|
+
indexes: Record<string, any>[];
|
|
11905
|
+
};
|
|
11906
|
+
/**
|
|
11907
|
+
* SchemaPreview
|
|
11908
|
+
*/
|
|
11909
|
+
export type DedicatedDatabaseSchemaPreview = {
|
|
10553
11910
|
/**
|
|
10554
|
-
*
|
|
11911
|
+
* Whether the engine supports transactional DDL for safe preview.
|
|
10555
11912
|
*/
|
|
10556
|
-
|
|
11913
|
+
supportsTransactionalDDL: boolean;
|
|
10557
11914
|
/**
|
|
10558
|
-
*
|
|
11915
|
+
* Schema change preview output.
|
|
10559
11916
|
*/
|
|
10560
|
-
|
|
11917
|
+
preview: string;
|
|
10561
11918
|
/**
|
|
10562
|
-
*
|
|
11919
|
+
* List of tables in the database after the change.
|
|
10563
11920
|
*/
|
|
10564
|
-
|
|
11921
|
+
tables: string[];
|
|
11922
|
+
};
|
|
11923
|
+
/**
|
|
11924
|
+
* SlowQuery
|
|
11925
|
+
*/
|
|
11926
|
+
export type DedicatedDatabaseSlowQuery = {
|
|
10565
11927
|
/**
|
|
10566
|
-
*
|
|
11928
|
+
* The SQL query text.
|
|
10567
11929
|
*/
|
|
10568
|
-
|
|
11930
|
+
query: string;
|
|
10569
11931
|
/**
|
|
10570
|
-
*
|
|
11932
|
+
* Query duration in milliseconds.
|
|
10571
11933
|
*/
|
|
10572
|
-
|
|
11934
|
+
durationMs: number;
|
|
10573
11935
|
/**
|
|
10574
|
-
*
|
|
11936
|
+
* Number of times this query has been executed.
|
|
10575
11937
|
*/
|
|
10576
|
-
|
|
11938
|
+
calls: number;
|
|
10577
11939
|
/**
|
|
10578
|
-
*
|
|
11940
|
+
* Database user that executed the query.
|
|
10579
11941
|
*/
|
|
10580
|
-
|
|
11942
|
+
user: string;
|
|
10581
11943
|
/**
|
|
10582
|
-
*
|
|
11944
|
+
* Database name.
|
|
10583
11945
|
*/
|
|
10584
|
-
|
|
11946
|
+
database: string;
|
|
11947
|
+
};
|
|
11948
|
+
/**
|
|
11949
|
+
* Specification
|
|
11950
|
+
*/
|
|
11951
|
+
export type DedicatedDatabaseSpecification = {
|
|
10585
11952
|
/**
|
|
10586
|
-
*
|
|
11953
|
+
* Specification slug. Use this value when creating a dedicated database.
|
|
10587
11954
|
*/
|
|
10588
|
-
|
|
11955
|
+
slug: string;
|
|
10589
11956
|
/**
|
|
10590
|
-
*
|
|
11957
|
+
* Human readable specification name.
|
|
10591
11958
|
*/
|
|
10592
|
-
|
|
10593
|
-
};
|
|
10594
|
-
/**
|
|
10595
|
-
* DomainPurchase
|
|
10596
|
-
*/
|
|
10597
|
-
export type DomainPurchase = {
|
|
11959
|
+
name: string;
|
|
10598
11960
|
/**
|
|
10599
|
-
*
|
|
11961
|
+
* Monthly price of the specification in USD.
|
|
10600
11962
|
*/
|
|
10601
|
-
|
|
11963
|
+
price: number;
|
|
10602
11964
|
/**
|
|
10603
|
-
*
|
|
11965
|
+
* Allocated CPU in millicores.
|
|
10604
11966
|
*/
|
|
10605
|
-
|
|
11967
|
+
cpu: number;
|
|
10606
11968
|
/**
|
|
10607
|
-
*
|
|
11969
|
+
* Allocated memory in MB.
|
|
10608
11970
|
*/
|
|
10609
|
-
|
|
11971
|
+
memory: number;
|
|
10610
11972
|
/**
|
|
10611
|
-
*
|
|
11973
|
+
* Maximum number of concurrent connections.
|
|
10612
11974
|
*/
|
|
10613
|
-
|
|
11975
|
+
maxConnections: number;
|
|
10614
11976
|
/**
|
|
10615
|
-
*
|
|
11977
|
+
* Included storage in GB before overage charges apply.
|
|
10616
11978
|
*/
|
|
10617
|
-
|
|
11979
|
+
includedStorage: number;
|
|
10618
11980
|
/**
|
|
10619
|
-
*
|
|
11981
|
+
* Included bandwidth in GB before overage charges apply.
|
|
10620
11982
|
*/
|
|
10621
|
-
|
|
11983
|
+
includedBandwidth: number;
|
|
10622
11984
|
/**
|
|
10623
|
-
*
|
|
11985
|
+
* Whether the specification is available on the current plan.
|
|
10624
11986
|
*/
|
|
10625
|
-
|
|
11987
|
+
enabled: boolean;
|
|
11988
|
+
};
|
|
11989
|
+
/**
|
|
11990
|
+
* SpecificationList
|
|
11991
|
+
*/
|
|
11992
|
+
export type DedicatedDatabaseSpecificationList = {
|
|
10626
11993
|
/**
|
|
10627
|
-
*
|
|
11994
|
+
* List of dedicated database specifications.
|
|
10628
11995
|
*/
|
|
10629
|
-
|
|
11996
|
+
specifications: DedicatedDatabaseSpecification[];
|
|
10630
11997
|
/**
|
|
10631
|
-
*
|
|
11998
|
+
* Total number of specifications.
|
|
10632
11999
|
*/
|
|
10633
|
-
|
|
12000
|
+
total: number;
|
|
10634
12001
|
/**
|
|
10635
|
-
*
|
|
12002
|
+
* Overage and add-on pricing shared across all specifications.
|
|
10636
12003
|
*/
|
|
10637
|
-
|
|
12004
|
+
pricing: DedicatedDatabaseSpecificationPricing;
|
|
10638
12005
|
};
|
|
10639
12006
|
/**
|
|
10640
|
-
*
|
|
12007
|
+
* SpecificationPricing
|
|
10641
12008
|
*/
|
|
10642
|
-
export type
|
|
12009
|
+
export type DedicatedDatabaseSpecificationPricing = {
|
|
10643
12010
|
/**
|
|
10644
|
-
*
|
|
12011
|
+
* Price per GB of storage above the included amount, per month, in USD.
|
|
10645
12012
|
*/
|
|
10646
|
-
|
|
12013
|
+
storageOverageRate: number;
|
|
10647
12014
|
/**
|
|
10648
|
-
*
|
|
12015
|
+
* Price per GB of bandwidth above the included amount, per month, in USD.
|
|
10649
12016
|
*/
|
|
10650
|
-
|
|
12017
|
+
bandwidthOverageRate: number;
|
|
10651
12018
|
/**
|
|
10652
|
-
*
|
|
12019
|
+
* High availability replica price as a fraction of the specification cost.
|
|
10653
12020
|
*/
|
|
10654
|
-
|
|
12021
|
+
haReplicaRate: number;
|
|
10655
12022
|
/**
|
|
10656
|
-
*
|
|
12023
|
+
* Cross-region replica price as a fraction of the specification cost.
|
|
10657
12024
|
*/
|
|
10658
|
-
|
|
12025
|
+
crossRegionReplicaRate: number;
|
|
10659
12026
|
/**
|
|
10660
|
-
*
|
|
12027
|
+
* Cross-region transfer price as a fraction of the specification cost.
|
|
10661
12028
|
*/
|
|
10662
|
-
|
|
12029
|
+
crossRegionRate: number;
|
|
10663
12030
|
/**
|
|
10664
|
-
*
|
|
12031
|
+
* Point-in-time recovery price as a fraction of the specification cost.
|
|
10665
12032
|
*/
|
|
10666
|
-
|
|
12033
|
+
pitrRate: number;
|
|
12034
|
+
};
|
|
12035
|
+
/**
|
|
12036
|
+
* Connections
|
|
12037
|
+
*/
|
|
12038
|
+
export type DatabaseStatusConnections = {
|
|
10667
12039
|
/**
|
|
10668
|
-
*
|
|
12040
|
+
* Current number of active connections.
|
|
10669
12041
|
*/
|
|
10670
|
-
|
|
12042
|
+
current: number;
|
|
10671
12043
|
/**
|
|
10672
|
-
*
|
|
12044
|
+
* Maximum allowed connections.
|
|
10673
12045
|
*/
|
|
10674
|
-
|
|
12046
|
+
max: number;
|
|
12047
|
+
};
|
|
12048
|
+
/**
|
|
12049
|
+
* Replica
|
|
12050
|
+
*/
|
|
12051
|
+
export type DatabaseStatusReplica = {
|
|
10675
12052
|
/**
|
|
10676
|
-
*
|
|
12053
|
+
* StatefulSet pod index (0 = primary, 1+ = replicas).
|
|
10677
12054
|
*/
|
|
10678
|
-
|
|
12055
|
+
index: number;
|
|
10679
12056
|
/**
|
|
10680
|
-
*
|
|
12057
|
+
* Replica role: primary or replica.
|
|
10681
12058
|
*/
|
|
10682
|
-
|
|
12059
|
+
role: string;
|
|
10683
12060
|
/**
|
|
10684
|
-
*
|
|
12061
|
+
* Whether the replica is healthy.
|
|
10685
12062
|
*/
|
|
10686
|
-
|
|
12063
|
+
healthy: boolean;
|
|
10687
12064
|
/**
|
|
10688
|
-
*
|
|
12065
|
+
* Replication lag in seconds (null for primary).
|
|
10689
12066
|
*/
|
|
10690
|
-
|
|
12067
|
+
lagSeconds?: number;
|
|
10691
12068
|
};
|
|
10692
12069
|
/**
|
|
10693
|
-
*
|
|
12070
|
+
* Volume
|
|
10694
12071
|
*/
|
|
10695
|
-
export type
|
|
10696
|
-
/**
|
|
10697
|
-
* Invoice name
|
|
10698
|
-
*/
|
|
10699
|
-
name: string;
|
|
12072
|
+
export type DatabaseStatusVolume = {
|
|
10700
12073
|
/**
|
|
10701
|
-
*
|
|
10702
|
-
*/
|
|
10703
|
-
value: number;
|
|
10704
|
-
/**
|
|
10705
|
-
* Invoice amount
|
|
12074
|
+
* Mount path of the volume.
|
|
10706
12075
|
*/
|
|
10707
|
-
|
|
12076
|
+
path: string;
|
|
10708
12077
|
/**
|
|
10709
|
-
*
|
|
12078
|
+
* Percentage of storage used.
|
|
10710
12079
|
*/
|
|
10711
|
-
|
|
12080
|
+
usedPercent: string;
|
|
10712
12081
|
/**
|
|
10713
|
-
*
|
|
12082
|
+
* Available storage space.
|
|
10714
12083
|
*/
|
|
10715
|
-
|
|
12084
|
+
available: string;
|
|
10716
12085
|
/**
|
|
10717
|
-
*
|
|
12086
|
+
* Whether the volume is mounted.
|
|
10718
12087
|
*/
|
|
10719
|
-
|
|
12088
|
+
mounted: boolean;
|
|
10720
12089
|
};
|
|
10721
12090
|
/**
|
|
10722
12091
|
* usageBillingPlan
|
|
@@ -10768,420 +12137,448 @@ export declare namespace Models {
|
|
|
10768
12137
|
credits: AdditionalResource;
|
|
10769
12138
|
};
|
|
10770
12139
|
/**
|
|
10771
|
-
*
|
|
12140
|
+
* usageEvent
|
|
10772
12141
|
*/
|
|
10773
|
-
export type
|
|
12142
|
+
export type UsageEvent = {
|
|
10774
12143
|
/**
|
|
10775
|
-
*
|
|
12144
|
+
* The metric key.
|
|
10776
12145
|
*/
|
|
10777
|
-
|
|
12146
|
+
metric: string;
|
|
10778
12147
|
/**
|
|
10779
|
-
*
|
|
12148
|
+
* The metric value.
|
|
10780
12149
|
*/
|
|
10781
|
-
|
|
12150
|
+
value: number;
|
|
10782
12151
|
/**
|
|
10783
|
-
*
|
|
12152
|
+
* The event timestamp.
|
|
10784
12153
|
*/
|
|
10785
|
-
|
|
12154
|
+
time: string;
|
|
12155
|
+
/**
|
|
12156
|
+
* The API endpoint path.
|
|
12157
|
+
*/
|
|
12158
|
+
path: string;
|
|
12159
|
+
/**
|
|
12160
|
+
* The HTTP method.
|
|
12161
|
+
*/
|
|
12162
|
+
method: string;
|
|
12163
|
+
/**
|
|
12164
|
+
* HTTP status code. Stored as string to preserve unset state (empty string = not available).
|
|
12165
|
+
*/
|
|
12166
|
+
status: string;
|
|
12167
|
+
/**
|
|
12168
|
+
* The resource type.
|
|
12169
|
+
*/
|
|
12170
|
+
resourceType: string;
|
|
12171
|
+
/**
|
|
12172
|
+
* The resource ID.
|
|
12173
|
+
*/
|
|
12174
|
+
resourceId: string;
|
|
12175
|
+
/**
|
|
12176
|
+
* Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format.
|
|
12177
|
+
*/
|
|
12178
|
+
countryCode: string;
|
|
12179
|
+
/**
|
|
12180
|
+
* The user agent string.
|
|
12181
|
+
*/
|
|
12182
|
+
userAgent: string;
|
|
12183
|
+
};
|
|
12184
|
+
/**
|
|
12185
|
+
* usageGauge
|
|
12186
|
+
*/
|
|
12187
|
+
export type UsageGauge = {
|
|
12188
|
+
/**
|
|
12189
|
+
* The metric key.
|
|
12190
|
+
*/
|
|
12191
|
+
metric: string;
|
|
12192
|
+
/**
|
|
12193
|
+
* The current snapshot value.
|
|
12194
|
+
*/
|
|
12195
|
+
value: number;
|
|
12196
|
+
/**
|
|
12197
|
+
* The snapshot timestamp.
|
|
12198
|
+
*/
|
|
12199
|
+
time: string;
|
|
12200
|
+
/**
|
|
12201
|
+
* The resource type.
|
|
12202
|
+
*/
|
|
12203
|
+
resourceType: string;
|
|
10786
12204
|
/**
|
|
10787
|
-
*
|
|
12205
|
+
* The resource ID.
|
|
10788
12206
|
*/
|
|
10789
|
-
|
|
12207
|
+
resourceId: string;
|
|
12208
|
+
};
|
|
12209
|
+
/**
|
|
12210
|
+
* Organization
|
|
12211
|
+
*/
|
|
12212
|
+
export type UsageOrganization = {
|
|
10790
12213
|
/**
|
|
10791
|
-
*
|
|
12214
|
+
* Aggregated stats for number of requests.
|
|
10792
12215
|
*/
|
|
10793
|
-
|
|
12216
|
+
bandwidth: Metric[];
|
|
10794
12217
|
/**
|
|
10795
|
-
*
|
|
12218
|
+
* Aggregated stats for consumed bandwidth.
|
|
10796
12219
|
*/
|
|
10797
|
-
|
|
12220
|
+
users: Metric[];
|
|
10798
12221
|
/**
|
|
10799
|
-
*
|
|
12222
|
+
* Aggregated stats for function executions.
|
|
10800
12223
|
*/
|
|
10801
|
-
|
|
12224
|
+
executions: Metric[];
|
|
10802
12225
|
/**
|
|
10803
|
-
*
|
|
12226
|
+
* Aggregated stats for database reads.
|
|
10804
12227
|
*/
|
|
10805
|
-
|
|
10806
|
-
};
|
|
10807
|
-
/**
|
|
10808
|
-
* EstimationUpdatePlan
|
|
10809
|
-
*/
|
|
10810
|
-
export type EstimationUpdatePlan = {
|
|
12228
|
+
databasesReads: Metric[];
|
|
10811
12229
|
/**
|
|
10812
|
-
*
|
|
12230
|
+
* Aggregated stats for database writes.
|
|
10813
12231
|
*/
|
|
10814
|
-
|
|
12232
|
+
databasesWrites: Metric[];
|
|
10815
12233
|
/**
|
|
10816
|
-
*
|
|
12234
|
+
* Aggregated stats for file transformations.
|
|
10817
12235
|
*/
|
|
10818
|
-
|
|
12236
|
+
imageTransformations: Metric[];
|
|
10819
12237
|
/**
|
|
10820
|
-
*
|
|
12238
|
+
* Aggregated stats for total file transformations.
|
|
10821
12239
|
*/
|
|
10822
|
-
|
|
12240
|
+
imageTransformationsTotal: number;
|
|
10823
12241
|
/**
|
|
10824
|
-
*
|
|
12242
|
+
* Aggregated stats for file transformations.
|
|
10825
12243
|
*/
|
|
10826
|
-
|
|
12244
|
+
screenshotsGenerated: Metric[];
|
|
10827
12245
|
/**
|
|
10828
|
-
*
|
|
12246
|
+
* Aggregated stats for total file transformations.
|
|
10829
12247
|
*/
|
|
10830
|
-
|
|
12248
|
+
screenshotsGeneratedTotal: number;
|
|
10831
12249
|
/**
|
|
10832
|
-
*
|
|
12250
|
+
* Aggregated stats for imagine credits.
|
|
10833
12251
|
*/
|
|
10834
|
-
|
|
12252
|
+
imagineCredits: Metric[];
|
|
10835
12253
|
/**
|
|
10836
|
-
*
|
|
12254
|
+
* Aggregated stats for total imagine credits.
|
|
10837
12255
|
*/
|
|
10838
|
-
|
|
12256
|
+
imagineCreditsTotal: number;
|
|
10839
12257
|
/**
|
|
10840
|
-
*
|
|
12258
|
+
* Aggregated stats for total users.
|
|
10841
12259
|
*/
|
|
10842
|
-
|
|
12260
|
+
usersTotal: number;
|
|
10843
12261
|
/**
|
|
10844
|
-
*
|
|
12262
|
+
* Aggregated stats for total executions.
|
|
10845
12263
|
*/
|
|
10846
|
-
|
|
10847
|
-
};
|
|
10848
|
-
/**
|
|
10849
|
-
* EstimationPlanChange
|
|
10850
|
-
*/
|
|
10851
|
-
export type EstimationPlanChange = {
|
|
12264
|
+
executionsTotal: number;
|
|
10852
12265
|
/**
|
|
10853
|
-
*
|
|
12266
|
+
* Aggregated stats for function executions in mb seconds.
|
|
10854
12267
|
*/
|
|
10855
|
-
|
|
12268
|
+
executionsMBSecondsTotal: number;
|
|
10856
12269
|
/**
|
|
10857
|
-
*
|
|
12270
|
+
* Aggregated stats for function builds in mb seconds.
|
|
10858
12271
|
*/
|
|
10859
|
-
|
|
12272
|
+
buildsMBSecondsTotal: number;
|
|
10860
12273
|
/**
|
|
10861
|
-
*
|
|
12274
|
+
* Aggregated stats for total file storage.
|
|
10862
12275
|
*/
|
|
10863
|
-
|
|
12276
|
+
filesStorageTotal: number;
|
|
10864
12277
|
/**
|
|
10865
|
-
*
|
|
12278
|
+
* Aggregated stats for total builds storage.
|
|
10866
12279
|
*/
|
|
10867
|
-
|
|
12280
|
+
buildsStorageTotal: number;
|
|
10868
12281
|
/**
|
|
10869
|
-
*
|
|
12282
|
+
* Aggregated stats for total deployments storage.
|
|
10870
12283
|
*/
|
|
10871
|
-
|
|
10872
|
-
};
|
|
10873
|
-
/**
|
|
10874
|
-
* PlanChangeEstimationDetails
|
|
10875
|
-
*/
|
|
10876
|
-
export type PlanChangeEstimationDetails = {
|
|
12284
|
+
deploymentsStorageTotal: number;
|
|
10877
12285
|
/**
|
|
10878
|
-
*
|
|
12286
|
+
* Aggregated stats for total databases storage.
|
|
10879
12287
|
*/
|
|
10880
|
-
|
|
12288
|
+
databasesStorageTotal: number;
|
|
10881
12289
|
/**
|
|
10882
|
-
*
|
|
12290
|
+
* Aggregated stats for total databases reads.
|
|
10883
12291
|
*/
|
|
10884
|
-
|
|
12292
|
+
databasesReadsTotal: number;
|
|
10885
12293
|
/**
|
|
10886
|
-
*
|
|
12294
|
+
* Aggregated stats for total databases writes.
|
|
10887
12295
|
*/
|
|
10888
|
-
|
|
12296
|
+
databasesWritesTotal: number;
|
|
10889
12297
|
/**
|
|
10890
|
-
*
|
|
12298
|
+
* Aggregated stats for total backups storage.
|
|
10891
12299
|
*/
|
|
10892
|
-
|
|
12300
|
+
backupsStorageTotal: number;
|
|
10893
12301
|
/**
|
|
10894
|
-
*
|
|
12302
|
+
* Aggregated stats for total storage.
|
|
10895
12303
|
*/
|
|
10896
|
-
|
|
12304
|
+
storageTotal: number;
|
|
10897
12305
|
/**
|
|
10898
|
-
*
|
|
12306
|
+
* Aggregated stats for total auth phone.
|
|
10899
12307
|
*/
|
|
10900
|
-
|
|
12308
|
+
authPhoneTotal: number;
|
|
10901
12309
|
/**
|
|
10902
|
-
*
|
|
12310
|
+
* Aggregated stats for total auth phone estimation.
|
|
10903
12311
|
*/
|
|
10904
|
-
|
|
12312
|
+
authPhoneEstimate: number;
|
|
10905
12313
|
/**
|
|
10906
|
-
*
|
|
12314
|
+
* Aggregated stats for each projects.
|
|
10907
12315
|
*/
|
|
10908
|
-
|
|
12316
|
+
projects: UsageOrganizationProject[];
|
|
10909
12317
|
/**
|
|
10910
|
-
*
|
|
12318
|
+
* Aggregated stats for realtime connections.
|
|
10911
12319
|
*/
|
|
10912
|
-
|
|
10913
|
-
};
|
|
10914
|
-
/**
|
|
10915
|
-
* PlanChangeLimits
|
|
10916
|
-
*/
|
|
10917
|
-
export type PlanChangeLimits = {
|
|
12320
|
+
realtimeConnections: Metric[];
|
|
10918
12321
|
/**
|
|
10919
|
-
*
|
|
12322
|
+
* Aggregated stats for total realtime connections.
|
|
10920
12323
|
*/
|
|
10921
|
-
|
|
12324
|
+
realtimeConnectionsTotal: number;
|
|
10922
12325
|
/**
|
|
10923
|
-
*
|
|
12326
|
+
* Aggregated stats for realtime messages.
|
|
10924
12327
|
*/
|
|
10925
|
-
|
|
12328
|
+
realtimeMessages: Metric[];
|
|
10926
12329
|
/**
|
|
10927
|
-
*
|
|
12330
|
+
* Aggregated stats for total realtime messages.
|
|
10928
12331
|
*/
|
|
10929
|
-
|
|
12332
|
+
realtimeMessagesTotal: number;
|
|
10930
12333
|
/**
|
|
10931
|
-
*
|
|
12334
|
+
* Aggregated stats for realtime bandwidth.
|
|
10932
12335
|
*/
|
|
10933
|
-
|
|
12336
|
+
realtimeBandwidth: Metric[];
|
|
10934
12337
|
/**
|
|
10935
|
-
*
|
|
12338
|
+
* Aggregated stats for total realtime bandwidth.
|
|
10936
12339
|
*/
|
|
10937
|
-
|
|
12340
|
+
realtimeBandwidthTotal: number;
|
|
10938
12341
|
};
|
|
10939
12342
|
/**
|
|
10940
|
-
*
|
|
12343
|
+
* OrganizationProject
|
|
10941
12344
|
*/
|
|
10942
|
-
export type
|
|
12345
|
+
export type UsageOrganizationProject = {
|
|
10943
12346
|
/**
|
|
10944
|
-
*
|
|
12347
|
+
* projectId
|
|
10945
12348
|
*/
|
|
10946
|
-
|
|
12349
|
+
projectId: string;
|
|
10947
12350
|
/**
|
|
10948
|
-
*
|
|
12351
|
+
* Aggregated stats for number of requests.
|
|
10949
12352
|
*/
|
|
10950
|
-
|
|
12353
|
+
bandwidth: Metric[];
|
|
10951
12354
|
/**
|
|
10952
|
-
*
|
|
12355
|
+
* Aggregated stats for consumed bandwidth.
|
|
10953
12356
|
*/
|
|
10954
|
-
|
|
12357
|
+
users: Metric[];
|
|
10955
12358
|
/**
|
|
10956
|
-
*
|
|
12359
|
+
* Aggregated stats for function executions.
|
|
10957
12360
|
*/
|
|
10958
|
-
|
|
12361
|
+
executions: number;
|
|
10959
12362
|
/**
|
|
10960
|
-
*
|
|
12363
|
+
* Aggregated stats for database reads.
|
|
10961
12364
|
*/
|
|
10962
|
-
|
|
10963
|
-
};
|
|
10964
|
-
/**
|
|
10965
|
-
* PlanChangeResourceCompliance
|
|
10966
|
-
*/
|
|
10967
|
-
export type PlanChangeResourceCompliance = {
|
|
12365
|
+
databasesReads: Metric[];
|
|
10968
12366
|
/**
|
|
10969
|
-
*
|
|
12367
|
+
* Aggregated stats for database writes.
|
|
10970
12368
|
*/
|
|
10971
|
-
|
|
12369
|
+
databasesWrites: Metric[];
|
|
10972
12370
|
/**
|
|
10973
|
-
*
|
|
12371
|
+
* Aggregated stats for function executions in mb seconds.
|
|
10974
12372
|
*/
|
|
10975
|
-
|
|
12373
|
+
executionsMBSeconds: number;
|
|
10976
12374
|
/**
|
|
10977
|
-
*
|
|
12375
|
+
* Aggregated stats for function builds in mb seconds.
|
|
10978
12376
|
*/
|
|
10979
|
-
|
|
12377
|
+
buildsMBSeconds: number;
|
|
10980
12378
|
/**
|
|
10981
|
-
*
|
|
12379
|
+
* Aggregated stats for number of documents.
|
|
10982
12380
|
*/
|
|
10983
|
-
|
|
12381
|
+
storage: number;
|
|
10984
12382
|
/**
|
|
10985
|
-
*
|
|
12383
|
+
* Aggregated stats for phone authentication.
|
|
10986
12384
|
*/
|
|
10987
|
-
|
|
12385
|
+
authPhoneTotal: number;
|
|
10988
12386
|
/**
|
|
10989
|
-
*
|
|
12387
|
+
* Aggregated stats for phone authentication estimated cost.
|
|
10990
12388
|
*/
|
|
10991
|
-
|
|
10992
|
-
};
|
|
10993
|
-
/**
|
|
10994
|
-
* EstimationDeleteOrganization
|
|
10995
|
-
*/
|
|
10996
|
-
export type EstimationDeleteOrganization = {
|
|
12389
|
+
authPhoneEstimate: number;
|
|
10997
12390
|
/**
|
|
10998
|
-
*
|
|
12391
|
+
* Aggregated stats for total databases reads.
|
|
10999
12392
|
*/
|
|
11000
|
-
|
|
11001
|
-
};
|
|
11002
|
-
/**
|
|
11003
|
-
* EstimationItem
|
|
11004
|
-
*/
|
|
11005
|
-
export type EstimationItem = {
|
|
12393
|
+
databasesReadsTotal: number;
|
|
11006
12394
|
/**
|
|
11007
|
-
*
|
|
12395
|
+
* Aggregated stats for total databases writes.
|
|
11008
12396
|
*/
|
|
11009
|
-
|
|
12397
|
+
databasesWritesTotal: number;
|
|
11010
12398
|
/**
|
|
11011
|
-
*
|
|
12399
|
+
* Aggregated stats for file transformations.
|
|
11012
12400
|
*/
|
|
11013
|
-
|
|
11014
|
-
};
|
|
11015
|
-
/**
|
|
11016
|
-
* DomainPrice
|
|
11017
|
-
*/
|
|
11018
|
-
export type DomainPrice = {
|
|
12401
|
+
imageTransformations: Metric[];
|
|
11019
12402
|
/**
|
|
11020
|
-
*
|
|
12403
|
+
* Aggregated stats for total file transformations.
|
|
11021
12404
|
*/
|
|
11022
|
-
|
|
12405
|
+
imageTransformationsTotal: number;
|
|
11023
12406
|
/**
|
|
11024
|
-
*
|
|
12407
|
+
* Aggregated stats for file transformations.
|
|
11025
12408
|
*/
|
|
11026
|
-
|
|
12409
|
+
screenshotsGenerated: Metric[];
|
|
11027
12410
|
/**
|
|
11028
|
-
*
|
|
12411
|
+
* Aggregated stats for total file transformations.
|
|
11029
12412
|
*/
|
|
11030
|
-
|
|
12413
|
+
screenshotsGeneratedTotal: number;
|
|
11031
12414
|
/**
|
|
11032
|
-
*
|
|
12415
|
+
* Aggregated stats for imagine credits.
|
|
11033
12416
|
*/
|
|
11034
|
-
|
|
12417
|
+
imagineCredits: number;
|
|
11035
12418
|
/**
|
|
11036
|
-
*
|
|
12419
|
+
* Aggregated stats for realtime connections.
|
|
11037
12420
|
*/
|
|
11038
|
-
|
|
12421
|
+
realtimeConnections: number;
|
|
12422
|
+
/**
|
|
12423
|
+
* Aggregated stats for realtime messages.
|
|
12424
|
+
*/
|
|
12425
|
+
realtimeMessages: number;
|
|
11039
12426
|
/**
|
|
11040
|
-
*
|
|
12427
|
+
* Aggregated stats for realtime bandwidth.
|
|
11041
12428
|
*/
|
|
11042
|
-
|
|
12429
|
+
realtimeBandwidth: number;
|
|
11043
12430
|
};
|
|
11044
12431
|
/**
|
|
11045
|
-
*
|
|
12432
|
+
* Resource
|
|
11046
12433
|
*/
|
|
11047
|
-
export type
|
|
12434
|
+
export type UsageResources = {
|
|
11048
12435
|
/**
|
|
11049
|
-
*
|
|
12436
|
+
* Invoice name
|
|
11050
12437
|
*/
|
|
11051
|
-
|
|
12438
|
+
name: string;
|
|
11052
12439
|
/**
|
|
11053
|
-
*
|
|
12440
|
+
* Invoice value
|
|
11054
12441
|
*/
|
|
11055
|
-
|
|
12442
|
+
value: number;
|
|
11056
12443
|
/**
|
|
11057
|
-
*
|
|
12444
|
+
* Invoice amount
|
|
11058
12445
|
*/
|
|
11059
|
-
|
|
12446
|
+
amount: number;
|
|
11060
12447
|
/**
|
|
11061
|
-
*
|
|
12448
|
+
* Invoice rate
|
|
11062
12449
|
*/
|
|
11063
|
-
|
|
12450
|
+
rate: number;
|
|
12451
|
+
/**
|
|
12452
|
+
* Invoice description
|
|
12453
|
+
*/
|
|
12454
|
+
desc: string;
|
|
12455
|
+
/**
|
|
12456
|
+
* Resource ID
|
|
12457
|
+
*/
|
|
12458
|
+
resourceId: string;
|
|
11064
12459
|
};
|
|
11065
12460
|
/**
|
|
11066
|
-
*
|
|
12461
|
+
* App
|
|
11067
12462
|
*/
|
|
11068
|
-
export type
|
|
12463
|
+
export type App = {
|
|
11069
12464
|
/**
|
|
11070
|
-
*
|
|
12465
|
+
* App ID.
|
|
11071
12466
|
*/
|
|
11072
12467
|
$id: string;
|
|
11073
12468
|
/**
|
|
11074
|
-
*
|
|
12469
|
+
* App creation time in ISO 8601 format.
|
|
11075
12470
|
*/
|
|
11076
12471
|
$createdAt: string;
|
|
11077
12472
|
/**
|
|
11078
|
-
*
|
|
12473
|
+
* App update date in ISO 8601 format.
|
|
11079
12474
|
*/
|
|
11080
12475
|
$updatedAt: string;
|
|
11081
12476
|
/**
|
|
11082
|
-
*
|
|
12477
|
+
* Application name.
|
|
11083
12478
|
*/
|
|
11084
|
-
|
|
12479
|
+
name: string;
|
|
11085
12480
|
/**
|
|
11086
|
-
*
|
|
12481
|
+
* List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.
|
|
11087
12482
|
*/
|
|
11088
|
-
|
|
12483
|
+
redirectUris: string[];
|
|
11089
12484
|
/**
|
|
11090
|
-
*
|
|
12485
|
+
* When true, the application is restricted to the owner user (if `userId` is set) or members of `teamId` (if set). When false, any user in the project can authorize against the app.
|
|
11091
12486
|
*/
|
|
11092
|
-
|
|
12487
|
+
internal: boolean;
|
|
11093
12488
|
/**
|
|
11094
|
-
*
|
|
12489
|
+
* Whether the app is enabled or not.
|
|
11095
12490
|
*/
|
|
11096
|
-
|
|
12491
|
+
enabled: boolean;
|
|
11097
12492
|
/**
|
|
11098
|
-
*
|
|
12493
|
+
* OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.
|
|
11099
12494
|
*/
|
|
11100
|
-
|
|
12495
|
+
type: string;
|
|
11101
12496
|
/**
|
|
11102
|
-
*
|
|
12497
|
+
* ID of team that owns the application, if owned by team. Otherwise, user ID will be used.
|
|
11103
12498
|
*/
|
|
11104
|
-
|
|
12499
|
+
teamId: string;
|
|
11105
12500
|
/**
|
|
11106
|
-
*
|
|
12501
|
+
* ID of user who owns the application, if owned by user. Otherwise, team ID will be used.
|
|
11107
12502
|
*/
|
|
11108
|
-
|
|
12503
|
+
userId: string;
|
|
12504
|
+
/**
|
|
12505
|
+
* List of application secrets.
|
|
12506
|
+
*/
|
|
12507
|
+
secrets: AppSecret[];
|
|
11109
12508
|
};
|
|
11110
12509
|
/**
|
|
11111
|
-
*
|
|
12510
|
+
* AppSecret
|
|
11112
12511
|
*/
|
|
11113
|
-
export type
|
|
12512
|
+
export type AppSecret = {
|
|
11114
12513
|
/**
|
|
11115
|
-
*
|
|
12514
|
+
* Secret ID.
|
|
11116
12515
|
*/
|
|
11117
|
-
|
|
12516
|
+
$id: string;
|
|
11118
12517
|
/**
|
|
11119
|
-
*
|
|
12518
|
+
* Secret creation time in ISO 8601 format.
|
|
11120
12519
|
*/
|
|
11121
|
-
|
|
12520
|
+
$createdAt: string;
|
|
11122
12521
|
/**
|
|
11123
|
-
*
|
|
12522
|
+
* Secret update time in ISO 8601 format.
|
|
11124
12523
|
*/
|
|
11125
|
-
|
|
12524
|
+
$updatedAt: string;
|
|
11126
12525
|
/**
|
|
11127
|
-
*
|
|
12526
|
+
* Application ID this secret belongs to.
|
|
11128
12527
|
*/
|
|
11129
|
-
|
|
12528
|
+
appId: string;
|
|
11130
12529
|
/**
|
|
11131
|
-
*
|
|
12530
|
+
* Masked application client secret. Only the last 6 characters are returned.
|
|
11132
12531
|
*/
|
|
11133
|
-
|
|
12532
|
+
secret: string;
|
|
11134
12533
|
/**
|
|
11135
|
-
*
|
|
12534
|
+
* ID of the user who created the secret.
|
|
11136
12535
|
*/
|
|
11137
|
-
|
|
12536
|
+
createdById: string;
|
|
11138
12537
|
/**
|
|
11139
|
-
*
|
|
12538
|
+
* Name of the user who created the secret.
|
|
11140
12539
|
*/
|
|
11141
|
-
|
|
12540
|
+
createdByName: string;
|
|
11142
12541
|
/**
|
|
11143
|
-
*
|
|
12542
|
+
* Time the secret was last used for authentication in ISO 8601 format. Null if never used.
|
|
11144
12543
|
*/
|
|
11145
|
-
|
|
12544
|
+
lastAccessedAt?: string;
|
|
11146
12545
|
};
|
|
11147
12546
|
/**
|
|
11148
|
-
*
|
|
12547
|
+
* AppSecretPlaintext
|
|
11149
12548
|
*/
|
|
11150
|
-
export type
|
|
12549
|
+
export type AppSecretPlaintext = {
|
|
11151
12550
|
/**
|
|
11152
|
-
*
|
|
12551
|
+
* Secret ID.
|
|
11153
12552
|
*/
|
|
11154
|
-
|
|
11155
|
-
};
|
|
11156
|
-
/**
|
|
11157
|
-
* domainTransferStatus
|
|
11158
|
-
*/
|
|
11159
|
-
export type DomainTransferStatus = {
|
|
12553
|
+
$id: string;
|
|
11160
12554
|
/**
|
|
11161
|
-
*
|
|
12555
|
+
* Secret creation time in ISO 8601 format.
|
|
11162
12556
|
*/
|
|
11163
|
-
|
|
12557
|
+
$createdAt: string;
|
|
11164
12558
|
/**
|
|
11165
|
-
*
|
|
12559
|
+
* Secret update time in ISO 8601 format.
|
|
11166
12560
|
*/
|
|
11167
|
-
|
|
12561
|
+
$updatedAt: string;
|
|
11168
12562
|
/**
|
|
11169
|
-
*
|
|
12563
|
+
* Application ID this secret belongs to.
|
|
11170
12564
|
*/
|
|
11171
|
-
|
|
11172
|
-
};
|
|
11173
|
-
/**
|
|
11174
|
-
* Addons list
|
|
11175
|
-
*/
|
|
11176
|
-
export type AddonList = {
|
|
12565
|
+
appId: string;
|
|
11177
12566
|
/**
|
|
11178
|
-
*
|
|
12567
|
+
* Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.
|
|
11179
12568
|
*/
|
|
11180
|
-
|
|
12569
|
+
secret: string;
|
|
11181
12570
|
/**
|
|
11182
|
-
*
|
|
12571
|
+
* ID of the user who created the secret.
|
|
11183
12572
|
*/
|
|
11184
|
-
|
|
12573
|
+
createdById: string;
|
|
12574
|
+
/**
|
|
12575
|
+
* Name of the user who created the secret.
|
|
12576
|
+
*/
|
|
12577
|
+
createdByName: string;
|
|
12578
|
+
/**
|
|
12579
|
+
* Time the secret was last used for authentication in ISO 8601 format. Null if never used.
|
|
12580
|
+
*/
|
|
12581
|
+
lastAccessedAt?: string;
|
|
11185
12582
|
};
|
|
11186
12583
|
/**
|
|
11187
12584
|
* Activity event list
|
|
@@ -11196,6 +12593,19 @@ export declare namespace Models {
|
|
|
11196
12593
|
*/
|
|
11197
12594
|
events: ActivityEvent[];
|
|
11198
12595
|
};
|
|
12596
|
+
/**
|
|
12597
|
+
* Addons list
|
|
12598
|
+
*/
|
|
12599
|
+
export type AddonList = {
|
|
12600
|
+
/**
|
|
12601
|
+
* Total number of addons that matched your query.
|
|
12602
|
+
*/
|
|
12603
|
+
total: number;
|
|
12604
|
+
/**
|
|
12605
|
+
* List of addons.
|
|
12606
|
+
*/
|
|
12607
|
+
addons: Addon[];
|
|
12608
|
+
};
|
|
11199
12609
|
/**
|
|
11200
12610
|
* Aggregation team list
|
|
11201
12611
|
*/
|
|
@@ -11249,30 +12659,30 @@ export declare namespace Models {
|
|
|
11249
12659
|
restorations: BackupRestoration[];
|
|
11250
12660
|
};
|
|
11251
12661
|
/**
|
|
11252
|
-
* Billing
|
|
12662
|
+
* Billing address list
|
|
11253
12663
|
*/
|
|
11254
|
-
export type
|
|
12664
|
+
export type BillingAddressList = {
|
|
11255
12665
|
/**
|
|
11256
|
-
* Total number of
|
|
12666
|
+
* Total number of billingAddresses that matched your query.
|
|
11257
12667
|
*/
|
|
11258
12668
|
total: number;
|
|
11259
12669
|
/**
|
|
11260
|
-
* List of
|
|
12670
|
+
* List of billingAddresses.
|
|
11261
12671
|
*/
|
|
11262
|
-
|
|
12672
|
+
billingAddresses: BillingAddress[];
|
|
11263
12673
|
};
|
|
11264
12674
|
/**
|
|
11265
|
-
* Billing
|
|
12675
|
+
* Billing invoices list
|
|
11266
12676
|
*/
|
|
11267
|
-
export type
|
|
12677
|
+
export type InvoiceList = {
|
|
11268
12678
|
/**
|
|
11269
|
-
* Total number of
|
|
12679
|
+
* Total number of invoices that matched your query.
|
|
11270
12680
|
*/
|
|
11271
12681
|
total: number;
|
|
11272
12682
|
/**
|
|
11273
|
-
* List of
|
|
12683
|
+
* List of invoices.
|
|
11274
12684
|
*/
|
|
11275
|
-
|
|
12685
|
+
invoices: Invoice[];
|
|
11276
12686
|
};
|
|
11277
12687
|
/**
|
|
11278
12688
|
* Billing plan list
|
|
@@ -11287,6 +12697,97 @@ export declare namespace Models {
|
|
|
11287
12697
|
*/
|
|
11288
12698
|
plans: BillingPlan[];
|
|
11289
12699
|
};
|
|
12700
|
+
/**
|
|
12701
|
+
* Blocks list
|
|
12702
|
+
*/
|
|
12703
|
+
export type BlockList = {
|
|
12704
|
+
/**
|
|
12705
|
+
* Total number of blocks that matched your query.
|
|
12706
|
+
*/
|
|
12707
|
+
total: number;
|
|
12708
|
+
/**
|
|
12709
|
+
* List of blocks.
|
|
12710
|
+
*/
|
|
12711
|
+
blocks: Block[];
|
|
12712
|
+
};
|
|
12713
|
+
/**
|
|
12714
|
+
* Dedicated database connections list
|
|
12715
|
+
*/
|
|
12716
|
+
export type DedicatedDatabaseConnectionList = {
|
|
12717
|
+
/**
|
|
12718
|
+
* Total number of connections that matched your query.
|
|
12719
|
+
*/
|
|
12720
|
+
total: number;
|
|
12721
|
+
/**
|
|
12722
|
+
* List of connections.
|
|
12723
|
+
*/
|
|
12724
|
+
connections: DedicatedDatabaseConnection[];
|
|
12725
|
+
};
|
|
12726
|
+
/**
|
|
12727
|
+
* Dedicated database slow queries list
|
|
12728
|
+
*/
|
|
12729
|
+
export type DedicatedDatabaseSlowQueryList = {
|
|
12730
|
+
/**
|
|
12731
|
+
* Total number of slowQueries that matched your query.
|
|
12732
|
+
*/
|
|
12733
|
+
total: number;
|
|
12734
|
+
/**
|
|
12735
|
+
* List of slowQueries.
|
|
12736
|
+
*/
|
|
12737
|
+
slowQueries: DedicatedDatabaseSlowQuery[];
|
|
12738
|
+
};
|
|
12739
|
+
/**
|
|
12740
|
+
* Dedicated databases list
|
|
12741
|
+
*/
|
|
12742
|
+
export type DedicatedDatabaseList = {
|
|
12743
|
+
/**
|
|
12744
|
+
* Total number of databases that matched your query.
|
|
12745
|
+
*/
|
|
12746
|
+
total: number;
|
|
12747
|
+
/**
|
|
12748
|
+
* List of databases.
|
|
12749
|
+
*/
|
|
12750
|
+
databases: DedicatedDatabase[];
|
|
12751
|
+
};
|
|
12752
|
+
/**
|
|
12753
|
+
* DNS records list
|
|
12754
|
+
*/
|
|
12755
|
+
export type DnsRecordsList = {
|
|
12756
|
+
/**
|
|
12757
|
+
* Total number of dnsRecords that matched your query.
|
|
12758
|
+
*/
|
|
12759
|
+
total: number;
|
|
12760
|
+
/**
|
|
12761
|
+
* List of dnsRecords.
|
|
12762
|
+
*/
|
|
12763
|
+
dnsRecords: DnsRecord[];
|
|
12764
|
+
};
|
|
12765
|
+
/**
|
|
12766
|
+
* Domain suggestions list
|
|
12767
|
+
*/
|
|
12768
|
+
export type DomainSuggestionsList = {
|
|
12769
|
+
/**
|
|
12770
|
+
* Total number of suggestions that matched your query.
|
|
12771
|
+
*/
|
|
12772
|
+
total: number;
|
|
12773
|
+
/**
|
|
12774
|
+
* List of suggestions.
|
|
12775
|
+
*/
|
|
12776
|
+
suggestions: DomainSuggestion[];
|
|
12777
|
+
};
|
|
12778
|
+
/**
|
|
12779
|
+
* Domains list
|
|
12780
|
+
*/
|
|
12781
|
+
export type DomainsList = {
|
|
12782
|
+
/**
|
|
12783
|
+
* Total number of domains that matched your query.
|
|
12784
|
+
*/
|
|
12785
|
+
total: number;
|
|
12786
|
+
/**
|
|
12787
|
+
* List of domains.
|
|
12788
|
+
*/
|
|
12789
|
+
domains: Domain[];
|
|
12790
|
+
};
|
|
11290
12791
|
/**
|
|
11291
12792
|
* Organizations list
|
|
11292
12793
|
*/
|
|
@@ -11314,69 +12815,69 @@ export declare namespace Models {
|
|
|
11314
12815
|
paymentMethods: PaymentMethod[];
|
|
11315
12816
|
};
|
|
11316
12817
|
/**
|
|
11317
|
-
*
|
|
12818
|
+
* Regions list
|
|
11318
12819
|
*/
|
|
11319
|
-
export type
|
|
12820
|
+
export type ConsoleRegionList = {
|
|
11320
12821
|
/**
|
|
11321
|
-
* Total number of
|
|
12822
|
+
* Total number of regions that matched your query.
|
|
11322
12823
|
*/
|
|
11323
12824
|
total: number;
|
|
11324
12825
|
/**
|
|
11325
|
-
* List of
|
|
12826
|
+
* List of regions.
|
|
11326
12827
|
*/
|
|
11327
|
-
|
|
12828
|
+
regions: ConsoleRegion[];
|
|
11328
12829
|
};
|
|
11329
12830
|
/**
|
|
11330
|
-
*
|
|
12831
|
+
* Usage events list
|
|
11331
12832
|
*/
|
|
11332
|
-
export type
|
|
12833
|
+
export type UsageEventList = {
|
|
11333
12834
|
/**
|
|
11334
|
-
* Total number of
|
|
12835
|
+
* Total number of events that matched your query.
|
|
11335
12836
|
*/
|
|
11336
12837
|
total: number;
|
|
11337
12838
|
/**
|
|
11338
|
-
* List of
|
|
12839
|
+
* List of events.
|
|
11339
12840
|
*/
|
|
11340
|
-
|
|
12841
|
+
events: UsageEvent[];
|
|
11341
12842
|
};
|
|
11342
12843
|
/**
|
|
11343
|
-
*
|
|
12844
|
+
* Usage gauges list
|
|
11344
12845
|
*/
|
|
11345
|
-
export type
|
|
12846
|
+
export type UsageGaugeList = {
|
|
11346
12847
|
/**
|
|
11347
|
-
* Total number of
|
|
12848
|
+
* Total number of gauges that matched your query.
|
|
11348
12849
|
*/
|
|
11349
12850
|
total: number;
|
|
11350
12851
|
/**
|
|
11351
|
-
* List of
|
|
12852
|
+
* List of gauges.
|
|
11352
12853
|
*/
|
|
11353
|
-
|
|
12854
|
+
gauges: UsageGauge[];
|
|
11354
12855
|
};
|
|
11355
12856
|
/**
|
|
11356
|
-
*
|
|
12857
|
+
* Apps list
|
|
11357
12858
|
*/
|
|
11358
|
-
export type
|
|
12859
|
+
export type AppsList = {
|
|
11359
12860
|
/**
|
|
11360
|
-
* Total number of
|
|
12861
|
+
* Total number of apps that matched your query.
|
|
11361
12862
|
*/
|
|
11362
12863
|
total: number;
|
|
11363
12864
|
/**
|
|
11364
|
-
* List of
|
|
12865
|
+
* List of apps.
|
|
11365
12866
|
*/
|
|
11366
|
-
|
|
12867
|
+
apps: App[];
|
|
11367
12868
|
};
|
|
11368
12869
|
/**
|
|
11369
|
-
*
|
|
12870
|
+
* App secrets list
|
|
11370
12871
|
*/
|
|
11371
|
-
export type
|
|
12872
|
+
export type AppSecretList = {
|
|
11372
12873
|
/**
|
|
11373
|
-
* Total number of
|
|
12874
|
+
* Total number of secrets that matched your query.
|
|
11374
12875
|
*/
|
|
11375
12876
|
total: number;
|
|
11376
12877
|
/**
|
|
11377
|
-
* List of
|
|
12878
|
+
* List of secrets.
|
|
11378
12879
|
*/
|
|
11379
|
-
|
|
12880
|
+
secrets: AppSecret[];
|
|
11380
12881
|
};
|
|
11381
12882
|
export {};
|
|
11382
12883
|
}
|