@appwrite.io/console 15.2.0 → 15.3.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.
Files changed (44) hide show
  1. package/README.md +3 -3
  2. package/dist/cjs/sdk.js +12031 -9316
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +12028 -9316
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +12031 -9316
  7. package/package.json +4 -4
  8. package/types/client.d.ts +11 -0
  9. package/types/enums/addon.d.ts +2 -0
  10. package/types/enums/block-mode.d.ts +4 -0
  11. package/types/enums/database-status.d.ts +5 -0
  12. package/types/enums/health-queue-name.d.ts +2 -1
  13. package/types/enums/o-auth-2-oidc-prompt.d.ts +6 -0
  14. package/types/enums/organization-key-scopes.d.ts +4 -0
  15. package/types/enums/project-key-scopes.d.ts +4 -0
  16. package/types/enums/project-o-auth-2-oidc-prompt.d.ts +6 -0
  17. package/types/enums/query-suggestion-resource.d.ts +3 -0
  18. package/types/index.d.ts +8 -1
  19. package/types/models.d.ts +526 -392
  20. package/types/query.d.ts +24 -0
  21. package/types/services/account.d.ts +4 -4
  22. package/types/services/backups.d.ts +10 -1
  23. package/types/services/console.d.ts +35 -0
  24. package/types/services/databases.d.ts +0 -78
  25. package/types/services/documents-db.d.ts +4 -71
  26. package/types/services/domains.d.ts +26 -2
  27. package/types/services/functions.d.ts +4 -4
  28. package/types/services/health.d.ts +33 -16
  29. package/types/services/locale.d.ts +2 -2
  30. package/types/services/manager.d.ts +5 -1
  31. package/types/services/messaging.d.ts +0 -100
  32. package/types/services/mongo.d.ts +792 -0
  33. package/types/services/mysql.d.ts +882 -0
  34. package/types/services/notifications.d.ts +51 -0
  35. package/types/services/oauth-2.d.ts +117 -9
  36. package/types/services/organization.d.ts +158 -6
  37. package/types/services/organizations.d.ts +21 -0
  38. package/types/services/{compute.d.ts → postgresql.d.ts} +193 -322
  39. package/types/services/project.d.ts +14 -7
  40. package/types/services/projects.d.ts +186 -0
  41. package/types/services/tables-db.d.ts +89 -57
  42. package/types/services/usage.d.ts +16 -22
  43. package/types/services/users.d.ts +2 -2
  44. package/types/services/vectors-db.d.ts +8 -73
package/types/models.d.ts CHANGED
@@ -11,6 +11,7 @@ import { ProjectAuthMethodId } from "./enums/project-auth-method-id";
11
11
  import { ProjectServiceId } from "./enums/project-service-id";
12
12
  import { ProjectProtocolId } from "./enums/project-protocol-id";
13
13
  import { OAuth2GooglePrompt } from "./enums/o-auth-2-google-prompt";
14
+ import { OAuth2OidcPrompt } from "./enums/o-auth-2-oidc-prompt";
14
15
  import { PlatformType } from "./enums/platform-type";
15
16
  import { HealthAntivirusStatus } from "./enums/health-antivirus-status";
16
17
  import { HealthCheckStatus } from "./enums/health-check-status";
@@ -168,6 +169,19 @@ export declare namespace Models {
168
169
  */
169
170
  identities: Identity[];
170
171
  };
172
+ /**
173
+ * Notifications List
174
+ */
175
+ export type NotificationList = {
176
+ /**
177
+ * Total number of notifications that matched your query.
178
+ */
179
+ total: number;
180
+ /**
181
+ * List of notifications.
182
+ */
183
+ notifications: Notification[];
184
+ };
171
185
  /**
172
186
  * Logs List
173
187
  */
@@ -618,6 +632,15 @@ export declare namespace Models {
618
632
  */
619
633
  schedules: Schedule[];
620
634
  };
635
+ /**
636
+ * Stages List
637
+ */
638
+ export type StageList = {
639
+ /**
640
+ * List of stages.
641
+ */
642
+ stages: Stage[];
643
+ };
621
644
  /**
622
645
  * Locale codes list
623
646
  */
@@ -828,6 +851,10 @@ export declare namespace Models {
828
851
  * Database type.
829
852
  */
830
853
  type: DatabaseType;
854
+ /**
855
+ * Database status. Possible values: `provisioning`, `ready` or `failed`
856
+ */
857
+ status: DatabaseStatus;
831
858
  /**
832
859
  * Database backup policies.
833
860
  */
@@ -1758,55 +1785,6 @@ export declare namespace Models {
1758
1785
  */
1759
1786
  encrypt?: boolean;
1760
1787
  };
1761
- /**
1762
- * UsageDocumentsDB
1763
- */
1764
- export type UsageDocumentsDB = {
1765
- /**
1766
- * Time range of the usage stats.
1767
- */
1768
- range: string;
1769
- /**
1770
- * Total aggregated number of collections.
1771
- */
1772
- collectionsTotal: number;
1773
- /**
1774
- * Total aggregated number of documents.
1775
- */
1776
- documentsTotal: number;
1777
- /**
1778
- * Total aggregated storage used in bytes.
1779
- */
1780
- storageTotal: number;
1781
- /**
1782
- * Total number of database reads.
1783
- */
1784
- databaseReadsTotal: number;
1785
- /**
1786
- * Total number of database writes.
1787
- */
1788
- databaseWritesTotal: number;
1789
- /**
1790
- * Aggregated number of collections per period.
1791
- */
1792
- collections: Metric[];
1793
- /**
1794
- * Aggregated number of documents per period.
1795
- */
1796
- documents: Metric[];
1797
- /**
1798
- * Aggregated storage used in bytes per period.
1799
- */
1800
- storage: Metric[];
1801
- /**
1802
- * An array of aggregated number of database reads.
1803
- */
1804
- databaseReads: Metric[];
1805
- /**
1806
- * An array of aggregated number of database writes.
1807
- */
1808
- databaseWrites: Metric[];
1809
- };
1810
1788
  /**
1811
1789
  * VectorsDB Collection
1812
1790
  */
@@ -1942,112 +1920,6 @@ export declare namespace Models {
1942
1920
  */
1943
1921
  size: number;
1944
1922
  };
1945
- /**
1946
- * UsageVectorsDBs
1947
- */
1948
- export type UsageVectorsDBs = {
1949
- /**
1950
- * Time range of the usage stats.
1951
- */
1952
- range: string;
1953
- /**
1954
- * Total aggregated number of VectorsDB databases.
1955
- */
1956
- databasesTotal: number;
1957
- /**
1958
- * Total aggregated number of collections.
1959
- */
1960
- collectionsTotal: number;
1961
- /**
1962
- * Total aggregated number of documents.
1963
- */
1964
- documentsTotal: number;
1965
- /**
1966
- * Total aggregated storage in bytes.
1967
- */
1968
- storageTotal: number;
1969
- /**
1970
- * Total number of database reads.
1971
- */
1972
- databasesReadsTotal: number;
1973
- /**
1974
- * Total number of database writes.
1975
- */
1976
- databasesWritesTotal: number;
1977
- /**
1978
- * Aggregated number of databases per period.
1979
- */
1980
- databases: Metric[];
1981
- /**
1982
- * Aggregated number of collections per period.
1983
- */
1984
- collections: Metric[];
1985
- /**
1986
- * Aggregated number of documents per period.
1987
- */
1988
- documents: Metric[];
1989
- /**
1990
- * Aggregated storage in bytes per period.
1991
- */
1992
- storage: Metric[];
1993
- /**
1994
- * An array of aggregated number of database reads.
1995
- */
1996
- databasesReads: Metric[];
1997
- /**
1998
- * An array of aggregated number of database writes.
1999
- */
2000
- databasesWrites: Metric[];
2001
- };
2002
- /**
2003
- * UsageVectorsDB
2004
- */
2005
- export type UsageVectorsDB = {
2006
- /**
2007
- * Time range of the usage stats.
2008
- */
2009
- range: string;
2010
- /**
2011
- * Total aggregated number of collections.
2012
- */
2013
- collectionsTotal: number;
2014
- /**
2015
- * Total aggregated number of documents.
2016
- */
2017
- documentsTotal: number;
2018
- /**
2019
- * Total aggregated storage used in bytes.
2020
- */
2021
- storageTotal: number;
2022
- /**
2023
- * Total number of database reads.
2024
- */
2025
- databaseReadsTotal: number;
2026
- /**
2027
- * Total number of database writes.
2028
- */
2029
- databaseWritesTotal: number;
2030
- /**
2031
- * Aggregated number of collections per period.
2032
- */
2033
- collections: Metric[];
2034
- /**
2035
- * Aggregated number of documents per period.
2036
- */
2037
- documents: Metric[];
2038
- /**
2039
- * Aggregated storage used in bytes per period.
2040
- */
2041
- storage: Metric[];
2042
- /**
2043
- * An array of aggregated number of database reads.
2044
- */
2045
- databaseReads: Metric[];
2046
- /**
2047
- * An array of aggregated number of database writes.
2048
- */
2049
- databaseWrites: Metric[];
2050
- };
2051
1923
  /**
2052
1924
  * Table
2053
1925
  */
@@ -3178,7 +3050,7 @@ export declare namespace Models {
3178
3050
  */
3179
3051
  mode: string;
3180
3052
  /**
3181
- * User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.
3053
+ * User type who triggered the audit log. Possible values: user, admin, guest, hidden, keyProject, keyAccount, keyOrganization.
3182
3054
  */
3183
3055
  userType: string;
3184
3056
  /**
@@ -3632,6 +3504,75 @@ export declare namespace Models {
3632
3504
  */
3633
3505
  providerRefreshToken: string;
3634
3506
  };
3507
+ /**
3508
+ * Notification
3509
+ */
3510
+ export type Notification = {
3511
+ /**
3512
+ * Notification ID.
3513
+ */
3514
+ $id: string;
3515
+ /**
3516
+ * Notification creation date in ISO 8601 format.
3517
+ */
3518
+ $createdAt: string;
3519
+ /**
3520
+ * Notification update date in ISO 8601 format.
3521
+ */
3522
+ $updatedAt: string;
3523
+ /**
3524
+ * Stable message ID used for dedup.
3525
+ */
3526
+ messageId?: string;
3527
+ /**
3528
+ * Notification type: info, warning, error.
3529
+ */
3530
+ type: string;
3531
+ /**
3532
+ * Channel: email, sms, push, console, webhook.
3533
+ */
3534
+ channel: string;
3535
+ /**
3536
+ * Resource type this notification is addressed to.
3537
+ */
3538
+ resourceType: string;
3539
+ /**
3540
+ * Resource ID this notification is addressed to.
3541
+ */
3542
+ resourceId: string;
3543
+ /**
3544
+ * Parent resource type for the notification.
3545
+ */
3546
+ parentResourceType: string;
3547
+ /**
3548
+ * Parent resource ID for the notification.
3549
+ */
3550
+ parentResourceId: string;
3551
+ /**
3552
+ * Project the notification pertains to.
3553
+ */
3554
+ projectId?: string;
3555
+ /**
3556
+ * Notification title.
3557
+ */
3558
+ title: string;
3559
+ /**
3560
+ * Notification body.
3561
+ */
3562
+ body: string;
3563
+ /**
3564
+ * Whether the notification has been read.
3565
+ */
3566
+ read?: boolean;
3567
+ /**
3568
+ * First time the notification was viewed from a notification logo.
3569
+ */
3570
+ firstSeen?: string;
3571
+ /**
3572
+ * Most recent time the notification was viewed from a notification logo.
3573
+ */
3574
+ lastSeen?: string;
3575
+ };
3635
3576
  /**
3636
3577
  * Token
3637
3578
  */
@@ -3670,39 +3611,6 @@ export declare namespace Models {
3670
3611
  */
3671
3612
  jwt: string;
3672
3613
  };
3673
- /**
3674
- * Locale
3675
- */
3676
- export type Locale = {
3677
- /**
3678
- * User IP address.
3679
- */
3680
- ip: string;
3681
- /**
3682
- * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
3683
- */
3684
- countryCode: string;
3685
- /**
3686
- * Country name. This field support localization.
3687
- */
3688
- country: string;
3689
- /**
3690
- * Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America.
3691
- */
3692
- continentCode: string;
3693
- /**
3694
- * Continent name. This field support localization.
3695
- */
3696
- continent: string;
3697
- /**
3698
- * True if country is part of the European Union.
3699
- */
3700
- eu: boolean;
3701
- /**
3702
- * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
3703
- */
3704
- currency: string;
3705
- };
3706
3614
  /**
3707
3615
  * LocaleCode
3708
3616
  */
@@ -5094,6 +5002,10 @@ export declare namespace Models {
5094
5002
  * Project status
5095
5003
  */
5096
5004
  status: string;
5005
+ /**
5006
+ * Stage progress (completed or skipped) with timestamps and actor types, keyed by stage id.
5007
+ */
5008
+ onboarding: object;
5097
5009
  /**
5098
5010
  * List of auth methods.
5099
5011
  */
@@ -6210,6 +6122,14 @@ export declare namespace Models {
6210
6122
  * OpenID Connect user info endpoint URL.
6211
6123
  */
6212
6124
  userInfoURL: string;
6125
+ /**
6126
+ * OpenID Connect prompt values controlling the authentication and consent screens.
6127
+ */
6128
+ prompt: OAuth2OidcPrompt[];
6129
+ /**
6130
+ * Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds.
6131
+ */
6132
+ maxAge?: number;
6213
6133
  };
6214
6134
  /**
6215
6135
  * OAuth2Okta
@@ -7917,14 +7837,6 @@ export declare namespace Models {
7917
7837
  * Total aggregated number of screenshots generated.
7918
7838
  */
7919
7839
  screenshotsGeneratedTotal: number;
7920
- /**
7921
- * An array of aggregated number of Imagine credits in the given period.
7922
- */
7923
- imagineCredits: Metric[];
7924
- /**
7925
- * Total aggregated number of Imagine credits.
7926
- */
7927
- imagineCreditsTotal: number;
7928
7840
  /**
7929
7841
  * Current aggregated number of open Realtime connections.
7930
7842
  */
@@ -8098,6 +8010,31 @@ export declare namespace Models {
8098
8010
  */
8099
8011
  region: string;
8100
8012
  };
8013
+ /**
8014
+ * Stage
8015
+ */
8016
+ export type Stage = {
8017
+ /**
8018
+ * Stage ID.
8019
+ */
8020
+ id: string;
8021
+ /**
8022
+ * SDK method key (namespace.name) for this stage.
8023
+ */
8024
+ sdk: string;
8025
+ /**
8026
+ * Stage status.
8027
+ */
8028
+ status: string;
8029
+ /**
8030
+ * When the stage was completed or skipped, in ISO 8601 format.
8031
+ */
8032
+ at: string;
8033
+ /**
8034
+ * Actor type when the stage was recorded.
8035
+ */
8036
+ actorType: string;
8037
+ };
8101
8038
  /**
8102
8039
  * EmailTemplate
8103
8040
  */
@@ -9036,14 +8973,6 @@ export declare namespace Models {
9036
8973
  * Hostname.
9037
8974
  */
9038
8975
  hostname: string;
9039
- /**
9040
- * Country two-character ISO 3166-1 alpha code.
9041
- */
9042
- countryCode: string;
9043
- /**
9044
- * Country name.
9045
- */
9046
- countryName: string;
9047
8976
  };
9048
8977
  /**
9049
8978
  * AdditionalResource
@@ -9398,19 +9327,19 @@ export declare namespace Models {
9398
9327
  /**
9399
9328
  * Backup start time in ISO 8601 format.
9400
9329
  */
9401
- startedAt: string;
9330
+ startedAt?: string;
9402
9331
  /**
9403
9332
  * Backup completion time in ISO 8601 format.
9404
9333
  */
9405
- completedAt: string;
9334
+ completedAt?: string;
9406
9335
  /**
9407
9336
  * Backup verification time in ISO 8601 format.
9408
9337
  */
9409
- verifiedAt: string;
9338
+ verifiedAt?: string;
9410
9339
  /**
9411
9340
  * Backup expiration time in ISO 8601 format.
9412
9341
  */
9413
- expiresAt: string;
9342
+ expiresAt?: string;
9414
9343
  /**
9415
9344
  * Error message if backup failed.
9416
9345
  */
@@ -9665,9 +9594,13 @@ export declare namespace Models {
9665
9594
  */
9666
9595
  domains: number;
9667
9596
  /**
9668
- * Log days
9597
+ * Activity log days
9598
+ */
9599
+ activityLogs: number;
9600
+ /**
9601
+ * Usage history days
9669
9602
  */
9670
- logs: number;
9603
+ usageLogs: number;
9671
9604
  /**
9672
9605
  * Number of days of console inactivity before a project is paused. 0 means pausing is disabled.
9673
9606
  */
@@ -9792,6 +9725,10 @@ export declare namespace Models {
9792
9725
  * Details of the program this plan is a part of.
9793
9726
  */
9794
9727
  program?: Program;
9728
+ /**
9729
+ * Dedicated database limits available to this plan.
9730
+ */
9731
+ dedicatedDatabases?: BillingPlanDedicatedDatabaseLimits;
9795
9732
  };
9796
9733
  /**
9797
9734
  * Addon
@@ -9856,6 +9793,91 @@ export declare namespace Models {
9856
9793
  */
9857
9794
  dailyCredits?: number;
9858
9795
  };
9796
+ /**
9797
+ * dedicatedDatabaseLimits
9798
+ */
9799
+ export type BillingPlanDedicatedDatabaseLimits = {
9800
+ /**
9801
+ * Minimum CPU allocation in millicores.
9802
+ */
9803
+ minCpu?: number;
9804
+ /**
9805
+ * Maximum CPU allocation in millicores.
9806
+ */
9807
+ maxCpu?: number;
9808
+ /**
9809
+ * Minimum memory allocation in megabytes.
9810
+ */
9811
+ minMemoryMb?: number;
9812
+ /**
9813
+ * Maximum memory allocation in megabytes.
9814
+ */
9815
+ maxMemoryMb?: number;
9816
+ /**
9817
+ * Minimum storage allocation in gigabytes.
9818
+ */
9819
+ minStorageGb?: number;
9820
+ /**
9821
+ * Maximum storage allocation in gigabytes.
9822
+ */
9823
+ maxStorageGb?: number;
9824
+ /**
9825
+ * Maximum number of dedicated databases per project.
9826
+ */
9827
+ maxDatabasesPerProject?: number;
9828
+ /**
9829
+ * Maximum number of high-availability replicas per dedicated database.
9830
+ */
9831
+ maxReplicas?: number;
9832
+ /**
9833
+ * Maximum number of client connections.
9834
+ */
9835
+ maxConnections?: number;
9836
+ /**
9837
+ * Maximum number of entries allowed in the IP allowlist.
9838
+ */
9839
+ maxIpAllowlistSize?: number;
9840
+ /**
9841
+ * Maximum number of database extensions that can be enabled.
9842
+ */
9843
+ maxExtensions?: number;
9844
+ /**
9845
+ * Maximum number of days a backup can be retained.
9846
+ */
9847
+ maxBackupRetentionDays?: number;
9848
+ /**
9849
+ * Maximum number of days of point-in-time recovery data that can be retained.
9850
+ */
9851
+ maxPitrRetentionDays?: number;
9852
+ /**
9853
+ * Maximum number of rows a single SQL API query can return.
9854
+ */
9855
+ maxSqlApiMaxRows?: number;
9856
+ /**
9857
+ * Maximum response size in bytes for a single SQL API query.
9858
+ */
9859
+ maxSqlApiMaxBytes?: number;
9860
+ /**
9861
+ * Maximum execution time in seconds for a single SQL API query.
9862
+ */
9863
+ maxSqlApiTimeoutSeconds?: number;
9864
+ /**
9865
+ * Maximum number of SQL statement types that can be permitted through the SQL API.
9866
+ */
9867
+ maxSqlApiAllowedStatements?: number;
9868
+ /**
9869
+ * SQL statement types permitted through the SQL API.
9870
+ */
9871
+ allowedSqlStatements?: string[];
9872
+ /**
9873
+ * Storage classes available for dedicated databases.
9874
+ */
9875
+ allowedStorageClasses?: string[];
9876
+ /**
9877
+ * Replica synchronization modes available for dedicated databases.
9878
+ */
9879
+ allowedSyncModes?: string[];
9880
+ };
9859
9881
  /**
9860
9882
  * BillingPlanSupportedAddons
9861
9883
  */
@@ -9864,6 +9886,14 @@ export declare namespace Models {
9864
9886
  * Whether the plan supports BAA (Business Associate Agreement) addon
9865
9887
  */
9866
9888
  baa: boolean;
9889
+ /**
9890
+ * Whether the plan supports Premium Geo DB addon (project-level)
9891
+ */
9892
+ premiumGeoDB: boolean;
9893
+ /**
9894
+ * Whether the plan supports Premium Geo DB addon (organization-level)
9895
+ */
9896
+ premiumGeoDBOrg: boolean;
9867
9897
  };
9868
9898
  /**
9869
9899
  * Block
@@ -9881,6 +9911,10 @@ export declare namespace Models {
9881
9911
  * Resource identifier that is blocked
9882
9912
  */
9883
9913
  resourceId: string;
9914
+ /**
9915
+ * Block mode. full blocks reads and writes; readOnly blocks writes only.
9916
+ */
9917
+ mode: string;
9884
9918
  /**
9885
9919
  * Reason for the block. Can be null if no reason was provided.
9886
9920
  */
@@ -9968,7 +10002,7 @@ export declare namespace Models {
9968
10002
  */
9969
10003
  ssl: boolean;
9970
10004
  /**
9971
- * Database engine. Possible values: postgres, mysql, mariadb, mongodb.
10005
+ * Database engine. Possible values: postgresql, mysql, mariadb, mongodb.
9972
10006
  */
9973
10007
  engine: string;
9974
10008
  /**
@@ -10038,31 +10072,6 @@ export declare namespace Models {
10038
10072
  */
10039
10073
  footer?: boolean;
10040
10074
  };
10041
- /**
10042
- * Connection
10043
- */
10044
- export type DedicatedDatabaseConnection = {
10045
- /**
10046
- * Connection ID.
10047
- */
10048
- $id: string;
10049
- /**
10050
- * Connection username.
10051
- */
10052
- username: string;
10053
- /**
10054
- * Database name.
10055
- */
10056
- database: string;
10057
- /**
10058
- * Connection role. Common values: readonly, readwrite.
10059
- */
10060
- role: string;
10061
- /**
10062
- * Connection creation date in ISO 8601 format.
10063
- */
10064
- $createdAt: string;
10065
- };
10066
10075
  /**
10067
10076
  * Coupon
10068
10077
  */
@@ -10100,59 +10109,6 @@ export declare namespace Models {
10100
10109
  */
10101
10110
  onlyNewOrgs: boolean;
10102
10111
  };
10103
- /**
10104
- * Credentials
10105
- */
10106
- export type DedicatedDatabaseCredentials = {
10107
- /**
10108
- * Database ID.
10109
- */
10110
- $id: string;
10111
- /**
10112
- * Database hostname.
10113
- */
10114
- host: string;
10115
- /**
10116
- * Database port.
10117
- */
10118
- port: number;
10119
- /**
10120
- * Database username.
10121
- */
10122
- username: string;
10123
- /**
10124
- * Database password.
10125
- */
10126
- password: string;
10127
- /**
10128
- * Database name.
10129
- */
10130
- database: string;
10131
- /**
10132
- * Database TCP hostname or address.
10133
- */
10134
- tcpHost: string;
10135
- /**
10136
- * Database TCP port.
10137
- */
10138
- tcpPort: number;
10139
- /**
10140
- * Database name for direct TCP connections.
10141
- */
10142
- tcpDatabase: string;
10143
- /**
10144
- * Database engine. Possible values: postgres, mysql, mariadb, mongodb.
10145
- */
10146
- engine: string;
10147
- /**
10148
- * Whether SSL is required.
10149
- */
10150
- ssl: boolean;
10151
- /**
10152
- * Full connection string.
10153
- */
10154
- connectionString: string;
10155
- };
10156
10112
  /**
10157
10113
  * Credit
10158
10114
  */
@@ -10228,6 +10184,63 @@ export declare namespace Models {
10228
10184
  */
10229
10185
  available: number;
10230
10186
  };
10187
+ /**
10188
+ * Database Migration
10189
+ */
10190
+ export type DatabaseMigration = {
10191
+ /**
10192
+ * Database migration ID.
10193
+ */
10194
+ $id: string;
10195
+ /**
10196
+ * Migration creation time in ISO 8601 format.
10197
+ */
10198
+ $createdAt: string;
10199
+ /**
10200
+ * Migration update time in ISO 8601 format.
10201
+ */
10202
+ $updatedAt: string;
10203
+ /**
10204
+ * Project ID that owns the migrating database.
10205
+ */
10206
+ projectId: string;
10207
+ /**
10208
+ * Logical database ID being migrated.
10209
+ */
10210
+ databaseId: string;
10211
+ /**
10212
+ * Dedicated compute specification provisioned for the migration target.
10213
+ */
10214
+ specification: string;
10215
+ /**
10216
+ * Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.
10217
+ */
10218
+ phase: string;
10219
+ /**
10220
+ * Number of documents still pending replication to the target.
10221
+ */
10222
+ lagDocuments: number;
10223
+ /**
10224
+ * Time the migrated data was verified against the source in ISO 8601 format.
10225
+ */
10226
+ verifiedAt: string;
10227
+ /**
10228
+ * Time routing was flipped to the target in ISO 8601 format.
10229
+ */
10230
+ cutoverAt: string;
10231
+ /**
10232
+ * Time the post-cutover soak window ends in ISO 8601 format.
10233
+ */
10234
+ soakUntil: string;
10235
+ /**
10236
+ * Whether the migration cuts over automatically once ready.
10237
+ */
10238
+ autoCutover: boolean;
10239
+ /**
10240
+ * Whether the migration is paused.
10241
+ */
10242
+ paused: boolean;
10243
+ };
10231
10244
  /**
10232
10245
  * DedicatedDatabase
10233
10246
  */
@@ -10253,11 +10266,11 @@ export declare namespace Models {
10253
10266
  */
10254
10267
  name: string;
10255
10268
  /**
10256
- * Product API that owns this database: compute, documentsdb, or vectorsdb.
10269
+ * Product API that owns this database: nativedb, documentsdb, or vectorsdb.
10257
10270
  */
10258
10271
  api: string;
10259
10272
  /**
10260
- * Database engine: postgres, mysql, mariadb, or mongodb.
10273
+ * Database engine: postgresql, mysql, mariadb, or mongodb.
10261
10274
  */
10262
10275
  engine: string;
10263
10276
  /**
@@ -10303,11 +10316,15 @@ export declare namespace Models {
10303
10316
  /**
10304
10317
  * Last activity timestamp in ISO 8601 format.
10305
10318
  */
10306
- lastAccessedAt: string;
10319
+ lastAccessedAt?: string;
10307
10320
  /**
10308
- * Timestamp when container will be considered idle and scale to zero (ISO 8601 format).
10321
+ * Display-only timestamp when the database is expected to be considered idle (ISO 8601 format). Derived from last activity; lifecycle transitions are driven by lifecycleState.
10309
10322
  */
10310
- idleUntil: string;
10323
+ idleUntil?: string;
10324
+ /**
10325
+ * Idle-lifecycle state of the database. Possible values: active, warm, cold, hibernated.
10326
+ */
10327
+ lifecycleState: string;
10311
10328
  /**
10312
10329
  * Minutes of inactivity before container scales to zero.
10313
10330
  */
@@ -10343,7 +10360,7 @@ export declare namespace Models {
10343
10360
  /**
10344
10361
  * Replication sync mode: async, sync, or quorum.
10345
10362
  */
10346
- highAvailabilitySyncMode: string;
10363
+ syncMode: string;
10347
10364
  /**
10348
10365
  * Maximum concurrent connections.
10349
10366
  */
@@ -10363,15 +10380,7 @@ export declare namespace Models {
10363
10380
  /**
10364
10381
  * Whether point-in-time recovery is enabled.
10365
10382
  */
10366
- backupPitr: boolean;
10367
- /**
10368
- * Backup schedule in cron format.
10369
- */
10370
- backupCron: string;
10371
- /**
10372
- * Number of days to retain backups.
10373
- */
10374
- backupRetentionDays: number;
10383
+ pitr: boolean;
10375
10384
  /**
10376
10385
  * Number of days to retain PITR data.
10377
10386
  */
@@ -10529,7 +10538,7 @@ export declare namespace Models {
10529
10538
  */
10530
10539
  ready: boolean;
10531
10540
  /**
10532
- * Database engine: postgres, mysql, mariadb, or mongodb.
10541
+ * Database engine: postgresql, mysql, mariadb, or mongodb.
10533
10542
  */
10534
10543
  engine: string;
10535
10544
  /**
@@ -10968,19 +10977,19 @@ export declare namespace Models {
10968
10977
  available: string[];
10969
10978
  };
10970
10979
  /**
10971
- * HAReplica
10980
+ * Member
10972
10981
  */
10973
- export type DedicatedDatabaseHAReplica = {
10982
+ export type DedicatedDatabaseMember = {
10974
10983
  /**
10975
- * Replica identifier.
10984
+ * Member identifier.
10976
10985
  */
10977
10986
  $id: string;
10978
10987
  /**
10979
- * Replica role. Possible values: primary (accepts reads and writes), replica (read-only follower).
10988
+ * Member role. Possible values: primary (accepts reads and writes), replica (read-only follower).
10980
10989
  */
10981
10990
  role: string;
10982
10991
  /**
10983
- * Replica health status. Possible values: healthy (fully synced), degraded (lagging behind primary), unhealthy (replication broken or unreachable).
10992
+ * Member pod status. Possible values: active (running), pending, notFound (pod missing), or the lowercased pod phase reported by the cluster.
10984
10993
  */
10985
10994
  status: string;
10986
10995
  /**
@@ -10989,25 +10998,21 @@ export declare namespace Models {
10989
10998
  lagSeconds: number;
10990
10999
  };
10991
11000
  /**
10992
- * HAStatus
11001
+ * Replicas
10993
11002
  */
10994
- export type DedicatedDatabaseHAStatus = {
11003
+ export type DedicatedDatabaseReplicas = {
10995
11004
  /**
10996
- * Whether high availability is enabled.
11005
+ * Number of configured replicas. Zero means high availability is disabled.
10997
11006
  */
10998
- enabled: boolean;
10999
- /**
11000
- * Number of configured replicas.
11001
- */
11002
- replicaCount: number;
11007
+ replicas: number;
11003
11008
  /**
11004
11009
  * Replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm).
11005
11010
  */
11006
11011
  syncMode: string;
11007
11012
  /**
11008
- * List of replica statuses.
11013
+ * Per-pod statuses for the primary and every replica.
11009
11014
  */
11010
- replicas: DedicatedDatabaseHAReplica[];
11015
+ members: DedicatedDatabaseMember[];
11011
11016
  };
11012
11017
  /**
11013
11018
  * Invoice
@@ -11275,6 +11280,10 @@ export declare namespace Models {
11275
11280
  * Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.
11276
11281
  */
11277
11282
  addonId: string;
11283
+ /**
11284
+ * Project ID for project-level addon payments. Empty for organization-level addons.
11285
+ */
11286
+ projectId: string;
11278
11287
  };
11279
11288
  /**
11280
11289
  * paymentMethod
@@ -11644,6 +11653,27 @@ export declare namespace Models {
11644
11653
  */
11645
11654
  poolerMemoryLimit: string;
11646
11655
  };
11656
+ /**
11657
+ * Postgres extension
11658
+ */
11659
+ export type PostgresExtension = {
11660
+ /**
11661
+ * Extension key used with CREATE EXTENSION.
11662
+ */
11663
+ key: string;
11664
+ /**
11665
+ * Human-readable extension name.
11666
+ */
11667
+ name: string;
11668
+ /**
11669
+ * Short description of what the extension provides.
11670
+ */
11671
+ description: string;
11672
+ /**
11673
+ * Category the extension belongs to.
11674
+ */
11675
+ category: string;
11676
+ };
11647
11677
  /**
11648
11678
  * Program
11649
11679
  */
@@ -11685,19 +11715,6 @@ export declare namespace Models {
11685
11715
  */
11686
11716
  billingPlanId: string;
11687
11717
  };
11688
- /**
11689
- * QueryExplanation
11690
- */
11691
- export type DedicatedDatabaseQueryExplanation = {
11692
- /**
11693
- * Structured query execution plan. Contents are engine-specific.
11694
- */
11695
- plan: Record<string, any>[];
11696
- /**
11697
- * Raw EXPLAIN output from the database engine.
11698
- */
11699
- raw: string;
11700
- };
11701
11718
  /**
11702
11719
  * Region
11703
11720
  */
@@ -11823,31 +11840,6 @@ export declare namespace Models {
11823
11840
  */
11824
11841
  roles: string[];
11825
11842
  };
11826
- /**
11827
- * SlowQuery
11828
- */
11829
- export type DedicatedDatabaseSlowQuery = {
11830
- /**
11831
- * The SQL query text.
11832
- */
11833
- query: string;
11834
- /**
11835
- * Query duration in milliseconds.
11836
- */
11837
- durationMs: number;
11838
- /**
11839
- * Number of times this query has been executed.
11840
- */
11841
- calls: number;
11842
- /**
11843
- * Database user that executed the query.
11844
- */
11845
- user: string;
11846
- /**
11847
- * Database name.
11848
- */
11849
- database: string;
11850
- };
11851
11843
  /**
11852
11844
  * Specification
11853
11845
  */
@@ -11921,7 +11913,7 @@ export declare namespace Models {
11921
11913
  /**
11922
11914
  * High availability replica price as a fraction of the specification cost.
11923
11915
  */
11924
- haReplicaRate: number;
11916
+ replicaRate: number;
11925
11917
  /**
11926
11918
  * Cross-region replica price as a fraction of the specification cost.
11927
11919
  */
@@ -11990,6 +11982,83 @@ export declare namespace Models {
11990
11982
  */
11991
11983
  mounted: boolean;
11992
11984
  };
11985
+ /**
11986
+ * Locale
11987
+ */
11988
+ export type CloudLocale = {
11989
+ /**
11990
+ * User IP address.
11991
+ */
11992
+ ip: string;
11993
+ /**
11994
+ * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
11995
+ */
11996
+ countryCode: string;
11997
+ /**
11998
+ * Country name. This field support localization.
11999
+ */
12000
+ country: string;
12001
+ /**
12002
+ * Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America.
12003
+ */
12004
+ continentCode: string;
12005
+ /**
12006
+ * Continent name. This field support localization.
12007
+ */
12008
+ continent: string;
12009
+ /**
12010
+ * True if country is part of the European Union.
12011
+ */
12012
+ eu: boolean;
12013
+ /**
12014
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
12015
+ */
12016
+ currency: string;
12017
+ /**
12018
+ * City
12019
+ */
12020
+ city?: string;
12021
+ /**
12022
+ * Name of timezone
12023
+ */
12024
+ timeZone?: string;
12025
+ /**
12026
+ * Postal code
12027
+ */
12028
+ postalCode?: string;
12029
+ /**
12030
+ * Latitude
12031
+ */
12032
+ latitude?: number;
12033
+ /**
12034
+ * Longitude
12035
+ */
12036
+ longitude?: number;
12037
+ /**
12038
+ * Autonomous System Number (ASN) of the IP
12039
+ */
12040
+ autonomousSystemNumber?: string;
12041
+ /**
12042
+ * Organization that owns the ASN
12043
+ */
12044
+ autonomousSystemOrganization?: string;
12045
+ /**
12046
+ * Internet service provider of the IP
12047
+ */
12048
+ isp?: string;
12049
+ /**
12050
+ * Connection type of the IP (e.g. cable, cellular, corporate)
12051
+ */
12052
+ connectionType?: string;
12053
+ /**
12054
+ * User type classification of the IP (e.g. residential, business, hosting)
12055
+ */
12056
+ connectionUsageType?: string;
12057
+ /**
12058
+ * Registered organization of the IP
12059
+ */
12060
+ connectionOrganization?: string;
12061
+ };
11993
12062
  /**
11994
12063
  * usageBillingPlan
11995
12064
  */
@@ -12079,6 +12148,10 @@ export declare namespace Models {
12079
12148
  * Caller origin hostname when broken down by `hostname`.
12080
12149
  */
12081
12150
  hostname?: string;
12151
+ /**
12152
+ * Caller IP address when broken down by `ip`.
12153
+ */
12154
+ ip?: string;
12082
12155
  /**
12083
12156
  * Operating system name when broken down by `osName`.
12084
12157
  */
@@ -12104,9 +12177,9 @@ export declare namespace Models {
12104
12177
  */
12105
12178
  resourceId?: string;
12106
12179
  /**
12107
- * Resource type when broken down by `resource` (gauges only).
12180
+ * Resource type when broken down by `resourceType`.
12108
12181
  */
12109
- resource?: string;
12182
+ resourceType?: string;
12110
12183
  };
12111
12184
  /**
12112
12185
  * usageEventList
@@ -12187,14 +12260,6 @@ export declare namespace Models {
12187
12260
  * Aggregated stats for total file transformations.
12188
12261
  */
12189
12262
  screenshotsGeneratedTotal: number;
12190
- /**
12191
- * Aggregated stats for imagine credits.
12192
- */
12193
- imagineCredits: Metric[];
12194
- /**
12195
- * Aggregated stats for total imagine credits.
12196
- */
12197
- imagineCreditsTotal: number;
12198
12263
  /**
12199
12264
  * Aggregated stats for total users.
12200
12265
  */
@@ -12352,10 +12417,6 @@ export declare namespace Models {
12352
12417
  * Aggregated stats for total file transformations.
12353
12418
  */
12354
12419
  screenshotsGeneratedTotal: number;
12355
- /**
12356
- * Aggregated stats for imagine credits.
12357
- */
12358
- imagineCredits: number;
12359
12420
  /**
12360
12421
  * Aggregated stats for realtime connections.
12361
12422
  */
@@ -12397,6 +12458,14 @@ export declare namespace Models {
12397
12458
  * Resource ID
12398
12459
  */
12399
12460
  resourceId: string;
12461
+ /**
12462
+ * Dedicated database engine type for per-database line items (e.g. postgresql). Empty for other resources.
12463
+ */
12464
+ type: string;
12465
+ /**
12466
+ * Dedicated database specification slug for per-database line items (e.g. s-2vcpu-2gb). Empty for other resources.
12467
+ */
12468
+ specification: string;
12400
12469
  };
12401
12470
  /**
12402
12471
  * App
@@ -12690,6 +12759,19 @@ export declare namespace Models {
12690
12759
  */
12691
12760
  interval: number;
12692
12761
  };
12762
+ /**
12763
+ * OAuth2 PAR
12764
+ */
12765
+ export type Oauth2PAR = {
12766
+ /**
12767
+ * Authorization request handle to pass to the authorize endpoint.
12768
+ */
12769
+ request_uri: string;
12770
+ /**
12771
+ * Lifetime of the authorization request handle in seconds.
12772
+ */
12773
+ expires_in: number;
12774
+ };
12693
12775
  /**
12694
12776
  * OAuth2 Token
12695
12777
  */
@@ -12723,6 +12805,58 @@ export declare namespace Models {
12723
12805
  */
12724
12806
  id_token?: string;
12725
12807
  };
12808
+ /**
12809
+ * OAuth2 Project
12810
+ */
12811
+ export type Oauth2Project = {
12812
+ /**
12813
+ * Project ID.
12814
+ */
12815
+ $id: string;
12816
+ /**
12817
+ * Region ID the project is deployed in.
12818
+ */
12819
+ region: string;
12820
+ /**
12821
+ * API endpoint of the region the project is deployed in. Empty when the region has no public hostname configured.
12822
+ */
12823
+ endpoint: string;
12824
+ };
12825
+ /**
12826
+ * OAuth2 Organization
12827
+ */
12828
+ export type Oauth2Organization = {
12829
+ /**
12830
+ * Organization ID.
12831
+ */
12832
+ $id: string;
12833
+ };
12834
+ /**
12835
+ * OAuth2 accessible projects list
12836
+ */
12837
+ export type Oauth2ProjectList = {
12838
+ /**
12839
+ * Total number of projects that matched your query.
12840
+ */
12841
+ total: number;
12842
+ /**
12843
+ * List of projects.
12844
+ */
12845
+ projects: Oauth2Project[];
12846
+ };
12847
+ /**
12848
+ * OAuth2 accessible organizations list
12849
+ */
12850
+ export type Oauth2OrganizationList = {
12851
+ /**
12852
+ * Total number of organizations that matched your query.
12853
+ */
12854
+ total: number;
12855
+ /**
12856
+ * List of organizations.
12857
+ */
12858
+ organizations: Oauth2Organization[];
12859
+ };
12726
12860
  /**
12727
12861
  * Activity event list
12728
12862
  */
@@ -12854,30 +12988,17 @@ export declare namespace Models {
12854
12988
  blocks: Block[];
12855
12989
  };
12856
12990
  /**
12857
- * Dedicated database connections list
12858
- */
12859
- export type DedicatedDatabaseConnectionList = {
12860
- /**
12861
- * Total number of connections that matched your query.
12862
- */
12863
- total: number;
12864
- /**
12865
- * List of connections.
12866
- */
12867
- connections: DedicatedDatabaseConnection[];
12868
- };
12869
- /**
12870
- * Dedicated database slow queries list
12991
+ * Database Migrations List
12871
12992
  */
12872
- export type DedicatedDatabaseSlowQueryList = {
12993
+ export type DatabaseMigrationList = {
12873
12994
  /**
12874
- * Total number of slowQueries that matched your query.
12995
+ * Total number of migrations that matched your query.
12875
12996
  */
12876
12997
  total: number;
12877
12998
  /**
12878
- * List of slowQueries.
12999
+ * List of migrations.
12879
13000
  */
12880
- slowQueries: DedicatedDatabaseSlowQuery[];
13001
+ migrations: DatabaseMigration[];
12881
13002
  };
12882
13003
  /**
12883
13004
  * Dedicated databases list
@@ -12957,6 +13078,19 @@ export declare namespace Models {
12957
13078
  */
12958
13079
  paymentMethods: PaymentMethod[];
12959
13080
  };
13081
+ /**
13082
+ * Postgres extensions list
13083
+ */
13084
+ export type PostgresExtensionList = {
13085
+ /**
13086
+ * Total number of extensions that matched your query.
13087
+ */
13088
+ total: number;
13089
+ /**
13090
+ * List of extensions.
13091
+ */
13092
+ extensions: PostgresExtension[];
13093
+ };
12960
13094
  /**
12961
13095
  * Regions list
12962
13096
  */