@appwrite.io/console 15.8.0 → 16.1.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 (54) hide show
  1. package/README.md +5 -6
  2. package/dist/cjs/package.json +1 -1
  3. package/dist/cjs/sdk.js +8360 -4537
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/package.json +1 -1
  6. package/dist/esm/sdk.js +8359 -4538
  7. package/dist/esm/sdk.js.map +1 -1
  8. package/dist/iife/sdk.js +8360 -4537
  9. package/package.json +59 -50
  10. package/types/client.d.ts +13 -2
  11. package/types/enums/{addon.d.ts → addon-key.d.ts} +1 -1
  12. package/types/enums/authentication-factor.d.ts +2 -1
  13. package/types/enums/build-runtime.d.ts +4 -1
  14. package/types/enums/embedding-model.d.ts +1 -3
  15. package/types/enums/execution-resource-type.d.ts +4 -0
  16. package/types/enums/image-gravity.d.ts +1 -0
  17. package/types/enums/invalidation-type.d.ts +5 -0
  18. package/types/enums/o-auth-provider.d.ts +5 -0
  19. package/types/enums/project-key-scopes.d.ts +20 -3
  20. package/types/enums/project-o-auth-provider-id.d.ts +5 -0
  21. package/types/enums/project-policy-id.d.ts +1 -0
  22. package/types/enums/query-suggestion-resource.d.ts +5 -1
  23. package/types/enums/runtime.d.ts +4 -1
  24. package/types/enums/usage-event-dimension.d.ts +27 -0
  25. package/types/enums/usage-event-metric.d.ts +55 -0
  26. package/types/enums/usage-gauge-dimension.d.ts +7 -0
  27. package/types/enums/usage-gauge-metric.d.ts +50 -0
  28. package/types/enums/usage-interval.d.ts +7 -0
  29. package/types/enums/usage-order-by.d.ts +4 -0
  30. package/types/enums/usage-order-direction.d.ts +4 -0
  31. package/types/index.d.ts +19 -6
  32. package/types/models.d.ts +764 -313
  33. package/types/services/account.d.ts +8 -8
  34. package/types/services/affiliates.d.ts +162 -0
  35. package/types/services/apps.d.ts +6 -6
  36. package/types/services/avatars.d.ts +44 -0
  37. package/types/services/databases.d.ts +8 -8
  38. package/types/services/documents-db.d.ts +13 -7
  39. package/types/services/domains.d.ts +82 -54
  40. package/types/services/embeddings.d.ts +31 -0
  41. package/types/services/functions.d.ts +6 -6
  42. package/types/services/mongo.d.ts +17 -23
  43. package/types/services/mysql.d.ts +17 -23
  44. package/types/services/organizations.d.ts +5 -5
  45. package/types/services/postgresql.d.ts +17 -23
  46. package/types/services/project.d.ts +171 -15
  47. package/types/services/proxy.d.ts +30 -0
  48. package/types/services/sites.d.ts +15 -8
  49. package/types/services/storage.d.ts +6 -6
  50. package/types/services/tables-db.d.ts +37 -12
  51. package/types/services/usage.d.ts +52 -38
  52. package/types/services/users.d.ts +24 -2
  53. package/types/services/vectors-db.d.ts +15 -34
  54. package/types/services/waf.d.ts +11 -2
package/types/models.d.ts CHANGED
@@ -1,25 +1,26 @@
1
- import { DatabaseType } from "./enums/database-type";
2
- import { AttributeStatus } from "./enums/attribute-status";
3
- import { ColumnStatus } from "./enums/column-status";
4
- import { IndexStatus } from "./enums/index-status";
5
- import { DetectionFrameworkType } from "./enums/detection-framework-type";
6
- import { DetectionRuntimeType } from "./enums/detection-runtime-type";
7
- import { DeploymentStatus } from "./enums/deployment-status";
8
- import { ExecutionTrigger } from "./enums/execution-trigger";
9
- import { ExecutionStatus } from "./enums/execution-status";
10
- import { ProjectAuthMethodId } from "./enums/project-auth-method-id";
11
- import { ProjectServiceId } from "./enums/project-service-id";
12
- import { ProjectProtocolId } from "./enums/project-protocol-id";
13
- import { OAuth2GooglePrompt } from "./enums/o-auth-2-google-prompt";
14
- import { OAuth2OidcPrompt } from "./enums/o-auth-2-oidc-prompt";
15
- import { PlatformType } from "./enums/platform-type";
16
- import { ProxyRuleDeploymentResourceType } from "./enums/proxy-rule-deployment-resource-type";
17
- import { ProxyRuleStatus } from "./enums/proxy-rule-status";
18
- import { MessageStatus } from "./enums/message-status";
19
- import { BillingPlanGroup } from "./enums/billing-plan-group";
20
- import { DomainTransferStatusEnum } from "./enums/domain-transfer-status-enum";
21
- import { DomainPurchaseStatus } from "./enums/domain-purchase-status";
22
- import { WafRuleAction } from "./enums/waf-rule-action";
1
+ import { DatabaseType } from './enums/database-type';
2
+ import { AttributeStatus } from './enums/attribute-status';
3
+ import { ColumnStatus } from './enums/column-status';
4
+ import { IndexStatus } from './enums/index-status';
5
+ import { DetectionFrameworkType } from './enums/detection-framework-type';
6
+ import { DetectionRuntimeType } from './enums/detection-runtime-type';
7
+ import { DeploymentStatus } from './enums/deployment-status';
8
+ import { ExecutionResourceType } from './enums/execution-resource-type';
9
+ import { ExecutionTrigger } from './enums/execution-trigger';
10
+ import { ExecutionStatus } from './enums/execution-status';
11
+ import { ProjectAuthMethodId } from './enums/project-auth-method-id';
12
+ import { ProjectServiceId } from './enums/project-service-id';
13
+ import { ProjectProtocolId } from './enums/project-protocol-id';
14
+ import { OAuth2GooglePrompt } from './enums/o-auth-2-google-prompt';
15
+ import { OAuth2OidcPrompt } from './enums/o-auth-2-oidc-prompt';
16
+ import { PlatformType } from './enums/platform-type';
17
+ import { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-resource-type';
18
+ import { ProxyRuleStatus } from './enums/proxy-rule-status';
19
+ import { MessageStatus } from './enums/message-status';
20
+ import { BillingPlanGroup } from './enums/billing-plan-group';
21
+ import { DomainTransferStatusEnum } from './enums/domain-transfer-status-enum';
22
+ import { DomainPurchaseStatus } from './enums/domain-purchase-status';
23
+ import { WafRuleAction } from './enums/waf-rule-action';
23
24
  /**
24
25
  * Appwrite Models
25
26
  */
@@ -615,7 +616,7 @@ export declare namespace Models {
615
616
  /**
616
617
  * List of policies.
617
618
  */
618
- 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 | Models.PolicyDenyCorporateEmail)[];
619
+ policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail)[];
619
620
  };
620
621
  /**
621
622
  * Email Templates List
@@ -891,6 +892,18 @@ export declare namespace Models {
891
892
  * Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.
892
893
  */
893
894
  replicas?: number;
895
+ /**
896
+ * Error message when the dedicated backing failed. Null when the database has no dedicated backing or has not failed.
897
+ */
898
+ error?: string;
899
+ /**
900
+ * Container status of the dedicated backing: active, inactive, or failed (a wake was declined because the backing namespace is gone). Null when the database has no dedicated backing or the runtime has not reported one.
901
+ */
902
+ containerStatus?: string;
903
+ /**
904
+ * Idle-lifecycle state of the dedicated backing: active, warm, cold, or hibernated. Null when the database has no dedicated backing or the runtime has not reported one.
905
+ */
906
+ lifecycleState?: string;
894
907
  /**
895
908
  * Database backup policies.
896
909
  */
@@ -4062,6 +4075,10 @@ export declare namespace Models {
4062
4075
  * Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
4063
4076
  */
4064
4077
  latestDeploymentStatus: string;
4078
+ /**
4079
+ * Allowed permission scopes.
4080
+ */
4081
+ scopes: string[];
4065
4082
  /**
4066
4083
  * Site variables.
4067
4084
  */
@@ -4154,7 +4171,7 @@ export declare namespace Models {
4154
4171
  /**
4155
4172
  * URL hosting a template demo.
4156
4173
  */
4157
- demoUrl: string;
4174
+ demoUrl?: string;
4158
4175
  /**
4159
4176
  * File URL with preview screenshot in dark theme preference.
4160
4177
  */
@@ -4231,7 +4248,7 @@ export declare namespace Models {
4231
4248
  /**
4232
4249
  * Fallback file for SPA. Only relevant for static serve runtime.
4233
4250
  */
4234
- fallbackFile: string;
4251
+ fallbackFile?: string;
4235
4252
  };
4236
4253
  /**
4237
4254
  * Function
@@ -4843,7 +4860,7 @@ export declare namespace Models {
4843
4860
  /**
4844
4861
  * Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
4845
4862
  */
4846
- fallbackFile: string;
4863
+ fallbackFile?: string;
4847
4864
  };
4848
4865
  /**
4849
4866
  * Deployment
@@ -4979,19 +4996,23 @@ export declare namespace Models {
4979
4996
  */
4980
4997
  $permissions: string[];
4981
4998
  /**
4982
- * Function ID.
4999
+ * Function or site ID.
5000
+ */
5001
+ resourceId: string;
5002
+ /**
5003
+ * Execution resource type.
4983
5004
  */
4984
- functionId: string;
5005
+ resourceType: ExecutionResourceType;
4985
5006
  /**
4986
- * Function's deployment ID used to create the execution.
5007
+ * Deployment ID used to create the execution.
4987
5008
  */
4988
5009
  deploymentId: string;
4989
5010
  /**
4990
- * The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
5011
+ * The trigger that caused the resource to execute. Possible values can be: `http`, `schedule`, or `event`.
4991
5012
  */
4992
5013
  trigger: ExecutionTrigger;
4993
5014
  /**
4994
- * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
5015
+ * The status of the resource execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
4995
5016
  */
4996
5017
  status: ExecutionStatus;
4997
5018
  /**
@@ -5019,11 +5040,11 @@ export declare namespace Models {
5019
5040
  */
5020
5041
  responseHeaders: Headers[];
5021
5042
  /**
5022
- * Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
5043
+ * Resource logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
5023
5044
  */
5024
5045
  logs: string;
5025
5046
  /**
5026
- * Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
5047
+ * Resource errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
5027
5048
  */
5028
5049
  errors: string;
5029
5050
  /**
@@ -5150,7 +5171,7 @@ export declare namespace Models {
5150
5171
  /**
5151
5172
  * Whether WAF enforcement is enabled for the project.
5152
5173
  */
5153
- wafEnabled: boolean;
5174
+ wafEnabled?: boolean;
5154
5175
  /**
5155
5176
  * Billing limits reached
5156
5177
  */
@@ -5171,6 +5192,10 @@ export declare namespace Models {
5171
5192
  * OAuth2 server scopes used when an authorization request omits the scope parameter
5172
5193
  */
5173
5194
  oAuth2ServerDefaultScopes?: string[];
5195
+ /**
5196
+ * Scopes an application may request when installed on a team
5197
+ */
5198
+ oAuth2ServerInstallationScopes?: string[];
5174
5199
  /**
5175
5200
  * OAuth2 server accepted RFC 9396 authorization_details types
5176
5201
  */
@@ -5943,6 +5968,48 @@ export declare namespace Models {
5943
5968
  */
5944
5969
  clientSecret: string;
5945
5970
  };
5971
+ /**
5972
+ * OAuth2Cloudflare
5973
+ */
5974
+ export type OAuth2Cloudflare = {
5975
+ /**
5976
+ * OAuth2 provider ID.
5977
+ */
5978
+ $id: string;
5979
+ /**
5980
+ * OAuth2 provider is active and can be used to create sessions.
5981
+ */
5982
+ enabled: boolean;
5983
+ /**
5984
+ * Cloudflare OAuth2 client ID.
5985
+ */
5986
+ clientId: string;
5987
+ /**
5988
+ * Cloudflare OAuth2 client secret.
5989
+ */
5990
+ clientSecret: string;
5991
+ };
5992
+ /**
5993
+ * OAuth2HuggingFace
5994
+ */
5995
+ export type OAuth2HuggingFace = {
5996
+ /**
5997
+ * OAuth2 provider ID.
5998
+ */
5999
+ $id: string;
6000
+ /**
6001
+ * OAuth2 provider is active and can be used to create sessions.
6002
+ */
6003
+ enabled: boolean;
6004
+ /**
6005
+ * Hugging Face OAuth2 client ID.
6006
+ */
6007
+ clientId: string;
6008
+ /**
6009
+ * Hugging Face OAuth2 client secret.
6010
+ */
6011
+ clientSecret: string;
6012
+ };
5946
6013
  /**
5947
6014
  * OAuth2Linkedin
5948
6015
  */
@@ -6389,6 +6456,69 @@ export declare namespace Models {
6389
6456
  */
6390
6457
  tenant: string;
6391
6458
  };
6459
+ /**
6460
+ * OAuth2Resend
6461
+ */
6462
+ export type OAuth2Resend = {
6463
+ /**
6464
+ * OAuth2 provider ID.
6465
+ */
6466
+ $id: string;
6467
+ /**
6468
+ * OAuth2 provider is active and can be used to create sessions.
6469
+ */
6470
+ enabled: boolean;
6471
+ /**
6472
+ * Resend OAuth2 client ID.
6473
+ */
6474
+ clientId: string;
6475
+ /**
6476
+ * Resend OAuth2 client secret.
6477
+ */
6478
+ clientSecret: string;
6479
+ };
6480
+ /**
6481
+ * OAuth2TikTok
6482
+ */
6483
+ export type OAuth2TikTok = {
6484
+ /**
6485
+ * OAuth2 provider ID.
6486
+ */
6487
+ $id: string;
6488
+ /**
6489
+ * OAuth2 provider is active and can be used to create sessions.
6490
+ */
6491
+ enabled: boolean;
6492
+ /**
6493
+ * TikTok OAuth2 client key.
6494
+ */
6495
+ clientId: string;
6496
+ /**
6497
+ * TikTok OAuth2 client secret.
6498
+ */
6499
+ clientSecret: string;
6500
+ };
6501
+ /**
6502
+ * OAuth2Kakao
6503
+ */
6504
+ export type OAuth2Kakao = {
6505
+ /**
6506
+ * OAuth2 provider ID.
6507
+ */
6508
+ $id: string;
6509
+ /**
6510
+ * OAuth2 provider is active and can be used to create sessions.
6511
+ */
6512
+ enabled: boolean;
6513
+ /**
6514
+ * Kakao OAuth2 REST API key.
6515
+ */
6516
+ clientId: string;
6517
+ /**
6518
+ * Kakao OAuth2 client secret.
6519
+ */
6520
+ clientSecret: string;
6521
+ };
6392
6522
  /**
6393
6523
  * OAuth2 Providers List
6394
6524
  */
@@ -6400,7 +6530,7 @@ export declare namespace Models {
6400
6530
  /**
6401
6531
  * List of OAuth2 providers.
6402
6532
  */
6403
- providers: (Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Appwrite | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft)[];
6533
+ providers: (Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Appwrite | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2TikTok | Models.OAuth2Kakao)[];
6404
6534
  };
6405
6535
  /**
6406
6536
  * Policy Password Dictionary
@@ -6568,6 +6698,31 @@ export declare namespace Models {
6568
6698
  */
6569
6699
  userAccessedAt: boolean;
6570
6700
  };
6701
+ /**
6702
+ * Policy MFA Factors
6703
+ */
6704
+ export type PolicyMfaFactors = {
6705
+ /**
6706
+ * Policy ID.
6707
+ */
6708
+ $id: string;
6709
+ /**
6710
+ * Whether TOTP can be used to complete an MFA challenge.
6711
+ */
6712
+ totp: boolean;
6713
+ /**
6714
+ * Whether email can be used to complete an MFA challenge.
6715
+ */
6716
+ email: boolean;
6717
+ /**
6718
+ * Whether phone (SMS) can be used to complete an MFA challenge.
6719
+ */
6720
+ phone: boolean;
6721
+ /**
6722
+ * Whether the custom factor can be used to complete an MFA challenge.
6723
+ */
6724
+ custom: boolean;
6725
+ };
6571
6726
  /**
6572
6727
  * Platform Web
6573
6728
  */
@@ -7123,35 +7278,35 @@ export declare namespace Models {
7123
7278
  /**
7124
7279
  * Aggregated number of text embedding calls per period.
7125
7280
  */
7126
- embeddingsText: Metric;
7281
+ embeddingsText: Metric[];
7127
7282
  /**
7128
7283
  * Aggregated number of tokens processed by text embeddings per period.
7129
7284
  */
7130
- embeddingsTextTokens: Metric;
7285
+ embeddingsTextTokens: Metric[];
7131
7286
  /**
7132
7287
  * Aggregated duration spent generating text embeddings per period.
7133
7288
  */
7134
- embeddingsTextDuration: Metric;
7289
+ embeddingsTextDuration: Metric[];
7135
7290
  /**
7136
7291
  * Aggregated number of errors while generating text embeddings per period.
7137
7292
  */
7138
- embeddingsTextErrors: Metric;
7293
+ embeddingsTextErrors: Metric[];
7139
7294
  /**
7140
7295
  * Total aggregated number of text embedding calls.
7141
7296
  */
7142
- embeddingsTextTotal: Metric;
7297
+ embeddingsTextTotal: number;
7143
7298
  /**
7144
7299
  * Total aggregated number of tokens processed by text.
7145
7300
  */
7146
- embeddingsTextTokensTotal: Metric;
7301
+ embeddingsTextTokensTotal: number;
7147
7302
  /**
7148
7303
  * Total aggregated duration spent generating text embeddings.
7149
7304
  */
7150
- embeddingsTextDurationTotal: Metric;
7305
+ embeddingsTextDurationTotal: number;
7151
7306
  /**
7152
7307
  * Total aggregated number of errors while generating text embeddings.
7153
7308
  */
7154
- embeddingsTextErrorsTotal: Metric;
7309
+ embeddingsTextErrorsTotal: number;
7155
7310
  /**
7156
7311
  * Aggregated number of function executions per period.
7157
7312
  */
@@ -7209,6 +7364,166 @@ export declare namespace Models {
7209
7364
  */
7210
7365
  realtimeBandwidth: Metric[];
7211
7366
  };
7367
+ /**
7368
+ * usageDataPoint
7369
+ */
7370
+ export type UsageDataPoint = {
7371
+ /**
7372
+ * Bucket start timestamp in ISO 8601. Omitted for flat dimension aggregates.
7373
+ */
7374
+ time?: string;
7375
+ /**
7376
+ * Aggregated value for the point.
7377
+ */
7378
+ value: number;
7379
+ /**
7380
+ * Value when broken down by `path`.
7381
+ */
7382
+ path?: string;
7383
+ /**
7384
+ * Value when broken down by `method`.
7385
+ */
7386
+ method?: string;
7387
+ /**
7388
+ * Value when broken down by `status`.
7389
+ */
7390
+ status?: string;
7391
+ /**
7392
+ * Value when broken down by `service`.
7393
+ */
7394
+ service?: string;
7395
+ /**
7396
+ * Value when broken down by `country`.
7397
+ */
7398
+ country?: string;
7399
+ /**
7400
+ * Value when broken down by `region`.
7401
+ */
7402
+ region?: string;
7403
+ /**
7404
+ * Value when broken down by `hostname`.
7405
+ */
7406
+ hostname?: string;
7407
+ /**
7408
+ * Value when broken down by `ip`.
7409
+ */
7410
+ ip?: string;
7411
+ /**
7412
+ * Value when broken down by `osName`.
7413
+ */
7414
+ osName?: string;
7415
+ /**
7416
+ * Value when broken down by `clientType`.
7417
+ */
7418
+ clientType?: string;
7419
+ /**
7420
+ * Value when broken down by `clientName`.
7421
+ */
7422
+ clientName?: string;
7423
+ /**
7424
+ * Value when broken down by `sdk`.
7425
+ */
7426
+ sdk?: string;
7427
+ /**
7428
+ * Value when broken down by `sdkVersion`.
7429
+ */
7430
+ sdkVersion?: string;
7431
+ /**
7432
+ * Value when broken down by `deviceName`.
7433
+ */
7434
+ deviceName?: string;
7435
+ /**
7436
+ * Value when broken down by `resourceId`.
7437
+ */
7438
+ resourceId?: string;
7439
+ /**
7440
+ * Value when broken down by `resourceType`.
7441
+ */
7442
+ resourceType?: string;
7443
+ /**
7444
+ * Value when broken down by `ordinal`.
7445
+ */
7446
+ ordinal?: string;
7447
+ /**
7448
+ * Continent code when broken down by `continentCode`.
7449
+ */
7450
+ continentCode?: string;
7451
+ /**
7452
+ * City name when broken down by `city`.
7453
+ */
7454
+ city?: string;
7455
+ /**
7456
+ * Region/state chain when broken down by `subdivisions`.
7457
+ */
7458
+ subdivisions?: string;
7459
+ /**
7460
+ * Internet service provider when broken down by `isp`.
7461
+ */
7462
+ isp?: string;
7463
+ /**
7464
+ * Autonomous System Number (ASN) when broken down by `autonomousSystemNumber`.
7465
+ */
7466
+ autonomousSystemNumber?: string;
7467
+ /**
7468
+ * Organization owning the ASN when broken down by `autonomousSystemOrganization`.
7469
+ */
7470
+ autonomousSystemOrganization?: string;
7471
+ /**
7472
+ * Connection type when broken down by `connectionType`.
7473
+ */
7474
+ connectionType?: string;
7475
+ /**
7476
+ * Connection usage type when broken down by `connectionUsageType`.
7477
+ */
7478
+ connectionUsageType?: string;
7479
+ /**
7480
+ * Registered organization of the IP when broken down by `connectionOrganization`.
7481
+ */
7482
+ connectionOrganization?: string;
7483
+ /**
7484
+ * Owning team ID when broken down by `teamId`.
7485
+ */
7486
+ teamId?: string;
7487
+ };
7488
+ /**
7489
+ * usageMetric
7490
+ */
7491
+ export type UsageMetric = {
7492
+ /**
7493
+ * Metric key this series describes.
7494
+ */
7495
+ metric: string;
7496
+ /**
7497
+ * Data points in the requested order.
7498
+ */
7499
+ points: UsageDataPoint[];
7500
+ };
7501
+ /**
7502
+ * usageEventList
7503
+ */
7504
+ export type UsageEventList = {
7505
+ /**
7506
+ * Requested interval, or an empty string for a flat aggregate.
7507
+ */
7508
+ interval: string;
7509
+ /**
7510
+ * One series per requested event metric.
7511
+ */
7512
+ metrics: UsageMetric[];
7513
+ };
7514
+ /**
7515
+ * usageGaugeList
7516
+ */
7517
+ export type UsageGaugeList = {
7518
+ /**
7519
+ * Requested interval, or an empty string for a flat aggregate.
7520
+ */
7521
+ interval: string;
7522
+ /**
7523
+ * One series per requested gauge metric.
7524
+ */
7525
+ metrics: UsageMetric[];
7526
+ };
7212
7527
  /**
7213
7528
  * Headers
7214
7529
  */
@@ -7464,7 +7779,15 @@ export declare namespace Models {
7464
7779
  */
7465
7780
  _APP_VCS_PROVIDERS: string[];
7466
7781
  /**
7467
- * Defines if main domain is configured. If so, custom domains can be created.
7782
+ * List of configured VCS providers that support repository creation.
7783
+ */
7784
+ _APP_VCS_PROVIDERS_WITH_REPOSITORY_CREATION: string[];
7785
+ /**
7786
+ * List of configured VCS providers that can host public repositories.
7787
+ */
7788
+ _APP_VCS_PROVIDERS_WITH_PUBLIC_REPOSITORIES: string[];
7789
+ /**
7790
+ * Defines if main domain is configured. If so, custom domains can be created.
7468
7791
  */
7469
7792
  _APP_DOMAIN_ENABLED: boolean;
7470
7793
  /**
@@ -7638,6 +7961,31 @@ export declare namespace Models {
7638
7961
  */
7639
7962
  expire: string;
7640
7963
  };
7964
+ /**
7965
+ * MFA Challenge Secret
7966
+ */
7967
+ export type MfaChallengeSecret = {
7968
+ /**
7969
+ * Token ID.
7970
+ */
7971
+ $id: string;
7972
+ /**
7973
+ * Token creation date in ISO 8601 format.
7974
+ */
7975
+ $createdAt: string;
7976
+ /**
7977
+ * User ID.
7978
+ */
7979
+ userId: string;
7980
+ /**
7981
+ * Token expiration date in ISO 8601 format.
7982
+ */
7983
+ expire: string;
7984
+ /**
7985
+ * Challenge code to be delivered to the end user through a custom channel.
7986
+ */
7987
+ code: string;
7988
+ };
7641
7989
  /**
7642
7990
  * MFA Recovery Codes
7643
7991
  */
@@ -7680,6 +8028,10 @@ export declare namespace Models {
7680
8028
  * Can recovery code be used for MFA challenge for this account.
7681
8029
  */
7682
8030
  recoveryCode: boolean;
8031
+ /**
8032
+ * Can custom factor be used for MFA challenge for this account.
8033
+ */
8034
+ custom: boolean;
7683
8035
  };
7684
8036
  /**
7685
8037
  * Provider
@@ -8006,7 +8358,7 @@ export declare namespace Models {
8006
8358
  /**
8007
8359
  * An array of objects containing the report data of the resources that were migrated.
8008
8360
  */
8009
- resourceData: object;
8361
+ resourceData: Record<string, any>[];
8010
8362
  /**
8011
8363
  * All errors that occurred during the migration process.
8012
8364
  */
@@ -8512,6 +8864,164 @@ export declare namespace Models {
8512
8864
  */
8513
8865
  billingCycleEnd: string;
8514
8866
  };
8867
+ /**
8868
+ * AffiliateLink
8869
+ */
8870
+ export type AffiliateLink = {
8871
+ /**
8872
+ * Link ID. This is the shareable referral code.
8873
+ */
8874
+ $id: string;
8875
+ /**
8876
+ * Link creation date in ISO 8601 format.
8877
+ */
8878
+ $createdAt: string;
8879
+ /**
8880
+ * Link update date in ISO 8601 format.
8881
+ */
8882
+ $updatedAt: string;
8883
+ /**
8884
+ * User ID of the link owner.
8885
+ */
8886
+ userId: string;
8887
+ /**
8888
+ * Optional link name.
8889
+ */
8890
+ name: string;
8891
+ /**
8892
+ * Link status. Can be one of `active` or `disabled`.
8893
+ */
8894
+ status: string;
8895
+ };
8896
+ /**
8897
+ * Affiliate links list
8898
+ */
8899
+ export type AffiliateLinkList = {
8900
+ /**
8901
+ * Total number of links that matched your query.
8902
+ */
8903
+ total: number;
8904
+ /**
8905
+ * List of links.
8906
+ */
8907
+ links: AffiliateLink[];
8908
+ };
8909
+ /**
8910
+ * AffiliateReferral
8911
+ */
8912
+ export type AffiliateReferral = {
8913
+ /**
8914
+ * Referral ID.
8915
+ */
8916
+ $id: string;
8917
+ /**
8918
+ * Referral creation date in ISO 8601 format.
8919
+ */
8920
+ $createdAt: string;
8921
+ /**
8922
+ * Referral update date in ISO 8601 format.
8923
+ */
8924
+ $updatedAt: string;
8925
+ /**
8926
+ * Affiliate link ID used for attribution.
8927
+ */
8928
+ linkId: string;
8929
+ /**
8930
+ * Privacy-safe truncated referred user ID.
8931
+ */
8932
+ referredUserMaskedId: string;
8933
+ /**
8934
+ * ISO 3166-1 alpha-2 country code of the referred user at signup, when available.
8935
+ */
8936
+ referredUserCountry: string;
8937
+ /**
8938
+ * Referral status. Can be one of `pending`, `converted`, or `expired`. `expired` is derived from `expiresAt` when still pending.
8939
+ */
8940
+ status: string;
8941
+ /**
8942
+ * Attribution time in ISO 8601 format.
8943
+ */
8944
+ attributedAt: string;
8945
+ /**
8946
+ * Attribution expiry time in ISO 8601 format.
8947
+ */
8948
+ expiresAt: string;
8949
+ /**
8950
+ * Conversion time in ISO 8601 format.
8951
+ */
8952
+ convertedAt?: string;
8953
+ };
8954
+ /**
8955
+ * Affiliate referrals list
8956
+ */
8957
+ export type AffiliateReferralList = {
8958
+ /**
8959
+ * Total number of referrals that matched your query.
8960
+ */
8961
+ total: number;
8962
+ /**
8963
+ * List of referrals.
8964
+ */
8965
+ referrals: AffiliateReferral[];
8966
+ };
8967
+ /**
8968
+ * AffiliateReward
8969
+ */
8970
+ export type AffiliateReward = {
8971
+ /**
8972
+ * Reward ID.
8973
+ */
8974
+ $id: string;
8975
+ /**
8976
+ * Reward creation date in ISO 8601 format.
8977
+ */
8978
+ $createdAt: string;
8979
+ /**
8980
+ * Reward update date in ISO 8601 format.
8981
+ */
8982
+ $updatedAt: string;
8983
+ /**
8984
+ * User ID of the reward owner.
8985
+ */
8986
+ userId: string;
8987
+ /**
8988
+ * Affiliate link ID that earned this reward.
8989
+ */
8990
+ linkId: string;
8991
+ /**
8992
+ * Referral ID that earned this reward.
8993
+ */
8994
+ referralId: string;
8995
+ /**
8996
+ * Reward amount in USD.
8997
+ */
8998
+ amount: number;
8999
+ /**
9000
+ * Reward status. Can be one of `pending` or `claimed`.
9001
+ */
9002
+ status: string;
9003
+ /**
9004
+ * Organization ID the reward was claimed on.
9005
+ */
9006
+ teamId?: string;
9007
+ /**
9008
+ * Credit document ID created when the reward was claimed.
9009
+ */
9010
+ creditId?: string;
9011
+ };
9012
+ /**
9013
+ * Affiliate rewards list
9014
+ */
9015
+ export type AffiliateRewardList = {
9016
+ /**
9017
+ * Total number of rewards that matched your query.
9018
+ */
9019
+ total: number;
9020
+ /**
9021
+ * List of rewards.
9022
+ */
9023
+ rewards: AffiliateReward[];
9024
+ };
8515
9025
  /**
8516
9026
  * Breakdown
8517
9027
  */
@@ -8589,6 +9099,14 @@ export declare namespace Models {
8589
9099
  * Total databases storage usage
8590
9100
  */
8591
9101
  usageDatabasesStorage: number;
9102
+ /**
9103
+ * Total functions storage usage, deployments and builds together. Supersedes usageDeploymentsStorage and usageBuildsStorage.
9104
+ */
9105
+ usageFunctionsStorage: number;
9106
+ /**
9107
+ * Total sites storage usage, deployments and builds together. Supersedes usageDeploymentsStorage and usageBuildsStorage.
9108
+ */
9109
+ usageSitesStorage: number;
8592
9110
  /**
8593
9111
  * Total active users for the billing period
8594
9112
  */
@@ -8943,7 +9461,7 @@ export declare namespace Models {
8943
9461
  /**
8944
9462
  * Members
8945
9463
  */
8946
- members: number;
9464
+ members?: number;
8947
9465
  /**
8948
9466
  * Webhooks
8949
9467
  */
@@ -9039,7 +9557,7 @@ export declare namespace Models {
9039
9557
  /**
9040
9558
  * Activity log days
9041
9559
  */
9042
- activityLogs: number;
9560
+ activityLogs?: number;
9043
9561
  /**
9044
9562
  * Usage history days
9045
9563
  */
@@ -9048,6 +9566,10 @@ export declare namespace Models {
9048
9566
  * Usage log time intervals allowed for this plan (e.g. 15m, 1h, 1d).
9049
9567
  */
9050
9568
  usageLogsIntervals?: string[];
9569
+ /**
9570
+ * Metrics this plan only records as a total. They cannot be broken down by dimension or filtered, because the stored events cover a fraction of the real traffic.
9571
+ */
9572
+ usageAggregateOnlyMetrics?: string[];
9051
9573
  /**
9052
9574
  * Number of days of console inactivity before a project is paused. 0 means pausing is disabled.
9053
9575
  */
@@ -9112,6 +9634,10 @@ export declare namespace Models {
9112
9634
  * Does plan support credit
9113
9635
  */
9114
9636
  supportsCredits: boolean;
9637
+ /**
9638
+ * Does plan support dedicated databases.
9639
+ */
9640
+ supportsDedicatedDatabases: boolean;
9115
9641
  /**
9116
9642
  * Does plan support blocking disposable email addresses.
9117
9643
  */
@@ -9135,7 +9661,7 @@ export declare namespace Models {
9135
9661
  /**
9136
9662
  * Does plan support backup policies.
9137
9663
  */
9138
- backupsEnabled: boolean;
9664
+ backupsEnabled?: boolean;
9139
9665
  /**
9140
9666
  * Whether usage addons are calculated per project.
9141
9667
  */
@@ -9147,7 +9673,7 @@ export declare namespace Models {
9147
9673
  /**
9148
9674
  * How many policies does plan support
9149
9675
  */
9150
- backupPolicies: number;
9676
+ backupPolicies?: number;
9151
9677
  /**
9152
9678
  * Maximum function and site deployment size in MB
9153
9679
  */
@@ -9172,6 +9698,10 @@ export declare namespace Models {
9172
9698
  * Details of the program this plan is a part of.
9173
9699
  */
9174
9700
  program?: Program;
9701
+ /**
9702
+ * Included monthly dedicated-database compute credit in USD. Resets each billing cycle with no roll-over.
9703
+ */
9704
+ databaseComputeCredit: number;
9175
9705
  /**
9176
9706
  * Dedicated database limits available to this plan.
9177
9707
  */
@@ -9184,11 +9714,11 @@ export declare namespace Models {
9184
9714
  /**
9185
9715
  * Addon seats
9186
9716
  */
9187
- seats: BillingPlanAddonDetails;
9717
+ seats?: BillingPlanAddonDetails;
9188
9718
  /**
9189
9719
  * Addon projects
9190
9720
  */
9191
- projects: BillingPlanAddonDetails;
9721
+ projects?: BillingPlanAddonDetails;
9192
9722
  };
9193
9723
  /**
9194
9724
  * Details
@@ -9213,7 +9743,7 @@ export declare namespace Models {
9213
9743
  /**
9214
9744
  * Price currency
9215
9745
  */
9216
- currency: string;
9746
+ currency?: string;
9217
9747
  /**
9218
9748
  * Price
9219
9749
  */
@@ -9429,7 +9959,7 @@ export declare namespace Models {
9429
9959
  */
9430
9960
  port: number;
9431
9961
  /**
9432
- * Database name the client sends for routing to the branch.
9962
+ * Advertised catalog the client connects to. MySQL/MariaDB use default; Postgres uses the routing label.
9433
9963
  */
9434
9964
  database: string;
9435
9965
  /**
@@ -9457,6 +9987,10 @@ export declare namespace Models {
9457
9987
  * BranchList
9458
9988
  */
9459
9989
  export type DedicatedDatabaseBranchList = {
9990
+ /**
9991
+ * Total number of branches.
9992
+ */
9993
+ total: number;
9460
9994
  /**
9461
9995
  * List of branches.
9462
9996
  */
@@ -9671,6 +10205,10 @@ export declare namespace Models {
9671
10205
  * Number of documents still pending replication to the target.
9672
10206
  */
9673
10207
  lagDocuments: number;
10208
+ /**
10209
+ * Highest source changelog sequence applied to the target so far.
10210
+ */
10211
+ changelogWatermark: number;
9674
10212
  /**
9675
10213
  * Time the migrated data was verified against the source in ISO 8601 format.
9676
10214
  */
@@ -9684,9 +10222,13 @@ export declare namespace Models {
9684
10222
  */
9685
10223
  soakUntil: string;
9686
10224
  /**
9687
- * Whether the migration cuts over automatically once ready.
10225
+ * Whether the migration cuts over automatically once ready. Set when the migration is created and never changed afterwards, so it always reports what was asked for.
9688
10226
  */
9689
10227
  autoCutover: boolean;
10228
+ /**
10229
+ * Whether a cutover has been requested and not yet attempted. Set by the cutover endpoint and cleared when the attempt is made, so a cutover that fails a check parks the migration again rather than retrying on its own.
10230
+ */
10231
+ cutoverRequested: boolean;
9690
10232
  /**
9691
10233
  * Whether the migration is paused.
9692
10234
  */
@@ -9721,7 +10263,7 @@ export declare namespace Models {
9721
10263
  */
9722
10264
  api: string;
9723
10265
  /**
9724
- * Database engine: postgresql, mysql, or mongodb.
10266
+ * Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.
9725
10267
  */
9726
10268
  engine: string;
9727
10269
  /**
@@ -9733,7 +10275,7 @@ export declare namespace Models {
9733
10275
  */
9734
10276
  specification: string;
9735
10277
  /**
9736
- * Database backend provider. Possible values: prisma, edge.
10278
+ * Database backend provider. Possible values: edge.
9737
10279
  */
9738
10280
  backend: string;
9739
10281
  /**
@@ -9752,6 +10294,10 @@ export declare namespace Models {
9752
10294
  * Database password for connections.
9753
10295
  */
9754
10296
  connectionPassword: string;
10297
+ /**
10298
+ * Committed generation of the primary connection credentials. Null until the rotation contract has been initialized.
10299
+ */
10300
+ credentialGeneration: number;
9755
10301
  /**
9756
10302
  * Full database connection string (URI format).
9757
10303
  */
@@ -9765,7 +10311,7 @@ export declare namespace Models {
9765
10311
  */
9766
10312
  status: string;
9767
10313
  /**
9768
- * Container status for lifecycle-managed database runtimes: active or inactive.
10314
+ * Container status for lifecycle-managed database runtimes: active, inactive, or failed (a wake was declined because the backing namespace is gone).
9769
10315
  */
9770
10316
  containerStatus: string;
9771
10317
  /**
@@ -9796,6 +10342,18 @@ export declare namespace Models {
9796
10342
  * Storage allocated in GB.
9797
10343
  */
9798
10344
  storage: number;
10345
+ /**
10346
+ * Storage resize status. Possible values: idle (no resize in flight), resizing (the volume is growing towards storageTargetGb).
10347
+ */
10348
+ storageStatus: string;
10349
+ /**
10350
+ * Size in GB the volume is growing towards while storageStatus is resizing. 0 when no resize is in flight.
10351
+ */
10352
+ storageTargetGb: number;
10353
+ /**
10354
+ * Time the in-flight storage resize started, in ISO 8601 format.
10355
+ */
10356
+ storageResizeStartedAt?: string;
9799
10357
  /**
9800
10358
  * Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.
9801
10359
  */
@@ -9816,10 +10374,6 @@ export declare namespace Models {
9816
10374
  * Replication sync mode: async, sync, or quorum.
9817
10375
  */
9818
10376
  syncMode: string;
9819
- /**
9820
- * Number of cross-region replicas. Cross-region availability is enabled when greater than 0.
9821
- */
9822
- crossRegionReplicas: number;
9823
10377
  /**
9824
10378
  * Maximum concurrent client connections. This is the limit a client pool may reach; the engine's own max_connections reported by the status endpoint is a smaller backend limit the pooler multiplexes onto and does not constrain a client pool.
9825
10379
  */
@@ -9853,7 +10407,7 @@ export declare namespace Models {
9853
10407
  */
9854
10408
  storageAutoscalingThresholdPercent: number;
9855
10409
  /**
9856
- * Maximum storage size in GB for autoscaling. 0 means no limit.
10410
+ * Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.
9857
10411
  */
9858
10412
  storageAutoscalingMaxGb: number;
9859
10413
  /**
@@ -9900,7 +10454,7 @@ export declare namespace Models {
9900
10454
  /**
9901
10455
  * Result rows as a list of column-name => value maps. Empty for non-returning statements.
9902
10456
  */
9903
- rows: object;
10457
+ rows: Record<string, any>[];
9904
10458
  /**
9905
10459
  * Number of rows returned (for SELECT) or affected (for INSERT/UPDATE/DELETE).
9906
10460
  */
@@ -9948,9 +10502,13 @@ export declare namespace Models {
9948
10502
  */
9949
10503
  $createdAt: string;
9950
10504
  /**
9951
- * Database ID being restored.
10505
+ * Database ID being restored into.
9952
10506
  */
9953
10507
  databaseId: string;
10508
+ /**
10509
+ * Source database ID when restoring a backup into another database.
10510
+ */
10511
+ sourceDatabaseId: string;
9954
10512
  /**
9955
10513
  * Project ID.
9956
10514
  */
@@ -9989,7 +10547,7 @@ export declare namespace Models {
9989
10547
  */
9990
10548
  export type DatabaseStatus = {
9991
10549
  /**
9992
- * Overall health status: healthy, degraded, or unhealthy.
10550
+ * Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured.
9993
10551
  */
9994
10552
  health: string;
9995
10553
  /**
@@ -10033,9 +10591,9 @@ export declare namespace Models {
10033
10591
  */
10034
10592
  syncStandbyCount: number;
10035
10593
  /**
10036
- * Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
10594
+ * Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.
10037
10595
  */
10038
- syncStateConfirmed: boolean;
10596
+ syncStateConfirmed?: boolean;
10039
10597
  /**
10040
10598
  * List of database replicas and their status. Every configured member appears, including one the backend has not brought up, which is reported as not healthy.
10041
10599
  */
@@ -10143,9 +10701,9 @@ export declare namespace Models {
10143
10701
  */
10144
10702
  renewalPrice: number;
10145
10703
  /**
10146
- * Transfer status for domains being transferred in.
10704
+ * Transfer status for domains being transferred in. Null when the domain is not being transferred.
10147
10705
  */
10148
- transferStatus: DomainTransferStatusEnum;
10706
+ transferStatus?: DomainTransferStatusEnum;
10149
10707
  /**
10150
10708
  * Team ID.
10151
10709
  */
@@ -10172,9 +10730,9 @@ export declare namespace Models {
10172
10730
  */
10173
10731
  available: boolean;
10174
10732
  /**
10175
- * Domain registration price.
10733
+ * Domain registration price. Null when the price could not be resolved, for example for an unsupported TLD.
10176
10734
  */
10177
- price: number;
10735
+ price?: number;
10178
10736
  /**
10179
10737
  * Price period in years.
10180
10738
  */
@@ -10183,6 +10741,14 @@ export declare namespace Models {
10183
10741
  * Whether the domain is a premium domain.
10184
10742
  */
10185
10743
  premium: boolean;
10744
+ /**
10745
+ * Domain renewal price for the same period. Null when the domain was not priced or the registrar has no renewal price for it.
10746
+ */
10747
+ renewalPrice?: number;
10748
+ /**
10749
+ * Renewal price period in years.
10750
+ */
10751
+ renewalPeriodYears: number;
10186
10752
  };
10187
10753
  /**
10188
10754
  * DomainPurchase
@@ -10480,9 +11046,13 @@ export declare namespace Models {
10480
11046
  */
10481
11047
  status: string;
10482
11048
  /**
10483
- * Replication lag in seconds.
11049
+ * Whether the engine reports this member's replication stream as up. Null when no reading was taken: a primary has no stream to report, and a member that is not active, or whose probe did not answer, has none yet. False is a reading and null is the absence of one, so the two are not interchangeable. Read it beside lagSeconds before expecting a failover that names no target to find a promotable standby: a member streaming at a known lag is one, and a member reporting null is not evidence either way.
10484
11050
  */
10485
- lagSeconds: number;
11051
+ replicating?: boolean;
11052
+ /**
11053
+ * Replication lag in seconds. Null when the lag is not known: a primary has none to report, and a member the backend has not probed has none yet. Also null against `replicating: true`, for a member that is streaming but whose engine printed no numeric lag.
11054
+ */
11055
+ lagSeconds?: number;
10486
11056
  };
10487
11057
  /**
10488
11058
  * Operation
@@ -10501,11 +11071,11 @@ export declare namespace Models {
10501
11071
  */
10502
11072
  databaseId: string;
10503
11073
  /**
10504
- * Operation type, such as provision, update, restore, pausing, resuming, failover, backup-create or cross-region-enable.
11074
+ * Operation type, such as provision, update, credentials-update, restore, pausing, resuming, failover, backup-create or cross-region-enable.
10505
11075
  */
10506
11076
  type: string;
10507
11077
  /**
10508
- * Operation status. Possible values: running (in progress), completed (finished successfully), failed (ended in an error).
11078
+ * Operation status. Possible values: queued (accepted and waiting to resume), running (in progress), completed (finished successfully), failed (ended in an error).
10509
11079
  */
10510
11080
  status: string;
10511
11081
  /**
@@ -10525,7 +11095,7 @@ export declare namespace Models {
10525
11095
  */
10526
11096
  completedAt?: string;
10527
11097
  /**
10528
- * Machine-readable failure code. `LockLost` marks an attempt that was fenced and abandoned because another worker took over the database.
11098
+ * Machine-readable failure code. `Interrupted` marks an attempt that ended before its outcome could be confirmed.
10529
11099
  */
10530
11100
  errorCode: string;
10531
11101
  /**
@@ -10575,14 +11145,35 @@ export declare namespace Models {
10575
11145
  */
10576
11146
  syncStandbyCount: number;
10577
11147
  /**
10578
- * Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
11148
+ * Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.
10579
11149
  */
10580
- syncStateConfirmed: boolean;
11150
+ syncStateConfirmed?: boolean;
10581
11151
  /**
10582
11152
  * Per-pod statuses for the primary and every replica.
10583
11153
  */
10584
11154
  members: DedicatedDatabaseMember[];
10585
11155
  };
11156
+ /**
11157
+ * Invalidation
11158
+ */
11159
+ export type ProxyInvalidation = {
11160
+ /**
11161
+ * Domain name.
11162
+ */
11163
+ domain: string;
11164
+ /**
11165
+ * Invalidation type. Possible values are "tag", "path", or "all".
11166
+ */
11167
+ type: string;
11168
+ /**
11169
+ * Invalidated reference. Depending on type this is a cache tag name, a URL path, or empty when type is all.
11170
+ */
11171
+ reference: string;
11172
+ /**
11173
+ * Invalidation status.
11174
+ */
11175
+ status: string;
11176
+ };
10586
11177
  /**
10587
11178
  * Invoice
10588
11179
  */
@@ -10709,9 +11300,9 @@ export declare namespace Models {
10709
11300
  */
10710
11301
  prefs: Preferences;
10711
11302
  /**
10712
- * Project budget limit
11303
+ * Project budget limit. Null when no budget is set.
10713
11304
  */
10714
- billingBudget: number;
11305
+ billingBudget?: number;
10715
11306
  /**
10716
11307
  * Project budget limit
10717
11308
  */
@@ -10747,7 +11338,7 @@ export declare namespace Models {
10747
11338
  /**
10748
11339
  * Start date of trial.
10749
11340
  */
10750
- billingTrialStartDate: string;
11341
+ billingTrialStartDate?: string;
10751
11342
  /**
10752
11343
  * Number of trial days.
10753
11344
  */
@@ -10767,11 +11358,11 @@ export declare namespace Models {
10767
11358
  /**
10768
11359
  * Default payment method.
10769
11360
  */
10770
- billingAddressId: string;
11361
+ billingAddressId?: string;
10771
11362
  /**
10772
11363
  * Backup payment method.
10773
11364
  */
10774
- backupPaymentMethodId: string;
11365
+ backupPaymentMethodId?: string;
10775
11366
  /**
10776
11367
  * Team status.
10777
11368
  */
@@ -10779,27 +11370,27 @@ export declare namespace Models {
10779
11370
  /**
10780
11371
  * Remarks on team status.
10781
11372
  */
10782
- remarks: string;
11373
+ remarks?: string;
10783
11374
  /**
10784
11375
  * Organization agreements
10785
11376
  */
10786
- agreementBAA: string;
11377
+ agreementBAA?: string;
10787
11378
  /**
10788
11379
  * Program manager's name.
10789
11380
  */
10790
- programManagerName: string;
11381
+ programManagerName?: string;
10791
11382
  /**
10792
11383
  * Program manager's calendar link.
10793
11384
  */
10794
- programManagerCalendar: string;
11385
+ programManagerCalendar?: string;
10795
11386
  /**
10796
11387
  * Program's discord channel name.
10797
11388
  */
10798
- programDiscordChannelName: string;
11389
+ programDiscordChannelName?: string;
10799
11390
  /**
10800
11391
  * Program's discord channel URL.
10801
11392
  */
10802
- programDiscordChannelUrl: string;
11393
+ programDiscordChannelUrl?: string;
10803
11394
  /**
10804
11395
  * Billing limits reached
10805
11396
  */
@@ -10807,11 +11398,11 @@ export declare namespace Models {
10807
11398
  /**
10808
11399
  * Billing plan selected for downgrade.
10809
11400
  */
10810
- billingPlanDowngrade: string;
11401
+ billingPlanDowngrade?: string;
10811
11402
  /**
10812
11403
  * Tax Id
10813
11404
  */
10814
- billingTaxId: string;
11405
+ billingTaxId?: string;
10815
11406
  /**
10816
11407
  * Marked for deletion
10817
11408
  */
@@ -10987,36 +11578,44 @@ export declare namespace Models {
10987
11578
  /**
10988
11579
  * Line items breakdown
10989
11580
  */
10990
- items: object;
11581
+ items: Record<string, any>[];
10991
11582
  /**
10992
11583
  * Applied discounts breakdown
10993
11584
  */
10994
- discounts: object;
11585
+ discounts: Record<string, any>[];
10995
11586
  };
10996
11587
  /**
10997
11588
  * PlanChangeLimits
10998
11589
  */
10999
11590
  export type PlanChangeLimits = {
11000
11591
  /**
11001
- * Total number of projects in the organization
11592
+ * Whether the plan change is allowed
11002
11593
  */
11003
- totalProjects: number;
11594
+ canChangePlan: boolean;
11004
11595
  /**
11005
- * Number of projects exceeding target plan limits
11596
+ * Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.
11006
11597
  */
11007
- nonCompliantProjects: number;
11598
+ unsupportedAddons: string[];
11008
11599
  /**
11009
- * Whether the plan change is allowed
11600
+ * Project count against the target plan limit
11010
11601
  */
11011
- canChangePlan: boolean;
11602
+ projects: PlanChangeResourceCompliance;
11012
11603
  /**
11013
- * Project compliance details
11604
+ * Organization member count against the target plan limit
11014
11605
  */
11015
- projects: PlanChangeProjectCompliance[];
11606
+ members: PlanChangeResourceCompliance;
11016
11607
  /**
11017
- * Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.
11608
+ * Custom domain count against the target plan limit
11018
11609
  */
11019
- unsupportedAddons: string[];
11610
+ domains: PlanChangeResourceCompliance;
11611
+ /**
11612
+ * Number of projects exceeding target plan limits
11613
+ */
11614
+ nonCompliantProjects: number;
11615
+ /**
11616
+ * Per-project compliance details. Populated for downgrades only.
11617
+ */
11618
+ projectCompliance: PlanChangeProjectCompliance[];
11020
11619
  };
11021
11620
  /**
11022
11621
  * PlanChangeProjectCompliance
@@ -11060,7 +11659,7 @@ export declare namespace Models {
11060
11659
  */
11061
11660
  limit: number;
11062
11661
  /**
11063
- * Compliance status
11662
+ * Compliance status. Either `over_limit` or `within_limit`.
11064
11663
  */
11065
11664
  status: string;
11066
11665
  /**
@@ -11068,7 +11667,7 @@ export declare namespace Models {
11068
11667
  */
11069
11668
  excess: number;
11070
11669
  /**
11071
- * Suggestion for resolving the compliance issue
11670
+ * Suggestion for resolving the compliance issue. Empty when the resource is within limits.
11072
11671
  */
11073
11672
  resolutionHint: string;
11074
11673
  };
@@ -11297,9 +11896,9 @@ export declare namespace Models {
11297
11896
  */
11298
11897
  name: string;
11299
11898
  /**
11300
- * Does the organization have access to this region.
11899
+ * Does the organization have access to this region. Null when access has not been resolved.
11301
11900
  */
11302
- available: boolean;
11901
+ available?: boolean;
11303
11902
  /**
11304
11903
  * Does the backend support this region.
11305
11904
  */
@@ -11425,6 +12024,22 @@ export declare namespace Models {
11425
12024
  * Monthly price of the specification in USD.
11426
12025
  */
11427
12026
  price: number;
12027
+ /**
12028
+ * Price per GB of storage above the included amount, per month, in USD.
12029
+ */
12030
+ storageOverageRate: number;
12031
+ /**
12032
+ * Price per GB of bandwidth above the included amount, per month, in USD.
12033
+ */
12034
+ bandwidthOverageRate: number;
12035
+ /**
12036
+ * High availability replica price as a fraction of the specification price.
12037
+ */
12038
+ replicaRate: number;
12039
+ /**
12040
+ * Point-in-time recovery price as a fraction of the specification price.
12041
+ */
12042
+ pitrRate: number;
11428
12043
  /**
11429
12044
  * Allocated CPU in millicores.
11430
12045
  */
@@ -11462,35 +12077,6 @@ export declare namespace Models {
11462
12077
  * Total number of specifications.
11463
12078
  */
11464
12079
  total: number;
11465
- /**
11466
- * Overage and add-on pricing shared across all specifications.
11467
- */
11468
- pricing: DedicatedDatabaseSpecificationPricing;
11469
- };
11470
- /**
11471
- * SpecificationPricing
11472
- */
11473
- export type DedicatedDatabaseSpecificationPricing = {
11474
- /**
11475
- * Price per GB of storage above the included amount, per month, in USD.
11476
- */
11477
- storageOverageRate: number;
11478
- /**
11479
- * Price per GB of bandwidth above the included amount, per month, in USD.
11480
- */
11481
- bandwidthOverageRate: number;
11482
- /**
11483
- * High availability replica price as a fraction of the specification cost.
11484
- */
11485
- replicaRate: number;
11486
- /**
11487
- * Cross-region replica price as a fraction of the specification cost.
11488
- */
11489
- crossRegionReplicaRate: number;
11490
- /**
11491
- * Point-in-time recovery price as a fraction of the specification cost.
11492
- */
11493
- pitrRate: number;
11494
12080
  };
11495
12081
  /**
11496
12082
  * Connections
@@ -11522,7 +12108,11 @@ export declare namespace Models {
11522
12108
  */
11523
12109
  healthy: boolean;
11524
12110
  /**
11525
- * Replication lag in seconds (null for primary).
12111
+ * Whether the engine reports this member's replication stream as up. Null when no reading was taken: a primary has no stream to report, and a member that is not healthy, or whose probe did not answer, has none yet. `healthy` is a reachability probe of the member itself and says nothing about replication, so a healthy member may still not be replicating.
12112
+ */
12113
+ replicating?: boolean;
12114
+ /**
12115
+ * Replication lag in seconds (null for primary). Also null against `replicating: true`, for a member that is streaming but whose engine printed no numeric lag.
11526
12116
  */
11527
12117
  lagSeconds?: number;
11528
12118
  };
@@ -11562,7 +12152,7 @@ export declare namespace Models {
11562
12152
  /**
11563
12153
  * Member additional resources
11564
12154
  */
11565
- member: AdditionalResource;
12155
+ member?: AdditionalResource;
11566
12156
  /**
11567
12157
  * Realtime additional resources
11568
12158
  */
@@ -11574,7 +12164,7 @@ export declare namespace Models {
11574
12164
  /**
11575
12165
  * Realtime bandwidth additional resources
11576
12166
  */
11577
- realtimeBandwidth: AdditionalResource;
12167
+ realtimeBandwidth?: AdditionalResource;
11578
12168
  /**
11579
12169
  * Storage additional resources
11580
12170
  */
@@ -11594,167 +12184,7 @@ export declare namespace Models {
11594
12184
  /**
11595
12185
  * Credits additional resources
11596
12186
  */
11597
- credits: AdditionalResource;
11598
- };
11599
- /**
11600
- * usageDataPoint
11601
- */
11602
- export type UsageDataPoint = {
11603
- /**
11604
- * Bucket start timestamp (ISO 8601). When `interval` is omitted this is the request end time, marking the aggregate as-of moment.
11605
- */
11606
- time: string;
11607
- /**
11608
- * Aggregated value for the bucket. Counters are whole numbers; gauge rates (e.g. queries per second) may be fractional.
11609
- */
11610
- value: number;
11611
- /**
11612
- * API endpoint path when broken down by `path`.
11613
- */
11614
- path?: string;
11615
- /**
11616
- * HTTP method when broken down by `method`.
11617
- */
11618
- method?: string;
11619
- /**
11620
- * HTTP status code when broken down by `status`.
11621
- */
11622
- status?: string;
11623
- /**
11624
- * API service segment when broken down by `service`.
11625
- */
11626
- service?: string;
11627
- /**
11628
- * Country code when broken down by `country`.
11629
- */
11630
- country?: string;
11631
- /**
11632
- * Continent code when broken down by `continentCode`.
11633
- */
11634
- continentCode?: string;
11635
- /**
11636
- * City name when broken down by `city`.
11637
- */
11638
- city?: string;
11639
- /**
11640
- * Region/state chain when broken down by `subdivisions`.
11641
- */
11642
- subdivisions?: string;
11643
- /**
11644
- * Internet service provider when broken down by `isp`.
11645
- */
11646
- isp?: string;
11647
- /**
11648
- * Autonomous System Number (ASN) when broken down by `autonomousSystemNumber`.
11649
- */
11650
- autonomousSystemNumber?: string;
11651
- /**
11652
- * Organization owning the ASN when broken down by `autonomousSystemOrganization`.
11653
- */
11654
- autonomousSystemOrganization?: string;
11655
- /**
11656
- * Connection type (e.g. cable, cellular, corporate) when broken down by `connectionType`.
11657
- */
11658
- connectionType?: string;
11659
- /**
11660
- * User type (e.g. residential, business, hosting) when broken down by `connectionUsageType`.
11661
- */
11662
- connectionUsageType?: string;
11663
- /**
11664
- * Registered organization of the IP when broken down by `connectionOrganization`.
11665
- */
11666
- connectionOrganization?: string;
11667
- /**
11668
- * Appwrite region when broken down by `region`.
11669
- */
11670
- region?: string;
11671
- /**
11672
- * Caller origin hostname when broken down by `hostname`.
11673
- */
11674
- hostname?: string;
11675
- /**
11676
- * Caller IP address when broken down by `ip`.
11677
- */
11678
- ip?: string;
11679
- /**
11680
- * Operating system name when broken down by `osName`.
11681
- */
11682
- osName?: string;
11683
- /**
11684
- * Client type when broken down by `clientType`.
11685
- */
11686
- clientType?: string;
11687
- /**
11688
- * Client name when broken down by `clientName`.
11689
- */
11690
- clientName?: string;
11691
- /**
11692
- * SDK name when broken down by `sdk`.
11693
- */
11694
- sdk?: string;
11695
- /**
11696
- * SDK version when broken down by `sdkVersion`.
11697
- */
11698
- sdkVersion?: string;
11699
- /**
11700
- * Device classification when broken down by `deviceName`.
11701
- */
11702
- deviceName?: string;
11703
- /**
11704
- * Owning team ID when broken down by `teamId`.
11705
- */
11706
- teamId?: string;
11707
- /**
11708
- * External resource ID when broken down by `resourceId`.
11709
- */
11710
- resourceId?: string;
11711
- /**
11712
- * Resource type when broken down by `resourceType`.
11713
- */
11714
- resourceType?: string;
11715
- /**
11716
- * Replica ordinal when broken down by `ordinal`. 0 is the primary; 1+ are replicas.
11717
- */
11718
- ordinal?: string;
11719
- };
11720
- /**
11721
- * usageEventList
11722
- */
11723
- export type UsageEventList = {
11724
- /**
11725
- * Time interval size (1h or 1d). Empty when the request omits `interval` — points then carry the request end time as their as-of marker.
11726
- */
11727
- interval: string;
11728
- /**
11729
- * One entry per requested metric, each carrying its own points[] time series (sums per bucket / dimension over time).
11730
- */
11731
- metrics: UsageMetric[];
11732
- };
11733
- /**
11734
- * usageGaugeList
11735
- */
11736
- export type UsageGaugeList = {
11737
- /**
11738
- * Time interval size (1h or 1d). Empty when the request omits `interval` — points then carry the request end time as their as-of marker.
11739
- */
11740
- interval: string;
11741
- /**
11742
- * One entry per requested metric, each carrying its own points[] time series (latest-snapshot per bucket / dimension via argMax over time).
11743
- */
11744
- metrics: UsageMetric[];
11745
- };
11746
- /**
11747
- * usageMetric
11748
- */
11749
- export type UsageMetric = {
11750
- /**
11751
- * Metric key this series describes.
11752
- */
11753
- metric: string;
11754
- /**
11755
- * Data points for this metric, ordered by time ascending. With `interval`, each entry is one bucket; without, each entry is one row of the dimensional or aggregate breakdown.
11756
- */
11757
- points: UsageDataPoint[];
12187
+ credits?: AdditionalResource;
11758
12188
  };
11759
12189
  /**
11760
12190
  * Organization
@@ -11892,11 +12322,11 @@ export declare namespace Models {
11892
12322
  /**
11893
12323
  * Aggregated stats for number of requests.
11894
12324
  */
11895
- bandwidth: Metric[];
12325
+ bandwidth: number;
11896
12326
  /**
11897
12327
  * Aggregated stats for consumed bandwidth.
11898
12328
  */
11899
- users: Metric[];
12329
+ users: number;
11900
12330
  /**
11901
12331
  * Aggregated stats for function executions.
11902
12332
  */
@@ -11904,11 +12334,11 @@ export declare namespace Models {
11904
12334
  /**
11905
12335
  * Aggregated stats for database reads.
11906
12336
  */
11907
- databasesReads: Metric[];
12337
+ databasesReads: number;
11908
12338
  /**
11909
12339
  * Aggregated stats for database writes.
11910
12340
  */
11911
- databasesWrites: Metric[];
12341
+ databasesWrites: number;
11912
12342
  /**
11913
12343
  * Aggregated stats for function executions in mb seconds.
11914
12344
  */
@@ -11940,7 +12370,7 @@ export declare namespace Models {
11940
12370
  /**
11941
12371
  * Aggregated stats for file transformations.
11942
12372
  */
11943
- imageTransformations: Metric[];
12373
+ imageTransformations: number;
11944
12374
  /**
11945
12375
  * Aggregated stats for total file transformations.
11946
12376
  */
@@ -11948,7 +12378,7 @@ export declare namespace Models {
11948
12378
  /**
11949
12379
  * Aggregated stats for file transformations.
11950
12380
  */
11951
- screenshotsGenerated: Metric[];
12381
+ screenshotsGenerated: number;
11952
12382
  /**
11953
12383
  * Aggregated stats for total file transformations.
11954
12384
  */
@@ -12250,7 +12680,7 @@ export declare namespace Models {
12250
12680
  /**
12251
12681
  * Authorization details granted to the application. Rich authorization request (RFC 9396) style entries; the Appwrite Console stores authorized project IDs here.
12252
12682
  */
12253
- authorizationDetails: object;
12683
+ authorizationDetails: Record<string, any>[];
12254
12684
  /**
12255
12685
  * ID of the user who created the installation.
12256
12686
  */
@@ -12613,7 +13043,7 @@ export declare namespace Models {
12613
13043
  /**
12614
13044
  * List of conditions evaluated for this rule.
12615
13045
  */
12616
- conditions: object;
13046
+ conditions: Record<string, any>[];
12617
13047
  /**
12618
13048
  * Action specific configuration.
12619
13049
  */
@@ -12674,7 +13104,7 @@ export declare namespace Models {
12674
13104
  /**
12675
13105
  * List of conditions evaluated for this rule.
12676
13106
  */
12677
- conditions: object;
13107
+ conditions: Record<string, any>[];
12678
13108
  /**
12679
13109
  * Action specific configuration.
12680
13110
  */
@@ -12735,7 +13165,7 @@ export declare namespace Models {
12735
13165
  /**
12736
13166
  * List of conditions evaluated for this rule.
12737
13167
  */
12738
- conditions: object;
13168
+ conditions: Record<string, any>[];
12739
13169
  /**
12740
13170
  * Action specific configuration.
12741
13171
  */
@@ -12796,7 +13226,7 @@ export declare namespace Models {
12796
13226
  /**
12797
13227
  * List of conditions evaluated for this rule.
12798
13228
  */
12799
- conditions: object;
13229
+ conditions: Record<string, any>[];
12800
13230
  /**
12801
13231
  * Action specific configuration.
12802
13232
  */
@@ -12869,7 +13299,7 @@ export declare namespace Models {
12869
13299
  /**
12870
13300
  * List of conditions evaluated for this rule.
12871
13301
  */
12872
- conditions: object;
13302
+ conditions: Record<string, any>[];
12873
13303
  /**
12874
13304
  * Action specific configuration.
12875
13305
  */
@@ -12886,6 +13316,14 @@ export declare namespace Models {
12886
13316
  * Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.
12887
13317
  */
12888
13318
  key: string;
13319
+ /**
13320
+ * Rate limit strategy: `fixedWindow`, `slidingWindow`, or `tokenBucket`.
13321
+ */
13322
+ strategy: string;
13323
+ /**
13324
+ * Maximum burst capacity in tokens, applied by the `tokenBucket` strategy. The sustained refill rate is `limit / interval`. Defaults to `limit`.
13325
+ */
13326
+ maxBucketSize: number;
12889
13327
  };
12890
13328
  /**
12891
13329
  * WafRuleRedirect
@@ -12942,7 +13380,7 @@ export declare namespace Models {
12942
13380
  /**
12943
13381
  * List of conditions evaluated for this rule.
12944
13382
  */
12945
- conditions: object;
13383
+ conditions: Record<string, any>[];
12946
13384
  /**
12947
13385
  * Action specific configuration.
12948
13386
  */
@@ -13229,6 +13667,19 @@ export declare namespace Models {
13229
13667
  */
13230
13668
  suggestions: DomainSuggestion[];
13231
13669
  };
13670
+ /**
13671
+ * Domain prices list
13672
+ */
13673
+ export type DomainPricesList = {
13674
+ /**
13675
+ * Total number of prices that matched your query.
13676
+ */
13677
+ total: number;
13678
+ /**
13679
+ * List of prices.
13680
+ */
13681
+ prices: DomainPrice[];
13682
+ };
13232
13683
  /**
13233
13684
  * Domains list
13234
13685
  */