@appwrite.io/console 13.1.0 → 14.0.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 +1 -1
- package/dist/cjs/sdk.js +5059 -687
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +5057 -688
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +5061 -689
- package/package.json +1 -1
- package/types/enums/{site-adapter.d.ts → adapter.d.ts} +1 -1
- package/types/enums/{organization-addon.d.ts → addon.d.ts} +1 -1
- package/types/enums/appwrite-migration-resource.d.ts +13 -1
- package/types/enums/{function-runtime.d.ts → build-runtime.d.ts} +1 -1
- package/types/enums/embedding-model.d.ts +4 -1
- package/types/enums/{site-framework.d.ts → framework.d.ts} +1 -1
- package/types/enums/{migration-on-duplicate.d.ts → on-duplicate.d.ts} +1 -1
- package/types/enums/project-key-scopes.d.ts +3 -0
- package/types/enums/project-policy-id.d.ts +5 -1
- package/types/enums/query-suggestion-resource.d.ts +3 -0
- package/types/enums/{site-build-runtime.d.ts → runtime.d.ts} +1 -1
- package/types/enums/{redirect-status-code.d.ts → status-code.d.ts} +1 -1
- package/types/enums/status.d.ts +3 -0
- package/types/index.d.ts +11 -8
- package/types/models.d.ts +1490 -67
- package/types/services/account.d.ts +2 -2
- package/types/services/advisor.d.ts +123 -0
- package/types/services/apps.d.ts +302 -0
- package/types/services/compute.d.ts +1074 -0
- package/types/services/databases.d.ts +24 -24
- package/types/services/documents-db.d.ts +4 -1
- package/types/services/functions.d.ts +13 -13
- package/types/services/health.d.ts +8 -0
- package/types/services/messaging.d.ts +92 -0
- package/types/services/migrations.d.ts +13 -13
- package/types/services/organizations.d.ts +13 -13
- package/types/services/project.d.ts +96 -7
- package/types/services/projects.d.ts +5 -5
- package/types/services/proxy.d.ts +5 -5
- package/types/services/sites.d.ts +27 -27
- package/types/services/tables-db.d.ts +28 -25
- package/types/services/vectors-db.d.ts +4 -1
- package/types/enums/project-status.d.ts +0 -3
package/types/models.d.ts
CHANGED
|
@@ -564,7 +564,7 @@ export declare namespace Models {
|
|
|
564
564
|
/**
|
|
565
565
|
* List of policies.
|
|
566
566
|
*/
|
|
567
|
-
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)[];
|
|
568
568
|
};
|
|
569
569
|
/**
|
|
570
570
|
* Email Templates List
|
|
@@ -774,6 +774,32 @@ export declare namespace Models {
|
|
|
774
774
|
*/
|
|
775
775
|
embeddings: Embedding[];
|
|
776
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
|
+
};
|
|
777
803
|
/**
|
|
778
804
|
* Database
|
|
779
805
|
*/
|
|
@@ -1464,7 +1490,7 @@ export declare namespace Models {
|
|
|
1464
1490
|
/**
|
|
1465
1491
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1466
1492
|
*/
|
|
1467
|
-
default?:
|
|
1493
|
+
default?: number[];
|
|
1468
1494
|
};
|
|
1469
1495
|
/**
|
|
1470
1496
|
* AttributeLine
|
|
@@ -1505,7 +1531,7 @@ export declare namespace Models {
|
|
|
1505
1531
|
/**
|
|
1506
1532
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1507
1533
|
*/
|
|
1508
|
-
default?:
|
|
1534
|
+
default?: number[][];
|
|
1509
1535
|
};
|
|
1510
1536
|
/**
|
|
1511
1537
|
* AttributePolygon
|
|
@@ -1546,7 +1572,7 @@ export declare namespace Models {
|
|
|
1546
1572
|
/**
|
|
1547
1573
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1548
1574
|
*/
|
|
1549
|
-
default?:
|
|
1575
|
+
default?: number[][][];
|
|
1550
1576
|
};
|
|
1551
1577
|
/**
|
|
1552
1578
|
* AttributeVarchar
|
|
@@ -2654,7 +2680,7 @@ export declare namespace Models {
|
|
|
2654
2680
|
/**
|
|
2655
2681
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2656
2682
|
*/
|
|
2657
|
-
default?:
|
|
2683
|
+
default?: number[];
|
|
2658
2684
|
};
|
|
2659
2685
|
/**
|
|
2660
2686
|
* ColumnLine
|
|
@@ -2695,7 +2721,7 @@ export declare namespace Models {
|
|
|
2695
2721
|
/**
|
|
2696
2722
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2697
2723
|
*/
|
|
2698
|
-
default?:
|
|
2724
|
+
default?: number[][];
|
|
2699
2725
|
};
|
|
2700
2726
|
/**
|
|
2701
2727
|
* ColumnPolygon
|
|
@@ -2736,7 +2762,7 @@ export declare namespace Models {
|
|
|
2736
2762
|
/**
|
|
2737
2763
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2738
2764
|
*/
|
|
2739
|
-
default?:
|
|
2765
|
+
default?: number[][][];
|
|
2740
2766
|
};
|
|
2741
2767
|
/**
|
|
2742
2768
|
* ColumnVarchar
|
|
@@ -3280,6 +3306,26 @@ export declare namespace Models {
|
|
|
3280
3306
|
* Email verification status.
|
|
3281
3307
|
*/
|
|
3282
3308
|
emailVerification: boolean;
|
|
3309
|
+
/**
|
|
3310
|
+
* Canonical form of the user email address.
|
|
3311
|
+
*/
|
|
3312
|
+
emailCanonical?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* Whether the user email is from a free email provider.
|
|
3315
|
+
*/
|
|
3316
|
+
emailIsFree?: boolean;
|
|
3317
|
+
/**
|
|
3318
|
+
* Whether the user email is from a disposable email provider.
|
|
3319
|
+
*/
|
|
3320
|
+
emailIsDisposable?: boolean;
|
|
3321
|
+
/**
|
|
3322
|
+
* Whether the user email is from a corporate domain.
|
|
3323
|
+
*/
|
|
3324
|
+
emailIsCorporate?: boolean;
|
|
3325
|
+
/**
|
|
3326
|
+
* Whether the user email is in its canonical form.
|
|
3327
|
+
*/
|
|
3328
|
+
emailIsCanonical?: boolean;
|
|
3283
3329
|
/**
|
|
3284
3330
|
* Phone verification status.
|
|
3285
3331
|
*/
|
|
@@ -3910,6 +3956,10 @@ export declare namespace Models {
|
|
|
3910
3956
|
* Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.
|
|
3911
3957
|
*/
|
|
3912
3958
|
mfa: boolean;
|
|
3959
|
+
/**
|
|
3960
|
+
* Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.
|
|
3961
|
+
*/
|
|
3962
|
+
userAccessedAt: string;
|
|
3913
3963
|
/**
|
|
3914
3964
|
* User list of roles
|
|
3915
3965
|
*/
|
|
@@ -4980,6 +5030,10 @@ export declare namespace Models {
|
|
|
4980
5030
|
* Project team ID.
|
|
4981
5031
|
*/
|
|
4982
5032
|
teamId: string;
|
|
5033
|
+
/**
|
|
5034
|
+
* Project region
|
|
5035
|
+
*/
|
|
5036
|
+
region: string;
|
|
4983
5037
|
/**
|
|
4984
5038
|
* Deprecated since 1.9.5: List of dev keys.
|
|
4985
5039
|
*/
|
|
@@ -5053,21 +5107,73 @@ export declare namespace Models {
|
|
|
5053
5107
|
*/
|
|
5054
5108
|
protocols: ProjectProtocol[];
|
|
5055
5109
|
/**
|
|
5056
|
-
* Project
|
|
5110
|
+
* Project blocks information
|
|
5057
5111
|
*/
|
|
5058
|
-
|
|
5112
|
+
blocks: Block[];
|
|
5113
|
+
/**
|
|
5114
|
+
* Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.
|
|
5115
|
+
*/
|
|
5116
|
+
consoleAccessedAt: string;
|
|
5059
5117
|
/**
|
|
5060
5118
|
* Billing limits reached
|
|
5061
5119
|
*/
|
|
5062
5120
|
billingLimits?: BillingLimits;
|
|
5063
5121
|
/**
|
|
5064
|
-
*
|
|
5122
|
+
* OAuth2 server status
|
|
5065
5123
|
*/
|
|
5066
|
-
|
|
5124
|
+
oAuth2ServerEnabled: boolean;
|
|
5067
5125
|
/**
|
|
5068
|
-
*
|
|
5126
|
+
* OAuth2 server authorization URL
|
|
5069
5127
|
*/
|
|
5070
|
-
|
|
5128
|
+
oAuth2ServerAuthorizationUrl: string;
|
|
5129
|
+
/**
|
|
5130
|
+
* OAuth2 server allowed scopes
|
|
5131
|
+
*/
|
|
5132
|
+
oAuth2ServerScopes: string[];
|
|
5133
|
+
/**
|
|
5134
|
+
* OAuth2 server accepted RFC 9396 authorization_details types
|
|
5135
|
+
*/
|
|
5136
|
+
oAuth2ServerAuthorizationDetailsTypes: string[];
|
|
5137
|
+
/**
|
|
5138
|
+
* OAuth2 server access token duration in seconds for confidential clients
|
|
5139
|
+
*/
|
|
5140
|
+
oAuth2ServerAccessTokenDuration: number;
|
|
5141
|
+
/**
|
|
5142
|
+
* OAuth2 server refresh token duration in seconds for confidential clients
|
|
5143
|
+
*/
|
|
5144
|
+
oAuth2ServerRefreshTokenDuration: number;
|
|
5145
|
+
/**
|
|
5146
|
+
* OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)
|
|
5147
|
+
*/
|
|
5148
|
+
oAuth2ServerPublicAccessTokenDuration: number;
|
|
5149
|
+
/**
|
|
5150
|
+
* OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)
|
|
5151
|
+
*/
|
|
5152
|
+
oAuth2ServerPublicRefreshTokenDuration: number;
|
|
5153
|
+
/**
|
|
5154
|
+
* 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.
|
|
5155
|
+
*/
|
|
5156
|
+
oAuth2ServerConfidentialPkce: boolean;
|
|
5157
|
+
/**
|
|
5158
|
+
* URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.
|
|
5159
|
+
*/
|
|
5160
|
+
oAuth2ServerVerificationUrl: string;
|
|
5161
|
+
/**
|
|
5162
|
+
* Number of characters in the device flow user code, excluding the formatting separator.
|
|
5163
|
+
*/
|
|
5164
|
+
oAuth2ServerUserCodeLength: number;
|
|
5165
|
+
/**
|
|
5166
|
+
* Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.
|
|
5167
|
+
*/
|
|
5168
|
+
oAuth2ServerUserCodeFormat: string;
|
|
5169
|
+
/**
|
|
5170
|
+
* Lifetime in seconds of device flow device codes and user codes.
|
|
5171
|
+
*/
|
|
5172
|
+
oAuth2ServerDeviceCodeDuration: number;
|
|
5173
|
+
/**
|
|
5174
|
+
* OAuth2 server discovery URL
|
|
5175
|
+
*/
|
|
5176
|
+
oAuth2ServerDiscoveryUrl: string;
|
|
5071
5177
|
};
|
|
5072
5178
|
/**
|
|
5073
5179
|
* ProjectAuthMethod
|
|
@@ -6248,6 +6354,35 @@ export declare namespace Models {
|
|
|
6248
6354
|
*/
|
|
6249
6355
|
total: number;
|
|
6250
6356
|
};
|
|
6357
|
+
/**
|
|
6358
|
+
* Policy Password Strength
|
|
6359
|
+
*/
|
|
6360
|
+
export type PolicyPasswordStrength = {
|
|
6361
|
+
/**
|
|
6362
|
+
* Policy ID.
|
|
6363
|
+
*/
|
|
6364
|
+
$id: string;
|
|
6365
|
+
/**
|
|
6366
|
+
* Minimum password length required for user passwords.
|
|
6367
|
+
*/
|
|
6368
|
+
min: number;
|
|
6369
|
+
/**
|
|
6370
|
+
* Whether passwords must include at least one uppercase letter.
|
|
6371
|
+
*/
|
|
6372
|
+
uppercase: boolean;
|
|
6373
|
+
/**
|
|
6374
|
+
* Whether passwords must include at least one lowercase letter.
|
|
6375
|
+
*/
|
|
6376
|
+
lowercase: boolean;
|
|
6377
|
+
/**
|
|
6378
|
+
* Whether passwords must include at least one number.
|
|
6379
|
+
*/
|
|
6380
|
+
number: boolean;
|
|
6381
|
+
/**
|
|
6382
|
+
* Whether passwords must include at least one symbol.
|
|
6383
|
+
*/
|
|
6384
|
+
symbols: boolean;
|
|
6385
|
+
};
|
|
6251
6386
|
/**
|
|
6252
6387
|
* Policy Password Personal Data
|
|
6253
6388
|
*/
|
|
@@ -6354,6 +6489,10 @@ export declare namespace Models {
|
|
|
6354
6489
|
* Whether user MFA status is visible in memberships.
|
|
6355
6490
|
*/
|
|
6356
6491
|
userMFA: boolean;
|
|
6492
|
+
/**
|
|
6493
|
+
* Whether user last access time is visible in memberships.
|
|
6494
|
+
*/
|
|
6495
|
+
userAccessedAt: boolean;
|
|
6357
6496
|
};
|
|
6358
6497
|
/**
|
|
6359
6498
|
* Platform Web
|
|
@@ -8593,6 +8732,50 @@ export declare namespace Models {
|
|
|
8593
8732
|
* Number of platforms to be migrated.
|
|
8594
8733
|
*/
|
|
8595
8734
|
platform: number;
|
|
8735
|
+
/**
|
|
8736
|
+
* Number of API keys to be migrated.
|
|
8737
|
+
*/
|
|
8738
|
+
apikey: number;
|
|
8739
|
+
/**
|
|
8740
|
+
* Number of project variables to be migrated.
|
|
8741
|
+
*/
|
|
8742
|
+
projectvariable: number;
|
|
8743
|
+
/**
|
|
8744
|
+
* Number of webhooks to be migrated.
|
|
8745
|
+
*/
|
|
8746
|
+
webhook: number;
|
|
8747
|
+
/**
|
|
8748
|
+
* Number of auth-method configs to be migrated (always 0 or 1 — the project-level flag bundle).
|
|
8749
|
+
*/
|
|
8750
|
+
authmethods: number;
|
|
8751
|
+
/**
|
|
8752
|
+
* Number of protocol configs to be migrated (always 0 or 1 — the project-level REST/GraphQL/WebSocket flags).
|
|
8753
|
+
*/
|
|
8754
|
+
projectprotocols: number;
|
|
8755
|
+
/**
|
|
8756
|
+
* Number of label sets to be migrated (always 0 or 1 — the project-level RBAC label array).
|
|
8757
|
+
*/
|
|
8758
|
+
projectlabels: number;
|
|
8759
|
+
/**
|
|
8760
|
+
* Number of service configs to be migrated (always 0 or 1 — the project-level enable/disable flags for all 17 services).
|
|
8761
|
+
*/
|
|
8762
|
+
projectservices: number;
|
|
8763
|
+
/**
|
|
8764
|
+
* 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).
|
|
8765
|
+
*/
|
|
8766
|
+
policies: number;
|
|
8767
|
+
/**
|
|
8768
|
+
* 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).
|
|
8769
|
+
*/
|
|
8770
|
+
smtp: number;
|
|
8771
|
+
/**
|
|
8772
|
+
* Number of custom-domain proxy rules to be migrated. Auto-generated `.appwrite.network` rules are skipped — they are recreated by parent Function/Site migration.
|
|
8773
|
+
*/
|
|
8774
|
+
rule: number;
|
|
8775
|
+
/**
|
|
8776
|
+
* Number of custom email templates to be migrated (one per templateId × locale pair).
|
|
8777
|
+
*/
|
|
8778
|
+
projectemailtemplate: number;
|
|
8596
8779
|
/**
|
|
8597
8780
|
* Number of sites to be migrated.
|
|
8598
8781
|
*/
|
|
@@ -8621,11 +8804,162 @@ export declare namespace Models {
|
|
|
8621
8804
|
* Version of the Appwrite instance to be migrated.
|
|
8622
8805
|
*/
|
|
8623
8806
|
version: string;
|
|
8807
|
+
/**
|
|
8808
|
+
* Number of OAuth2 provider configurations to be migrated. Secrets (clientSecret, p8File) are never migrated — destination admin must re-enter them per provider.
|
|
8809
|
+
*/
|
|
8810
|
+
oauth2provider: number;
|
|
8624
8811
|
/**
|
|
8625
8812
|
* Number of backup policies to be migrated.
|
|
8626
8813
|
*/
|
|
8627
8814
|
backuppolicy: number;
|
|
8628
8815
|
};
|
|
8816
|
+
/**
|
|
8817
|
+
* Insight
|
|
8818
|
+
*/
|
|
8819
|
+
export type Insight = {
|
|
8820
|
+
/**
|
|
8821
|
+
* Insight ID.
|
|
8822
|
+
*/
|
|
8823
|
+
$id: string;
|
|
8824
|
+
/**
|
|
8825
|
+
* Insight creation date in ISO 8601 format.
|
|
8826
|
+
*/
|
|
8827
|
+
$createdAt: string;
|
|
8828
|
+
/**
|
|
8829
|
+
* Insight update date in ISO 8601 format.
|
|
8830
|
+
*/
|
|
8831
|
+
$updatedAt: string;
|
|
8832
|
+
/**
|
|
8833
|
+
* Parent report ID. Insights always belong to a report.
|
|
8834
|
+
*/
|
|
8835
|
+
reportId: string;
|
|
8836
|
+
/**
|
|
8837
|
+
* 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).
|
|
8838
|
+
*/
|
|
8839
|
+
type: string;
|
|
8840
|
+
/**
|
|
8841
|
+
* Insight severity. One of info, warning, critical.
|
|
8842
|
+
*/
|
|
8843
|
+
severity: string;
|
|
8844
|
+
/**
|
|
8845
|
+
* Insight status. One of active, dismissed.
|
|
8846
|
+
*/
|
|
8847
|
+
status: string;
|
|
8848
|
+
/**
|
|
8849
|
+
* Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.
|
|
8850
|
+
*/
|
|
8851
|
+
resourceType: string;
|
|
8852
|
+
/**
|
|
8853
|
+
* ID of the resource the insight is about.
|
|
8854
|
+
*/
|
|
8855
|
+
resourceId: string;
|
|
8856
|
+
/**
|
|
8857
|
+
* 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.
|
|
8858
|
+
*/
|
|
8859
|
+
parentResourceType: string;
|
|
8860
|
+
/**
|
|
8861
|
+
* ID of the parent resource. Empty when the resource has no parent.
|
|
8862
|
+
*/
|
|
8863
|
+
parentResourceId: string;
|
|
8864
|
+
/**
|
|
8865
|
+
* Insight title.
|
|
8866
|
+
*/
|
|
8867
|
+
title: string;
|
|
8868
|
+
/**
|
|
8869
|
+
* Short markdown summary describing the insight.
|
|
8870
|
+
*/
|
|
8871
|
+
summary: string;
|
|
8872
|
+
/**
|
|
8873
|
+
* List of call-to-action buttons attached to this insight.
|
|
8874
|
+
*/
|
|
8875
|
+
ctas: InsightCTA[];
|
|
8876
|
+
/**
|
|
8877
|
+
* Time the insight was analyzed in ISO 8601 format.
|
|
8878
|
+
*/
|
|
8879
|
+
analyzedAt?: string;
|
|
8880
|
+
/**
|
|
8881
|
+
* Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.
|
|
8882
|
+
*/
|
|
8883
|
+
dismissedAt?: string;
|
|
8884
|
+
/**
|
|
8885
|
+
* User ID that dismissed the insight. Empty when not dismissed.
|
|
8886
|
+
*/
|
|
8887
|
+
dismissedBy?: string;
|
|
8888
|
+
};
|
|
8889
|
+
/**
|
|
8890
|
+
* InsightCTA
|
|
8891
|
+
*/
|
|
8892
|
+
export type InsightCTA = {
|
|
8893
|
+
/**
|
|
8894
|
+
* Human-readable label for the CTA, used in UI.
|
|
8895
|
+
*/
|
|
8896
|
+
label: string;
|
|
8897
|
+
/**
|
|
8898
|
+
* 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.
|
|
8899
|
+
*/
|
|
8900
|
+
service: string;
|
|
8901
|
+
/**
|
|
8902
|
+
* Public API method on the chosen service the client should invoke when this CTA is triggered.
|
|
8903
|
+
*/
|
|
8904
|
+
method: string;
|
|
8905
|
+
/**
|
|
8906
|
+
* 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).
|
|
8907
|
+
*/
|
|
8908
|
+
params: object;
|
|
8909
|
+
};
|
|
8910
|
+
/**
|
|
8911
|
+
* Report
|
|
8912
|
+
*/
|
|
8913
|
+
export type Report = {
|
|
8914
|
+
/**
|
|
8915
|
+
* Report ID.
|
|
8916
|
+
*/
|
|
8917
|
+
$id: string;
|
|
8918
|
+
/**
|
|
8919
|
+
* Report creation date in ISO 8601 format.
|
|
8920
|
+
*/
|
|
8921
|
+
$createdAt: string;
|
|
8922
|
+
/**
|
|
8923
|
+
* Report update date in ISO 8601 format.
|
|
8924
|
+
*/
|
|
8925
|
+
$updatedAt: string;
|
|
8926
|
+
/**
|
|
8927
|
+
* ID of the third-party app that submitted the report.
|
|
8928
|
+
*/
|
|
8929
|
+
appId: string;
|
|
8930
|
+
/**
|
|
8931
|
+
* Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.
|
|
8932
|
+
*/
|
|
8933
|
+
type: string;
|
|
8934
|
+
/**
|
|
8935
|
+
* Short, human-readable title for the report.
|
|
8936
|
+
*/
|
|
8937
|
+
title: string;
|
|
8938
|
+
/**
|
|
8939
|
+
* Markdown summary describing the report.
|
|
8940
|
+
*/
|
|
8941
|
+
summary: string;
|
|
8942
|
+
/**
|
|
8943
|
+
* Plural noun describing what the report analyzes, e.g. databases, sites, urls.
|
|
8944
|
+
*/
|
|
8945
|
+
targetType: string;
|
|
8946
|
+
/**
|
|
8947
|
+
* Free-form target identifier (URL for lighthouse, resource ID for db).
|
|
8948
|
+
*/
|
|
8949
|
+
target: string;
|
|
8950
|
+
/**
|
|
8951
|
+
* Categories covered by the report, e.g. performance, accessibility.
|
|
8952
|
+
*/
|
|
8953
|
+
categories: string[];
|
|
8954
|
+
/**
|
|
8955
|
+
* Insights nested under this report.
|
|
8956
|
+
*/
|
|
8957
|
+
insights: Insight[];
|
|
8958
|
+
/**
|
|
8959
|
+
* Time the report was analyzed in ISO 8601 format.
|
|
8960
|
+
*/
|
|
8961
|
+
analyzedAt?: string;
|
|
8962
|
+
};
|
|
8629
8963
|
/**
|
|
8630
8964
|
* ActivityEvent
|
|
8631
8965
|
*/
|
|
@@ -8702,54 +9036,6 @@ export declare namespace Models {
|
|
|
8702
9036
|
* Hostname.
|
|
8703
9037
|
*/
|
|
8704
9038
|
hostname: string;
|
|
8705
|
-
/**
|
|
8706
|
-
* Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
|
|
8707
|
-
*/
|
|
8708
|
-
osCode: string;
|
|
8709
|
-
/**
|
|
8710
|
-
* Operating system name.
|
|
8711
|
-
*/
|
|
8712
|
-
osName: string;
|
|
8713
|
-
/**
|
|
8714
|
-
* Operating system version.
|
|
8715
|
-
*/
|
|
8716
|
-
osVersion: string;
|
|
8717
|
-
/**
|
|
8718
|
-
* Client type.
|
|
8719
|
-
*/
|
|
8720
|
-
clientType: string;
|
|
8721
|
-
/**
|
|
8722
|
-
* Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
|
|
8723
|
-
*/
|
|
8724
|
-
clientCode: string;
|
|
8725
|
-
/**
|
|
8726
|
-
* Client name.
|
|
8727
|
-
*/
|
|
8728
|
-
clientName: string;
|
|
8729
|
-
/**
|
|
8730
|
-
* Client version.
|
|
8731
|
-
*/
|
|
8732
|
-
clientVersion: string;
|
|
8733
|
-
/**
|
|
8734
|
-
* Client engine name.
|
|
8735
|
-
*/
|
|
8736
|
-
clientEngine: string;
|
|
8737
|
-
/**
|
|
8738
|
-
* Client engine name.
|
|
8739
|
-
*/
|
|
8740
|
-
clientEngineVersion: string;
|
|
8741
|
-
/**
|
|
8742
|
-
* Device name.
|
|
8743
|
-
*/
|
|
8744
|
-
deviceName: string;
|
|
8745
|
-
/**
|
|
8746
|
-
* Device brand name.
|
|
8747
|
-
*/
|
|
8748
|
-
deviceBrand: string;
|
|
8749
|
-
/**
|
|
8750
|
-
* Device model name.
|
|
8751
|
-
*/
|
|
8752
|
-
deviceModel: string;
|
|
8753
9039
|
/**
|
|
8754
9040
|
* Country two-character ISO 3166-1 alpha code.
|
|
8755
9041
|
*/
|
|
@@ -9070,17 +9356,116 @@ export declare namespace Models {
|
|
|
9070
9356
|
resourceType?: string;
|
|
9071
9357
|
};
|
|
9072
9358
|
/**
|
|
9073
|
-
*
|
|
9359
|
+
* Backup
|
|
9074
9360
|
*/
|
|
9075
|
-
export type
|
|
9361
|
+
export type DedicatedDatabaseBackup = {
|
|
9076
9362
|
/**
|
|
9077
|
-
*
|
|
9363
|
+
* Backup ID.
|
|
9078
9364
|
*/
|
|
9079
9365
|
$id: string;
|
|
9080
9366
|
/**
|
|
9081
|
-
*
|
|
9367
|
+
* Backup creation time in ISO 8601 format.
|
|
9082
9368
|
*/
|
|
9083
|
-
|
|
9369
|
+
$createdAt: string;
|
|
9370
|
+
/**
|
|
9371
|
+
* Database ID this backup belongs to.
|
|
9372
|
+
*/
|
|
9373
|
+
databaseId: string;
|
|
9374
|
+
/**
|
|
9375
|
+
* Project ID.
|
|
9376
|
+
*/
|
|
9377
|
+
projectId: string;
|
|
9378
|
+
/**
|
|
9379
|
+
* Backup policy ID when the backup was created by a schedule.
|
|
9380
|
+
*/
|
|
9381
|
+
policyId: string;
|
|
9382
|
+
/**
|
|
9383
|
+
* Backup trigger. Possible values: manual, schedule.
|
|
9384
|
+
*/
|
|
9385
|
+
trigger: string;
|
|
9386
|
+
/**
|
|
9387
|
+
* Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).
|
|
9388
|
+
*/
|
|
9389
|
+
type: string;
|
|
9390
|
+
/**
|
|
9391
|
+
* Backup status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error), verified (integrity check passed).
|
|
9392
|
+
*/
|
|
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;
|
|
9084
9469
|
/**
|
|
9085
9470
|
* Street address
|
|
9086
9471
|
*/
|
|
@@ -9359,6 +9744,10 @@ export declare namespace Models {
|
|
|
9359
9744
|
* Does plan support blocking free email addresses.
|
|
9360
9745
|
*/
|
|
9361
9746
|
supportsFreeEmailValidation: boolean;
|
|
9747
|
+
/**
|
|
9748
|
+
* Does plan support project-specific member roles.
|
|
9749
|
+
*/
|
|
9750
|
+
supportsProjectSpecificRoles: boolean;
|
|
9362
9751
|
/**
|
|
9363
9752
|
* Does plan support backup policies.
|
|
9364
9753
|
*/
|
|
@@ -9530,6 +9919,68 @@ export declare namespace Models {
|
|
|
9530
9919
|
*/
|
|
9531
9920
|
blocks: Block[];
|
|
9532
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
|
+
* Branch hostname for direct connections.
|
|
9944
|
+
*/
|
|
9945
|
+
host: string;
|
|
9946
|
+
/**
|
|
9947
|
+
* Branch port.
|
|
9948
|
+
*/
|
|
9949
|
+
port: number;
|
|
9950
|
+
/**
|
|
9951
|
+
* Database name the client sends for routing to the branch.
|
|
9952
|
+
*/
|
|
9953
|
+
database: string;
|
|
9954
|
+
/**
|
|
9955
|
+
* Database username. Shared with the parent database.
|
|
9956
|
+
*/
|
|
9957
|
+
username: string;
|
|
9958
|
+
/**
|
|
9959
|
+
* Database password. Shared with the parent database.
|
|
9960
|
+
*/
|
|
9961
|
+
password: string;
|
|
9962
|
+
/**
|
|
9963
|
+
* Whether SSL is required.
|
|
9964
|
+
*/
|
|
9965
|
+
ssl: boolean;
|
|
9966
|
+
/**
|
|
9967
|
+
* Database engine. Possible values: postgres, mysql, mariadb, mongodb.
|
|
9968
|
+
*/
|
|
9969
|
+
engine: string;
|
|
9970
|
+
/**
|
|
9971
|
+
* Full connection string for the branch.
|
|
9972
|
+
*/
|
|
9973
|
+
connectionString: string;
|
|
9974
|
+
};
|
|
9975
|
+
/**
|
|
9976
|
+
* BranchList
|
|
9977
|
+
*/
|
|
9978
|
+
export type DedicatedDatabaseBranchList = {
|
|
9979
|
+
/**
|
|
9980
|
+
* List of branches.
|
|
9981
|
+
*/
|
|
9982
|
+
branches: DedicatedDatabaseBranch[];
|
|
9983
|
+
};
|
|
9533
9984
|
/**
|
|
9534
9985
|
* Campaign
|
|
9535
9986
|
*/
|
|
@@ -9583,6 +10034,31 @@ export declare namespace Models {
|
|
|
9583
10034
|
*/
|
|
9584
10035
|
footer?: boolean;
|
|
9585
10036
|
};
|
|
10037
|
+
/**
|
|
10038
|
+
* Connection
|
|
10039
|
+
*/
|
|
10040
|
+
export type DedicatedDatabaseConnection = {
|
|
10041
|
+
/**
|
|
10042
|
+
* Connection ID.
|
|
10043
|
+
*/
|
|
10044
|
+
$id: string;
|
|
10045
|
+
/**
|
|
10046
|
+
* Connection username.
|
|
10047
|
+
*/
|
|
10048
|
+
username: string;
|
|
10049
|
+
/**
|
|
10050
|
+
* Database name.
|
|
10051
|
+
*/
|
|
10052
|
+
database: string;
|
|
10053
|
+
/**
|
|
10054
|
+
* Connection role. Common values: readonly, readwrite.
|
|
10055
|
+
*/
|
|
10056
|
+
role: string;
|
|
10057
|
+
/**
|
|
10058
|
+
* Connection creation date in ISO 8601 format.
|
|
10059
|
+
*/
|
|
10060
|
+
$createdAt: string;
|
|
10061
|
+
};
|
|
9586
10062
|
/**
|
|
9587
10063
|
* Coupon
|
|
9588
10064
|
*/
|
|
@@ -9620,6 +10096,59 @@ export declare namespace Models {
|
|
|
9620
10096
|
*/
|
|
9621
10097
|
onlyNewOrgs: boolean;
|
|
9622
10098
|
};
|
|
10099
|
+
/**
|
|
10100
|
+
* Credentials
|
|
10101
|
+
*/
|
|
10102
|
+
export type DedicatedDatabaseCredentials = {
|
|
10103
|
+
/**
|
|
10104
|
+
* Database ID.
|
|
10105
|
+
*/
|
|
10106
|
+
$id: string;
|
|
10107
|
+
/**
|
|
10108
|
+
* Database hostname.
|
|
10109
|
+
*/
|
|
10110
|
+
host: string;
|
|
10111
|
+
/**
|
|
10112
|
+
* Database port.
|
|
10113
|
+
*/
|
|
10114
|
+
port: number;
|
|
10115
|
+
/**
|
|
10116
|
+
* Database username.
|
|
10117
|
+
*/
|
|
10118
|
+
username: string;
|
|
10119
|
+
/**
|
|
10120
|
+
* Database password.
|
|
10121
|
+
*/
|
|
10122
|
+
password: string;
|
|
10123
|
+
/**
|
|
10124
|
+
* Database name.
|
|
10125
|
+
*/
|
|
10126
|
+
database: string;
|
|
10127
|
+
/**
|
|
10128
|
+
* Database TCP hostname or address.
|
|
10129
|
+
*/
|
|
10130
|
+
tcpHost: string;
|
|
10131
|
+
/**
|
|
10132
|
+
* Database TCP port.
|
|
10133
|
+
*/
|
|
10134
|
+
tcpPort: number;
|
|
10135
|
+
/**
|
|
10136
|
+
* Database name for direct TCP connections.
|
|
10137
|
+
*/
|
|
10138
|
+
tcpDatabase: string;
|
|
10139
|
+
/**
|
|
10140
|
+
* Database engine. Possible values: postgres, mysql, mariadb, mongodb.
|
|
10141
|
+
*/
|
|
10142
|
+
engine: string;
|
|
10143
|
+
/**
|
|
10144
|
+
* Whether SSL is required.
|
|
10145
|
+
*/
|
|
10146
|
+
ssl: boolean;
|
|
10147
|
+
/**
|
|
10148
|
+
* Full connection string.
|
|
10149
|
+
*/
|
|
10150
|
+
connectionString: string;
|
|
10151
|
+
};
|
|
9623
10152
|
/**
|
|
9624
10153
|
* Credit
|
|
9625
10154
|
*/
|
|
@@ -9695,6 +10224,331 @@ export declare namespace Models {
|
|
|
9695
10224
|
*/
|
|
9696
10225
|
available: number;
|
|
9697
10226
|
};
|
|
10227
|
+
/**
|
|
10228
|
+
* DedicatedDatabase
|
|
10229
|
+
*/
|
|
10230
|
+
export type DedicatedDatabase = {
|
|
10231
|
+
/**
|
|
10232
|
+
* Dedicated database ID.
|
|
10233
|
+
*/
|
|
10234
|
+
$id: string;
|
|
10235
|
+
/**
|
|
10236
|
+
* Database creation time in ISO 8601 format.
|
|
10237
|
+
*/
|
|
10238
|
+
$createdAt: string;
|
|
10239
|
+
/**
|
|
10240
|
+
* Database update date in ISO 8601 format.
|
|
10241
|
+
*/
|
|
10242
|
+
$updatedAt: string;
|
|
10243
|
+
/**
|
|
10244
|
+
* Project ID that owns this database.
|
|
10245
|
+
*/
|
|
10246
|
+
projectId: string;
|
|
10247
|
+
/**
|
|
10248
|
+
* Database display name.
|
|
10249
|
+
*/
|
|
10250
|
+
name: string;
|
|
10251
|
+
/**
|
|
10252
|
+
* Product API that owns this database: compute, documentsdb, or vectorsdb.
|
|
10253
|
+
*/
|
|
10254
|
+
api: string;
|
|
10255
|
+
/**
|
|
10256
|
+
* Database engine: postgres, mysql, mariadb, or mongodb.
|
|
10257
|
+
*/
|
|
10258
|
+
engine: string;
|
|
10259
|
+
/**
|
|
10260
|
+
* Database engine version.
|
|
10261
|
+
*/
|
|
10262
|
+
version: string;
|
|
10263
|
+
/**
|
|
10264
|
+
* Specification identifier.
|
|
10265
|
+
*/
|
|
10266
|
+
specification: string;
|
|
10267
|
+
/**
|
|
10268
|
+
* Database backend provider. Possible values: prisma, edge.
|
|
10269
|
+
*/
|
|
10270
|
+
backend: string;
|
|
10271
|
+
/**
|
|
10272
|
+
* Database hostname for connections.
|
|
10273
|
+
*/
|
|
10274
|
+
hostname: string;
|
|
10275
|
+
/**
|
|
10276
|
+
* Database port for connections.
|
|
10277
|
+
*/
|
|
10278
|
+
connectionPort: number;
|
|
10279
|
+
/**
|
|
10280
|
+
* Database username for connections.
|
|
10281
|
+
*/
|
|
10282
|
+
connectionUser: string;
|
|
10283
|
+
/**
|
|
10284
|
+
* Database password for connections.
|
|
10285
|
+
*/
|
|
10286
|
+
connectionPassword: string;
|
|
10287
|
+
/**
|
|
10288
|
+
* Full database connection string (URI format).
|
|
10289
|
+
*/
|
|
10290
|
+
connectionString: string;
|
|
10291
|
+
/**
|
|
10292
|
+
* Database status. Possible values: provisioning, ready, inactive, paused, failed, deleted, restoring, scaling.
|
|
10293
|
+
*/
|
|
10294
|
+
status: string;
|
|
10295
|
+
/**
|
|
10296
|
+
* Container status for lifecycle-managed database runtimes: active or inactive.
|
|
10297
|
+
*/
|
|
10298
|
+
containerStatus: string;
|
|
10299
|
+
/**
|
|
10300
|
+
* Last activity timestamp in ISO 8601 format.
|
|
10301
|
+
*/
|
|
10302
|
+
lastAccessedAt: string;
|
|
10303
|
+
/**
|
|
10304
|
+
* Timestamp when container will be considered idle and scale to zero (ISO 8601 format).
|
|
10305
|
+
*/
|
|
10306
|
+
idleUntil: string;
|
|
10307
|
+
/**
|
|
10308
|
+
* Minutes of inactivity before container scales to zero.
|
|
10309
|
+
*/
|
|
10310
|
+
idleTimeoutMinutes: number;
|
|
10311
|
+
/**
|
|
10312
|
+
* CPU allocated in millicores.
|
|
10313
|
+
*/
|
|
10314
|
+
cpu: number;
|
|
10315
|
+
/**
|
|
10316
|
+
* Memory allocated in MB.
|
|
10317
|
+
*/
|
|
10318
|
+
memory: number;
|
|
10319
|
+
/**
|
|
10320
|
+
* Storage allocated in GB.
|
|
10321
|
+
*/
|
|
10322
|
+
storage: number;
|
|
10323
|
+
/**
|
|
10324
|
+
* Storage class: ssd, nvme, or hdd.
|
|
10325
|
+
*/
|
|
10326
|
+
storageClass: string;
|
|
10327
|
+
/**
|
|
10328
|
+
* Maximum storage allowed in GB. 0 means use system default.
|
|
10329
|
+
*/
|
|
10330
|
+
storageMaxGb: number;
|
|
10331
|
+
/**
|
|
10332
|
+
* Kubernetes node pool where the database is scheduled.
|
|
10333
|
+
*/
|
|
10334
|
+
nodePool: string;
|
|
10335
|
+
/**
|
|
10336
|
+
* Number of high availability replicas. High availability is enabled when greater than 0.
|
|
10337
|
+
*/
|
|
10338
|
+
replicas: number;
|
|
10339
|
+
/**
|
|
10340
|
+
* Replication sync mode: async, sync, or quorum.
|
|
10341
|
+
*/
|
|
10342
|
+
highAvailabilitySyncMode: string;
|
|
10343
|
+
/**
|
|
10344
|
+
* Maximum concurrent connections.
|
|
10345
|
+
*/
|
|
10346
|
+
networkMaxConnections: number;
|
|
10347
|
+
/**
|
|
10348
|
+
* Connection idle timeout in seconds.
|
|
10349
|
+
*/
|
|
10350
|
+
networkIdleTimeoutSeconds: number;
|
|
10351
|
+
/**
|
|
10352
|
+
* IP addresses/CIDR ranges allowed to connect.
|
|
10353
|
+
*/
|
|
10354
|
+
networkIPAllowlist: string[];
|
|
10355
|
+
/**
|
|
10356
|
+
* Whether automatic backups are enabled.
|
|
10357
|
+
*/
|
|
10358
|
+
backupEnabled: boolean;
|
|
10359
|
+
/**
|
|
10360
|
+
* Whether point-in-time recovery is enabled.
|
|
10361
|
+
*/
|
|
10362
|
+
backupPitr: boolean;
|
|
10363
|
+
/**
|
|
10364
|
+
* Backup schedule in cron format.
|
|
10365
|
+
*/
|
|
10366
|
+
backupCron: string;
|
|
10367
|
+
/**
|
|
10368
|
+
* Number of days to retain backups.
|
|
10369
|
+
*/
|
|
10370
|
+
backupRetentionDays: number;
|
|
10371
|
+
/**
|
|
10372
|
+
* Number of days to retain PITR data.
|
|
10373
|
+
*/
|
|
10374
|
+
pitrRetentionDays: number;
|
|
10375
|
+
/**
|
|
10376
|
+
* Whether automatic storage expansion is enabled.
|
|
10377
|
+
*/
|
|
10378
|
+
storageAutoscaling: boolean;
|
|
10379
|
+
/**
|
|
10380
|
+
* Storage usage percentage that triggers automatic expansion.
|
|
10381
|
+
*/
|
|
10382
|
+
storageAutoscalingThresholdPercent: number;
|
|
10383
|
+
/**
|
|
10384
|
+
* Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
10385
|
+
*/
|
|
10386
|
+
storageAutoscalingMaxGb: number;
|
|
10387
|
+
/**
|
|
10388
|
+
* Day of the week for the maintenance window. Possible values: sun, mon, tue, wed, thu, fri, sat.
|
|
10389
|
+
*/
|
|
10390
|
+
maintenanceWindowDay: string;
|
|
10391
|
+
/**
|
|
10392
|
+
* Hour in UTC (0-23) when the maintenance window starts.
|
|
10393
|
+
*/
|
|
10394
|
+
maintenanceWindowHourUtc: number;
|
|
10395
|
+
/**
|
|
10396
|
+
* Whether metrics collection is enabled.
|
|
10397
|
+
*/
|
|
10398
|
+
metricsEnabled: boolean;
|
|
10399
|
+
/**
|
|
10400
|
+
* Whether the SQL API sidecar is enabled for this database.
|
|
10401
|
+
*/
|
|
10402
|
+
sqlApiEnabled: boolean;
|
|
10403
|
+
/**
|
|
10404
|
+
* Statement types accepted by the SQL API. Defaults to DML only; DDL/DCL types (CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE) are opt-in per database. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.
|
|
10405
|
+
*/
|
|
10406
|
+
sqlApiAllowedStatements: string[];
|
|
10407
|
+
/**
|
|
10408
|
+
* Maximum rows returned per SQL API execution. Results larger than this are truncated.
|
|
10409
|
+
*/
|
|
10410
|
+
sqlApiMaxRows: number;
|
|
10411
|
+
/**
|
|
10412
|
+
* Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.
|
|
10413
|
+
*/
|
|
10414
|
+
sqlApiMaxBytes: number;
|
|
10415
|
+
/**
|
|
10416
|
+
* Maximum server-side SQL API execution time in seconds before the query is cancelled.
|
|
10417
|
+
*/
|
|
10418
|
+
sqlApiTimeoutSeconds: number;
|
|
10419
|
+
/**
|
|
10420
|
+
* Error message if status is failed.
|
|
10421
|
+
*/
|
|
10422
|
+
error: string;
|
|
10423
|
+
};
|
|
10424
|
+
/**
|
|
10425
|
+
* Execution
|
|
10426
|
+
*/
|
|
10427
|
+
export type DedicatedDatabaseExecution = {
|
|
10428
|
+
/**
|
|
10429
|
+
* Result rows as a list of column-name => value maps. Empty for non-returning statements.
|
|
10430
|
+
*/
|
|
10431
|
+
rows: object;
|
|
10432
|
+
/**
|
|
10433
|
+
* Number of rows returned (for SELECT) or affected (for INSERT/UPDATE/DELETE).
|
|
10434
|
+
*/
|
|
10435
|
+
rowCount: number;
|
|
10436
|
+
/**
|
|
10437
|
+
* Column metadata in result-set order.
|
|
10438
|
+
*/
|
|
10439
|
+
columns: DedicatedDatabaseExecutionColumn[];
|
|
10440
|
+
/**
|
|
10441
|
+
* Server-side execution time in milliseconds.
|
|
10442
|
+
*/
|
|
10443
|
+
durationMs: number;
|
|
10444
|
+
/**
|
|
10445
|
+
* True when the configured row or byte cap was hit and the result was truncated.
|
|
10446
|
+
*/
|
|
10447
|
+
truncated: boolean;
|
|
10448
|
+
/**
|
|
10449
|
+
* Serialised payload size in bytes.
|
|
10450
|
+
*/
|
|
10451
|
+
bytes: number;
|
|
10452
|
+
};
|
|
10453
|
+
/**
|
|
10454
|
+
* ExecutionColumn
|
|
10455
|
+
*/
|
|
10456
|
+
export type DedicatedDatabaseExecutionColumn = {
|
|
10457
|
+
/**
|
|
10458
|
+
* Column name as returned by the database.
|
|
10459
|
+
*/
|
|
10460
|
+
name: string;
|
|
10461
|
+
/**
|
|
10462
|
+
* Engine-specific column type (e.g. int4, text, timestamptz).
|
|
10463
|
+
*/
|
|
10464
|
+
type: string;
|
|
10465
|
+
};
|
|
10466
|
+
/**
|
|
10467
|
+
* Restoration
|
|
10468
|
+
*/
|
|
10469
|
+
export type DedicatedDatabaseRestoration = {
|
|
10470
|
+
/**
|
|
10471
|
+
* Restoration ID.
|
|
10472
|
+
*/
|
|
10473
|
+
$id: string;
|
|
10474
|
+
/**
|
|
10475
|
+
* Restoration creation time in ISO 8601 format.
|
|
10476
|
+
*/
|
|
10477
|
+
$createdAt: string;
|
|
10478
|
+
/**
|
|
10479
|
+
* Database ID being restored.
|
|
10480
|
+
*/
|
|
10481
|
+
databaseId: string;
|
|
10482
|
+
/**
|
|
10483
|
+
* Project ID.
|
|
10484
|
+
*/
|
|
10485
|
+
projectId: string;
|
|
10486
|
+
/**
|
|
10487
|
+
* Backup ID used for restoration (null for PITR).
|
|
10488
|
+
*/
|
|
10489
|
+
backupId: string;
|
|
10490
|
+
/**
|
|
10491
|
+
* Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).
|
|
10492
|
+
*/
|
|
10493
|
+
type: string;
|
|
10494
|
+
/**
|
|
10495
|
+
* Restoration status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error).
|
|
10496
|
+
*/
|
|
10497
|
+
status: string;
|
|
10498
|
+
/**
|
|
10499
|
+
* Target time for PITR restoration in ISO 8601 format.
|
|
10500
|
+
*/
|
|
10501
|
+
targetTime: string;
|
|
10502
|
+
/**
|
|
10503
|
+
* Restoration start time in ISO 8601 format.
|
|
10504
|
+
*/
|
|
10505
|
+
startedAt: string;
|
|
10506
|
+
/**
|
|
10507
|
+
* Restoration completion time in ISO 8601 format.
|
|
10508
|
+
*/
|
|
10509
|
+
completedAt: string;
|
|
10510
|
+
/**
|
|
10511
|
+
* Error message if restoration failed.
|
|
10512
|
+
*/
|
|
10513
|
+
error: string;
|
|
10514
|
+
};
|
|
10515
|
+
/**
|
|
10516
|
+
* Status
|
|
10517
|
+
*/
|
|
10518
|
+
export type DatabaseStatus = {
|
|
10519
|
+
/**
|
|
10520
|
+
* Overall health status: healthy, degraded, or unhealthy.
|
|
10521
|
+
*/
|
|
10522
|
+
health: string;
|
|
10523
|
+
/**
|
|
10524
|
+
* Whether the database is ready to accept connections.
|
|
10525
|
+
*/
|
|
10526
|
+
ready: boolean;
|
|
10527
|
+
/**
|
|
10528
|
+
* Database engine: postgres, mysql, mariadb, or mongodb.
|
|
10529
|
+
*/
|
|
10530
|
+
engine: string;
|
|
10531
|
+
/**
|
|
10532
|
+
* Database engine version.
|
|
10533
|
+
*/
|
|
10534
|
+
version: string;
|
|
10535
|
+
/**
|
|
10536
|
+
* Database uptime in seconds.
|
|
10537
|
+
*/
|
|
10538
|
+
uptime: number;
|
|
10539
|
+
/**
|
|
10540
|
+
* Connection statistics.
|
|
10541
|
+
*/
|
|
10542
|
+
connections: DatabaseStatusConnections;
|
|
10543
|
+
/**
|
|
10544
|
+
* List of database replicas and their status.
|
|
10545
|
+
*/
|
|
10546
|
+
replicas: DatabaseStatusReplica[];
|
|
10547
|
+
/**
|
|
10548
|
+
* Storage volume information.
|
|
10549
|
+
*/
|
|
10550
|
+
volumes: DatabaseStatusVolume[];
|
|
10551
|
+
};
|
|
9698
10552
|
/**
|
|
9699
10553
|
* DNSRecord
|
|
9700
10554
|
*/
|
|
@@ -10096,6 +10950,61 @@ export declare namespace Models {
|
|
|
10096
10950
|
*/
|
|
10097
10951
|
organizationCredits: number;
|
|
10098
10952
|
};
|
|
10953
|
+
/**
|
|
10954
|
+
* Extensions
|
|
10955
|
+
*/
|
|
10956
|
+
export type DedicatedDatabaseExtensions = {
|
|
10957
|
+
/**
|
|
10958
|
+
* List of installed extensions.
|
|
10959
|
+
*/
|
|
10960
|
+
installed: string[];
|
|
10961
|
+
/**
|
|
10962
|
+
* List of available extensions that can be installed.
|
|
10963
|
+
*/
|
|
10964
|
+
available: string[];
|
|
10965
|
+
};
|
|
10966
|
+
/**
|
|
10967
|
+
* HAReplica
|
|
10968
|
+
*/
|
|
10969
|
+
export type DedicatedDatabaseHAReplica = {
|
|
10970
|
+
/**
|
|
10971
|
+
* Replica identifier.
|
|
10972
|
+
*/
|
|
10973
|
+
$id: string;
|
|
10974
|
+
/**
|
|
10975
|
+
* Replica role. Possible values: primary (accepts reads and writes), replica (read-only follower).
|
|
10976
|
+
*/
|
|
10977
|
+
role: string;
|
|
10978
|
+
/**
|
|
10979
|
+
* Replica health status. Possible values: healthy (fully synced), degraded (lagging behind primary), unhealthy (replication broken or unreachable).
|
|
10980
|
+
*/
|
|
10981
|
+
status: string;
|
|
10982
|
+
/**
|
|
10983
|
+
* Replication lag in seconds.
|
|
10984
|
+
*/
|
|
10985
|
+
lagSeconds: number;
|
|
10986
|
+
};
|
|
10987
|
+
/**
|
|
10988
|
+
* HAStatus
|
|
10989
|
+
*/
|
|
10990
|
+
export type DedicatedDatabaseHAStatus = {
|
|
10991
|
+
/**
|
|
10992
|
+
* Whether high availability is enabled.
|
|
10993
|
+
*/
|
|
10994
|
+
enabled: boolean;
|
|
10995
|
+
/**
|
|
10996
|
+
* Number of configured replicas.
|
|
10997
|
+
*/
|
|
10998
|
+
replicaCount: number;
|
|
10999
|
+
/**
|
|
11000
|
+
* Replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm).
|
|
11001
|
+
*/
|
|
11002
|
+
syncMode: string;
|
|
11003
|
+
/**
|
|
11004
|
+
* List of replica statuses.
|
|
11005
|
+
*/
|
|
11006
|
+
replicas: DedicatedDatabaseHAReplica[];
|
|
11007
|
+
};
|
|
10099
11008
|
/**
|
|
10100
11009
|
* Invoice
|
|
10101
11010
|
*/
|
|
@@ -10448,6 +11357,19 @@ export declare namespace Models {
|
|
|
10448
11357
|
*/
|
|
10449
11358
|
failed: boolean;
|
|
10450
11359
|
};
|
|
11360
|
+
/**
|
|
11361
|
+
* PITRWindows
|
|
11362
|
+
*/
|
|
11363
|
+
export type DedicatedDatabasePITRWindows = {
|
|
11364
|
+
/**
|
|
11365
|
+
* Earliest available recovery point.
|
|
11366
|
+
*/
|
|
11367
|
+
earliest: string;
|
|
11368
|
+
/**
|
|
11369
|
+
* Latest available recovery point.
|
|
11370
|
+
*/
|
|
11371
|
+
latest: string;
|
|
11372
|
+
};
|
|
10451
11373
|
/**
|
|
10452
11374
|
* PlanChangeEstimationDetails
|
|
10453
11375
|
*/
|
|
@@ -10612,10 +11534,98 @@ export declare namespace Models {
|
|
|
10612
11534
|
* Policy backup schedule in CRON format.
|
|
10613
11535
|
*/
|
|
10614
11536
|
schedule: string;
|
|
11537
|
+
/**
|
|
11538
|
+
* Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).
|
|
11539
|
+
*/
|
|
11540
|
+
type: string;
|
|
10615
11541
|
/**
|
|
10616
11542
|
* Is this policy enabled.
|
|
10617
11543
|
*/
|
|
10618
|
-
enabled: boolean;
|
|
11544
|
+
enabled: boolean;
|
|
11545
|
+
};
|
|
11546
|
+
/**
|
|
11547
|
+
* Policy Deny Aliased Email
|
|
11548
|
+
*/
|
|
11549
|
+
export type PolicyDenyAliasedEmail = {
|
|
11550
|
+
/**
|
|
11551
|
+
* Policy ID.
|
|
11552
|
+
*/
|
|
11553
|
+
$id: string;
|
|
11554
|
+
/**
|
|
11555
|
+
* Whether the deny aliased email policy is enabled.
|
|
11556
|
+
*/
|
|
11557
|
+
enabled: boolean;
|
|
11558
|
+
};
|
|
11559
|
+
/**
|
|
11560
|
+
* Policy Deny Disposable Email
|
|
11561
|
+
*/
|
|
11562
|
+
export type PolicyDenyDisposableEmail = {
|
|
11563
|
+
/**
|
|
11564
|
+
* Policy ID.
|
|
11565
|
+
*/
|
|
11566
|
+
$id: string;
|
|
11567
|
+
/**
|
|
11568
|
+
* Whether the deny disposable email policy is enabled.
|
|
11569
|
+
*/
|
|
11570
|
+
enabled: boolean;
|
|
11571
|
+
};
|
|
11572
|
+
/**
|
|
11573
|
+
* Policy Deny Free Email
|
|
11574
|
+
*/
|
|
11575
|
+
export type PolicyDenyFreeEmail = {
|
|
11576
|
+
/**
|
|
11577
|
+
* Policy ID.
|
|
11578
|
+
*/
|
|
11579
|
+
$id: string;
|
|
11580
|
+
/**
|
|
11581
|
+
* Whether the deny free email policy is enabled.
|
|
11582
|
+
*/
|
|
11583
|
+
enabled: boolean;
|
|
11584
|
+
};
|
|
11585
|
+
/**
|
|
11586
|
+
* PoolerConfig
|
|
11587
|
+
*/
|
|
11588
|
+
export type DedicatedDatabasePooler = {
|
|
11589
|
+
/**
|
|
11590
|
+
* Whether connection pooling is enabled.
|
|
11591
|
+
*/
|
|
11592
|
+
enabled: boolean;
|
|
11593
|
+
/**
|
|
11594
|
+
* Connection pool mode. Possible values: transaction (releases connections back to pool after each transaction), session (holds connections for the entire client session).
|
|
11595
|
+
*/
|
|
11596
|
+
mode: string;
|
|
11597
|
+
/**
|
|
11598
|
+
* Maximum number of pooled connections.
|
|
11599
|
+
*/
|
|
11600
|
+
maxConnections: number;
|
|
11601
|
+
/**
|
|
11602
|
+
* Default pool size per user.
|
|
11603
|
+
*/
|
|
11604
|
+
defaultPoolSize: number;
|
|
11605
|
+
/**
|
|
11606
|
+
* Pooler listening port.
|
|
11607
|
+
*/
|
|
11608
|
+
port: number;
|
|
11609
|
+
/**
|
|
11610
|
+
* Whether SELECTs are routed to HA replicas while writes and locked reads stay on the primary. Active only when HA is enabled.
|
|
11611
|
+
*/
|
|
11612
|
+
readWriteSplitting: boolean;
|
|
11613
|
+
/**
|
|
11614
|
+
* Effective CPU request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (5% of DB CPU, floor 100m) unless overridden.
|
|
11615
|
+
*/
|
|
11616
|
+
poolerCpuRequest: string;
|
|
11617
|
+
/**
|
|
11618
|
+
* Effective CPU limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (10% of DB CPU, floor 200m) unless overridden.
|
|
11619
|
+
*/
|
|
11620
|
+
poolerCpuLimit: string;
|
|
11621
|
+
/**
|
|
11622
|
+
* Effective memory request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (7.5% of DB memory, floor 64Mi) unless overridden.
|
|
11623
|
+
*/
|
|
11624
|
+
poolerMemoryRequest: string;
|
|
11625
|
+
/**
|
|
11626
|
+
* Effective memory limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (15% of DB memory, floor 128Mi) unless overridden.
|
|
11627
|
+
*/
|
|
11628
|
+
poolerMemoryLimit: string;
|
|
10619
11629
|
};
|
|
10620
11630
|
/**
|
|
10621
11631
|
* Program
|
|
@@ -10658,6 +11668,19 @@ export declare namespace Models {
|
|
|
10658
11668
|
*/
|
|
10659
11669
|
billingPlanId: string;
|
|
10660
11670
|
};
|
|
11671
|
+
/**
|
|
11672
|
+
* QueryExplanation
|
|
11673
|
+
*/
|
|
11674
|
+
export type DedicatedDatabaseQueryExplanation = {
|
|
11675
|
+
/**
|
|
11676
|
+
* Structured query execution plan. Contents are engine-specific.
|
|
11677
|
+
*/
|
|
11678
|
+
plan: Record<string, any>[];
|
|
11679
|
+
/**
|
|
11680
|
+
* Raw EXPLAIN output from the database engine.
|
|
11681
|
+
*/
|
|
11682
|
+
raw: string;
|
|
11683
|
+
};
|
|
10661
11684
|
/**
|
|
10662
11685
|
* Region
|
|
10663
11686
|
*/
|
|
@@ -10736,6 +11759,19 @@ export declare namespace Models {
|
|
|
10736
11759
|
*/
|
|
10737
11760
|
options: string;
|
|
10738
11761
|
};
|
|
11762
|
+
/**
|
|
11763
|
+
* Dedicated database restorations list
|
|
11764
|
+
*/
|
|
11765
|
+
export type DedicatedDatabaseRestorationList = {
|
|
11766
|
+
/**
|
|
11767
|
+
* Total number of restorations that matched your query.
|
|
11768
|
+
*/
|
|
11769
|
+
total: number;
|
|
11770
|
+
/**
|
|
11771
|
+
* List of restorations.
|
|
11772
|
+
*/
|
|
11773
|
+
restorations: DedicatedDatabaseRestoration[];
|
|
11774
|
+
};
|
|
10739
11775
|
/**
|
|
10740
11776
|
* Review
|
|
10741
11777
|
*/
|
|
@@ -10770,6 +11806,173 @@ export declare namespace Models {
|
|
|
10770
11806
|
*/
|
|
10771
11807
|
roles: string[];
|
|
10772
11808
|
};
|
|
11809
|
+
/**
|
|
11810
|
+
* SlowQuery
|
|
11811
|
+
*/
|
|
11812
|
+
export type DedicatedDatabaseSlowQuery = {
|
|
11813
|
+
/**
|
|
11814
|
+
* The SQL query text.
|
|
11815
|
+
*/
|
|
11816
|
+
query: string;
|
|
11817
|
+
/**
|
|
11818
|
+
* Query duration in milliseconds.
|
|
11819
|
+
*/
|
|
11820
|
+
durationMs: number;
|
|
11821
|
+
/**
|
|
11822
|
+
* Number of times this query has been executed.
|
|
11823
|
+
*/
|
|
11824
|
+
calls: number;
|
|
11825
|
+
/**
|
|
11826
|
+
* Database user that executed the query.
|
|
11827
|
+
*/
|
|
11828
|
+
user: string;
|
|
11829
|
+
/**
|
|
11830
|
+
* Database name.
|
|
11831
|
+
*/
|
|
11832
|
+
database: string;
|
|
11833
|
+
};
|
|
11834
|
+
/**
|
|
11835
|
+
* Specification
|
|
11836
|
+
*/
|
|
11837
|
+
export type DedicatedDatabaseSpecification = {
|
|
11838
|
+
/**
|
|
11839
|
+
* Specification slug. Use this value when creating a dedicated database.
|
|
11840
|
+
*/
|
|
11841
|
+
slug: string;
|
|
11842
|
+
/**
|
|
11843
|
+
* Human readable specification name.
|
|
11844
|
+
*/
|
|
11845
|
+
name: string;
|
|
11846
|
+
/**
|
|
11847
|
+
* Monthly price of the specification in USD.
|
|
11848
|
+
*/
|
|
11849
|
+
price: number;
|
|
11850
|
+
/**
|
|
11851
|
+
* Allocated CPU in millicores.
|
|
11852
|
+
*/
|
|
11853
|
+
cpu: number;
|
|
11854
|
+
/**
|
|
11855
|
+
* Allocated memory in MB.
|
|
11856
|
+
*/
|
|
11857
|
+
memory: number;
|
|
11858
|
+
/**
|
|
11859
|
+
* Maximum number of concurrent connections.
|
|
11860
|
+
*/
|
|
11861
|
+
maxConnections: number;
|
|
11862
|
+
/**
|
|
11863
|
+
* Included storage in GB before overage charges apply.
|
|
11864
|
+
*/
|
|
11865
|
+
includedStorage: number;
|
|
11866
|
+
/**
|
|
11867
|
+
* Included bandwidth in GB before overage charges apply.
|
|
11868
|
+
*/
|
|
11869
|
+
includedBandwidth: number;
|
|
11870
|
+
/**
|
|
11871
|
+
* Whether the specification is available on the current plan.
|
|
11872
|
+
*/
|
|
11873
|
+
enabled: boolean;
|
|
11874
|
+
};
|
|
11875
|
+
/**
|
|
11876
|
+
* SpecificationList
|
|
11877
|
+
*/
|
|
11878
|
+
export type DedicatedDatabaseSpecificationList = {
|
|
11879
|
+
/**
|
|
11880
|
+
* List of dedicated database specifications.
|
|
11881
|
+
*/
|
|
11882
|
+
specifications: DedicatedDatabaseSpecification[];
|
|
11883
|
+
/**
|
|
11884
|
+
* Total number of specifications.
|
|
11885
|
+
*/
|
|
11886
|
+
total: number;
|
|
11887
|
+
/**
|
|
11888
|
+
* Overage and add-on pricing shared across all specifications.
|
|
11889
|
+
*/
|
|
11890
|
+
pricing: DedicatedDatabaseSpecificationPricing;
|
|
11891
|
+
};
|
|
11892
|
+
/**
|
|
11893
|
+
* SpecificationPricing
|
|
11894
|
+
*/
|
|
11895
|
+
export type DedicatedDatabaseSpecificationPricing = {
|
|
11896
|
+
/**
|
|
11897
|
+
* Price per GB of storage above the included amount, per month, in USD.
|
|
11898
|
+
*/
|
|
11899
|
+
storageOverageRate: number;
|
|
11900
|
+
/**
|
|
11901
|
+
* Price per GB of bandwidth above the included amount, per month, in USD.
|
|
11902
|
+
*/
|
|
11903
|
+
bandwidthOverageRate: number;
|
|
11904
|
+
/**
|
|
11905
|
+
* High availability replica price as a fraction of the specification cost.
|
|
11906
|
+
*/
|
|
11907
|
+
haReplicaRate: number;
|
|
11908
|
+
/**
|
|
11909
|
+
* Cross-region replica price as a fraction of the specification cost.
|
|
11910
|
+
*/
|
|
11911
|
+
crossRegionReplicaRate: number;
|
|
11912
|
+
/**
|
|
11913
|
+
* Cross-region transfer price as a fraction of the specification cost.
|
|
11914
|
+
*/
|
|
11915
|
+
crossRegionRate: number;
|
|
11916
|
+
/**
|
|
11917
|
+
* Point-in-time recovery price as a fraction of the specification cost.
|
|
11918
|
+
*/
|
|
11919
|
+
pitrRate: number;
|
|
11920
|
+
};
|
|
11921
|
+
/**
|
|
11922
|
+
* Connections
|
|
11923
|
+
*/
|
|
11924
|
+
export type DatabaseStatusConnections = {
|
|
11925
|
+
/**
|
|
11926
|
+
* Current number of active connections.
|
|
11927
|
+
*/
|
|
11928
|
+
current: number;
|
|
11929
|
+
/**
|
|
11930
|
+
* Maximum allowed connections.
|
|
11931
|
+
*/
|
|
11932
|
+
max: number;
|
|
11933
|
+
};
|
|
11934
|
+
/**
|
|
11935
|
+
* Replica
|
|
11936
|
+
*/
|
|
11937
|
+
export type DatabaseStatusReplica = {
|
|
11938
|
+
/**
|
|
11939
|
+
* StatefulSet pod index (0 = primary, 1+ = replicas).
|
|
11940
|
+
*/
|
|
11941
|
+
index: number;
|
|
11942
|
+
/**
|
|
11943
|
+
* Replica role: primary or replica.
|
|
11944
|
+
*/
|
|
11945
|
+
role: string;
|
|
11946
|
+
/**
|
|
11947
|
+
* Whether the replica is healthy.
|
|
11948
|
+
*/
|
|
11949
|
+
healthy: boolean;
|
|
11950
|
+
/**
|
|
11951
|
+
* Replication lag in seconds (null for primary).
|
|
11952
|
+
*/
|
|
11953
|
+
lagSeconds?: number;
|
|
11954
|
+
};
|
|
11955
|
+
/**
|
|
11956
|
+
* Volume
|
|
11957
|
+
*/
|
|
11958
|
+
export type DatabaseStatusVolume = {
|
|
11959
|
+
/**
|
|
11960
|
+
* Mount path of the volume.
|
|
11961
|
+
*/
|
|
11962
|
+
path: string;
|
|
11963
|
+
/**
|
|
11964
|
+
* Percentage of storage used.
|
|
11965
|
+
*/
|
|
11966
|
+
usedPercent: string;
|
|
11967
|
+
/**
|
|
11968
|
+
* Available storage space.
|
|
11969
|
+
*/
|
|
11970
|
+
available: string;
|
|
11971
|
+
/**
|
|
11972
|
+
* Whether the volume is mounted.
|
|
11973
|
+
*/
|
|
11974
|
+
mounted: boolean;
|
|
11975
|
+
};
|
|
10773
11976
|
/**
|
|
10774
11977
|
* usageBillingPlan
|
|
10775
11978
|
*/
|
|
@@ -11140,6 +12343,161 @@ export declare namespace Models {
|
|
|
11140
12343
|
*/
|
|
11141
12344
|
resourceId: string;
|
|
11142
12345
|
};
|
|
12346
|
+
/**
|
|
12347
|
+
* App
|
|
12348
|
+
*/
|
|
12349
|
+
export type App = {
|
|
12350
|
+
/**
|
|
12351
|
+
* App ID.
|
|
12352
|
+
*/
|
|
12353
|
+
$id: string;
|
|
12354
|
+
/**
|
|
12355
|
+
* App creation time in ISO 8601 format.
|
|
12356
|
+
*/
|
|
12357
|
+
$createdAt: string;
|
|
12358
|
+
/**
|
|
12359
|
+
* App update date in ISO 8601 format.
|
|
12360
|
+
*/
|
|
12361
|
+
$updatedAt: string;
|
|
12362
|
+
/**
|
|
12363
|
+
* Application name.
|
|
12364
|
+
*/
|
|
12365
|
+
name: string;
|
|
12366
|
+
/**
|
|
12367
|
+
* Application description shown to users during OAuth2 consent.
|
|
12368
|
+
*/
|
|
12369
|
+
description: string;
|
|
12370
|
+
/**
|
|
12371
|
+
* Application homepage URL shown to users during OAuth2 consent.
|
|
12372
|
+
*/
|
|
12373
|
+
clientUri: string;
|
|
12374
|
+
/**
|
|
12375
|
+
* Application logo URL shown to users during OAuth2 consent.
|
|
12376
|
+
*/
|
|
12377
|
+
logoUri: string;
|
|
12378
|
+
/**
|
|
12379
|
+
* Application privacy policy URL shown to users during OAuth2 consent.
|
|
12380
|
+
*/
|
|
12381
|
+
privacyPolicyUrl: string;
|
|
12382
|
+
/**
|
|
12383
|
+
* Application terms of service URL shown to users during OAuth2 consent.
|
|
12384
|
+
*/
|
|
12385
|
+
termsUrl: string;
|
|
12386
|
+
/**
|
|
12387
|
+
* Application support or security contact emails.
|
|
12388
|
+
*/
|
|
12389
|
+
contacts: string[];
|
|
12390
|
+
/**
|
|
12391
|
+
* List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.
|
|
12392
|
+
*/
|
|
12393
|
+
redirectUris: string[];
|
|
12394
|
+
/**
|
|
12395
|
+
* Whether the app is enabled or not.
|
|
12396
|
+
*/
|
|
12397
|
+
enabled: boolean;
|
|
12398
|
+
/**
|
|
12399
|
+
* 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.
|
|
12400
|
+
*/
|
|
12401
|
+
type: string;
|
|
12402
|
+
/**
|
|
12403
|
+
* Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).
|
|
12404
|
+
*/
|
|
12405
|
+
deviceFlow: boolean;
|
|
12406
|
+
/**
|
|
12407
|
+
* ID of team that owns the application, if owned by team. Otherwise, user ID will be used.
|
|
12408
|
+
*/
|
|
12409
|
+
teamId: string;
|
|
12410
|
+
/**
|
|
12411
|
+
* ID of user who owns the application, if owned by user. Otherwise, team ID will be used.
|
|
12412
|
+
*/
|
|
12413
|
+
userId: string;
|
|
12414
|
+
/**
|
|
12415
|
+
* List of application secrets.
|
|
12416
|
+
*/
|
|
12417
|
+
secrets: AppSecret[];
|
|
12418
|
+
};
|
|
12419
|
+
/**
|
|
12420
|
+
* AppSecret
|
|
12421
|
+
*/
|
|
12422
|
+
export type AppSecret = {
|
|
12423
|
+
/**
|
|
12424
|
+
* Secret ID.
|
|
12425
|
+
*/
|
|
12426
|
+
$id: string;
|
|
12427
|
+
/**
|
|
12428
|
+
* Secret creation time in ISO 8601 format.
|
|
12429
|
+
*/
|
|
12430
|
+
$createdAt: string;
|
|
12431
|
+
/**
|
|
12432
|
+
* Secret update time in ISO 8601 format.
|
|
12433
|
+
*/
|
|
12434
|
+
$updatedAt: string;
|
|
12435
|
+
/**
|
|
12436
|
+
* Application ID this secret belongs to.
|
|
12437
|
+
*/
|
|
12438
|
+
appId: string;
|
|
12439
|
+
/**
|
|
12440
|
+
* Hashed application client secret.
|
|
12441
|
+
*/
|
|
12442
|
+
secret: string;
|
|
12443
|
+
/**
|
|
12444
|
+
* Last few characters of the client secret, used to help identify it.
|
|
12445
|
+
*/
|
|
12446
|
+
hint: string;
|
|
12447
|
+
/**
|
|
12448
|
+
* ID of the user who created the secret.
|
|
12449
|
+
*/
|
|
12450
|
+
createdById: string;
|
|
12451
|
+
/**
|
|
12452
|
+
* Name of the user who created the secret.
|
|
12453
|
+
*/
|
|
12454
|
+
createdByName: string;
|
|
12455
|
+
/**
|
|
12456
|
+
* Time the secret was last used for authentication in ISO 8601 format. Null if never used.
|
|
12457
|
+
*/
|
|
12458
|
+
lastAccessedAt?: string;
|
|
12459
|
+
};
|
|
12460
|
+
/**
|
|
12461
|
+
* AppSecretPlaintext
|
|
12462
|
+
*/
|
|
12463
|
+
export type AppSecretPlaintext = {
|
|
12464
|
+
/**
|
|
12465
|
+
* Secret ID.
|
|
12466
|
+
*/
|
|
12467
|
+
$id: string;
|
|
12468
|
+
/**
|
|
12469
|
+
* Secret creation time in ISO 8601 format.
|
|
12470
|
+
*/
|
|
12471
|
+
$createdAt: string;
|
|
12472
|
+
/**
|
|
12473
|
+
* Secret update time in ISO 8601 format.
|
|
12474
|
+
*/
|
|
12475
|
+
$updatedAt: string;
|
|
12476
|
+
/**
|
|
12477
|
+
* Application ID this secret belongs to.
|
|
12478
|
+
*/
|
|
12479
|
+
appId: string;
|
|
12480
|
+
/**
|
|
12481
|
+
* Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.
|
|
12482
|
+
*/
|
|
12483
|
+
secret: string;
|
|
12484
|
+
/**
|
|
12485
|
+
* Last few characters of the client secret, used to help identify it.
|
|
12486
|
+
*/
|
|
12487
|
+
hint: string;
|
|
12488
|
+
/**
|
|
12489
|
+
* ID of the user who created the secret.
|
|
12490
|
+
*/
|
|
12491
|
+
createdById: string;
|
|
12492
|
+
/**
|
|
12493
|
+
* Name of the user who created the secret.
|
|
12494
|
+
*/
|
|
12495
|
+
createdByName: string;
|
|
12496
|
+
/**
|
|
12497
|
+
* Time the secret was last used for authentication in ISO 8601 format. Null if never used.
|
|
12498
|
+
*/
|
|
12499
|
+
lastAccessedAt?: string;
|
|
12500
|
+
};
|
|
11143
12501
|
/**
|
|
11144
12502
|
* Activity event list
|
|
11145
12503
|
*/
|
|
@@ -11270,6 +12628,45 @@ export declare namespace Models {
|
|
|
11270
12628
|
*/
|
|
11271
12629
|
blocks: Block[];
|
|
11272
12630
|
};
|
|
12631
|
+
/**
|
|
12632
|
+
* Dedicated database connections list
|
|
12633
|
+
*/
|
|
12634
|
+
export type DedicatedDatabaseConnectionList = {
|
|
12635
|
+
/**
|
|
12636
|
+
* Total number of connections that matched your query.
|
|
12637
|
+
*/
|
|
12638
|
+
total: number;
|
|
12639
|
+
/**
|
|
12640
|
+
* List of connections.
|
|
12641
|
+
*/
|
|
12642
|
+
connections: DedicatedDatabaseConnection[];
|
|
12643
|
+
};
|
|
12644
|
+
/**
|
|
12645
|
+
* Dedicated database slow queries list
|
|
12646
|
+
*/
|
|
12647
|
+
export type DedicatedDatabaseSlowQueryList = {
|
|
12648
|
+
/**
|
|
12649
|
+
* Total number of slowQueries that matched your query.
|
|
12650
|
+
*/
|
|
12651
|
+
total: number;
|
|
12652
|
+
/**
|
|
12653
|
+
* List of slowQueries.
|
|
12654
|
+
*/
|
|
12655
|
+
slowQueries: DedicatedDatabaseSlowQuery[];
|
|
12656
|
+
};
|
|
12657
|
+
/**
|
|
12658
|
+
* Dedicated databases list
|
|
12659
|
+
*/
|
|
12660
|
+
export type DedicatedDatabaseList = {
|
|
12661
|
+
/**
|
|
12662
|
+
* Total number of databases that matched your query.
|
|
12663
|
+
*/
|
|
12664
|
+
total: number;
|
|
12665
|
+
/**
|
|
12666
|
+
* List of databases.
|
|
12667
|
+
*/
|
|
12668
|
+
databases: DedicatedDatabase[];
|
|
12669
|
+
};
|
|
11273
12670
|
/**
|
|
11274
12671
|
* DNS records list
|
|
11275
12672
|
*/
|
|
@@ -11374,5 +12771,31 @@ export declare namespace Models {
|
|
|
11374
12771
|
*/
|
|
11375
12772
|
gauges: UsageGauge[];
|
|
11376
12773
|
};
|
|
12774
|
+
/**
|
|
12775
|
+
* Apps list
|
|
12776
|
+
*/
|
|
12777
|
+
export type AppsList = {
|
|
12778
|
+
/**
|
|
12779
|
+
* Total number of apps that matched your query.
|
|
12780
|
+
*/
|
|
12781
|
+
total: number;
|
|
12782
|
+
/**
|
|
12783
|
+
* List of apps.
|
|
12784
|
+
*/
|
|
12785
|
+
apps: App[];
|
|
12786
|
+
};
|
|
12787
|
+
/**
|
|
12788
|
+
* App secrets list
|
|
12789
|
+
*/
|
|
12790
|
+
export type AppSecretList = {
|
|
12791
|
+
/**
|
|
12792
|
+
* Total number of secrets that matched your query.
|
|
12793
|
+
*/
|
|
12794
|
+
total: number;
|
|
12795
|
+
/**
|
|
12796
|
+
* List of secrets.
|
|
12797
|
+
*/
|
|
12798
|
+
secrets: AppSecret[];
|
|
12799
|
+
};
|
|
11377
12800
|
export {};
|
|
11378
12801
|
}
|