@appwrite.io/console 16.0.0 → 17.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -6
- package/dist/cjs/package.json +1 -1
- package/dist/cjs/sdk.js +8558 -4805
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/package.json +1 -1
- package/dist/esm/sdk.js +8559 -4806
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +8558 -4805
- package/package.json +59 -50
- package/types/client.d.ts +2 -13
- package/types/enums/{addon.d.ts → addon-key.d.ts} +1 -1
- package/types/enums/authentication-factor.d.ts +2 -1
- package/types/enums/billing-plan-group.d.ts +2 -1
- package/types/enums/build-runtime.d.ts +4 -1
- package/types/enums/cache-database.d.ts +1 -2
- package/types/enums/embedding-model.d.ts +1 -3
- package/types/enums/execution-resource-type.d.ts +4 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/id-token-provider.d.ts +4 -0
- package/types/enums/image-gravity.d.ts +1 -0
- package/types/enums/o-auth-provider.d.ts +5 -0
- package/types/enums/organization-key-scopes.d.ts +2 -4
- package/types/enums/project-email-template-id.d.ts +2 -1
- package/types/enums/project-key-scopes.d.ts +20 -3
- package/types/enums/project-o-auth-provider-id.d.ts +5 -0
- package/types/enums/project-policy-id.d.ts +2 -0
- package/types/enums/query-suggestion-resource.d.ts +2 -3
- package/types/enums/runtime.d.ts +4 -1
- package/types/enums/usage-event-dimension.d.ts +7 -1
- package/types/enums/usage-event-metric.d.ts +55 -0
- package/types/enums/usage-gauge-metric.d.ts +50 -0
- package/types/index.d.ts +11 -6
- package/types/models.d.ts +696 -776
- package/types/services/account.d.ts +124 -36
- package/types/services/apps.d.ts +6 -6
- package/types/services/avatars.d.ts +44 -0
- package/types/services/console.d.ts +2 -2
- package/types/services/databases.d.ts +8 -8
- package/types/services/documents-db.d.ts +13 -7
- package/types/services/domains.d.ts +82 -54
- package/types/services/functions.d.ts +6 -6
- package/types/services/manager.d.ts +14 -14
- package/types/services/messaging.d.ts +80 -6
- package/types/services/mongo.d.ts +17 -23
- package/types/services/mysql.d.ts +17 -23
- package/types/services/organization.d.ts +165 -0
- package/types/services/organizations.d.ts +24 -24
- package/types/services/postgresql.d.ts +17 -23
- package/types/services/project.d.ts +218 -51
- package/types/services/projects.d.ts +0 -94
- package/types/services/sites.d.ts +15 -8
- package/types/services/storage.d.ts +2 -2
- package/types/services/tables-db.d.ts +37 -12
- package/types/services/teams.d.ts +0 -25
- package/types/services/usage.d.ts +23 -14
- package/types/services/users.d.ts +26 -29
- package/types/services/vectors-db.d.ts +15 -9
- package/types/services/waf.d.ts +11 -2
- package/types/enums/project-usage-range.d.ts +0 -4
package/types/models.d.ts
CHANGED
|
@@ -1,25 +1,26 @@
|
|
|
1
|
-
import { DatabaseType } from
|
|
2
|
-
import { AttributeStatus } from
|
|
3
|
-
import { ColumnStatus } from
|
|
4
|
-
import { IndexStatus } from
|
|
5
|
-
import { DetectionFrameworkType } from
|
|
6
|
-
import { DetectionRuntimeType } from
|
|
7
|
-
import { DeploymentStatus } from
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
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
|
*/
|
|
@@ -181,19 +182,6 @@ export declare namespace Models {
|
|
|
181
182
|
*/
|
|
182
183
|
notifications: Notification[];
|
|
183
184
|
};
|
|
184
|
-
/**
|
|
185
|
-
* Logs List
|
|
186
|
-
*/
|
|
187
|
-
export type LogList = {
|
|
188
|
-
/**
|
|
189
|
-
* Total number of logs that matched your query.
|
|
190
|
-
*/
|
|
191
|
-
total: number;
|
|
192
|
-
/**
|
|
193
|
-
* List of logs.
|
|
194
|
-
*/
|
|
195
|
-
logs: Log[];
|
|
196
|
-
};
|
|
197
185
|
/**
|
|
198
186
|
* Files List
|
|
199
187
|
*/
|
|
@@ -500,19 +488,6 @@ export declare namespace Models {
|
|
|
500
488
|
*/
|
|
501
489
|
keys: Key[];
|
|
502
490
|
};
|
|
503
|
-
/**
|
|
504
|
-
* Dev Keys List
|
|
505
|
-
*/
|
|
506
|
-
export type DevKeyList = {
|
|
507
|
-
/**
|
|
508
|
-
* Total number of devKeys that matched your query.
|
|
509
|
-
*/
|
|
510
|
-
total: number;
|
|
511
|
-
/**
|
|
512
|
-
* List of devKeys.
|
|
513
|
-
*/
|
|
514
|
-
devKeys: DevKey[];
|
|
515
|
-
};
|
|
516
491
|
/**
|
|
517
492
|
* Countries List
|
|
518
493
|
*/
|
|
@@ -615,7 +590,7 @@ export declare namespace Models {
|
|
|
615
590
|
/**
|
|
616
591
|
* List of policies.
|
|
617
592
|
*/
|
|
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)[];
|
|
593
|
+
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail)[];
|
|
619
594
|
};
|
|
620
595
|
/**
|
|
621
596
|
* Email Templates List
|
|
@@ -891,6 +866,18 @@ export declare namespace Models {
|
|
|
891
866
|
* Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.
|
|
892
867
|
*/
|
|
893
868
|
replicas?: number;
|
|
869
|
+
/**
|
|
870
|
+
* Error message when the dedicated backing failed. Null when the database has no dedicated backing or has not failed.
|
|
871
|
+
*/
|
|
872
|
+
error?: string;
|
|
873
|
+
/**
|
|
874
|
+
* 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.
|
|
875
|
+
*/
|
|
876
|
+
containerStatus?: string;
|
|
877
|
+
/**
|
|
878
|
+
* 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.
|
|
879
|
+
*/
|
|
880
|
+
lifecycleState?: string;
|
|
894
881
|
/**
|
|
895
882
|
* Database backup policies.
|
|
896
883
|
*/
|
|
@@ -3061,99 +3048,6 @@ export declare namespace Models {
|
|
|
3061
3048
|
*/
|
|
3062
3049
|
metadata?: object;
|
|
3063
3050
|
};
|
|
3064
|
-
/**
|
|
3065
|
-
* Log
|
|
3066
|
-
*/
|
|
3067
|
-
export type Log = {
|
|
3068
|
-
/**
|
|
3069
|
-
* Event name.
|
|
3070
|
-
*/
|
|
3071
|
-
event: string;
|
|
3072
|
-
/**
|
|
3073
|
-
* User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.
|
|
3074
|
-
*/
|
|
3075
|
-
userId: string;
|
|
3076
|
-
/**
|
|
3077
|
-
* User email of the actor recorded for this log. During impersonation, this is the original impersonator.
|
|
3078
|
-
*/
|
|
3079
|
-
userEmail: string;
|
|
3080
|
-
/**
|
|
3081
|
-
* User name of the actor recorded for this log. During impersonation, this is the original impersonator.
|
|
3082
|
-
*/
|
|
3083
|
-
userName: string;
|
|
3084
|
-
/**
|
|
3085
|
-
* API mode when event triggered.
|
|
3086
|
-
*/
|
|
3087
|
-
mode: string;
|
|
3088
|
-
/**
|
|
3089
|
-
* User type who triggered the audit log. Possible values: user, admin, guest, hidden, keyProject, keyAccount, keyOrganization.
|
|
3090
|
-
*/
|
|
3091
|
-
userType: string;
|
|
3092
|
-
/**
|
|
3093
|
-
* IP session in use when the session was created.
|
|
3094
|
-
*/
|
|
3095
|
-
ip: string;
|
|
3096
|
-
/**
|
|
3097
|
-
* Log creation date in ISO 8601 format.
|
|
3098
|
-
*/
|
|
3099
|
-
time: string;
|
|
3100
|
-
/**
|
|
3101
|
-
* Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
|
|
3102
|
-
*/
|
|
3103
|
-
osCode: string;
|
|
3104
|
-
/**
|
|
3105
|
-
* Operating system name.
|
|
3106
|
-
*/
|
|
3107
|
-
osName: string;
|
|
3108
|
-
/**
|
|
3109
|
-
* Operating system version.
|
|
3110
|
-
*/
|
|
3111
|
-
osVersion: string;
|
|
3112
|
-
/**
|
|
3113
|
-
* Client type.
|
|
3114
|
-
*/
|
|
3115
|
-
clientType: string;
|
|
3116
|
-
/**
|
|
3117
|
-
* Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
|
|
3118
|
-
*/
|
|
3119
|
-
clientCode: string;
|
|
3120
|
-
/**
|
|
3121
|
-
* Client name.
|
|
3122
|
-
*/
|
|
3123
|
-
clientName: string;
|
|
3124
|
-
/**
|
|
3125
|
-
* Client version.
|
|
3126
|
-
*/
|
|
3127
|
-
clientVersion: string;
|
|
3128
|
-
/**
|
|
3129
|
-
* Client engine name.
|
|
3130
|
-
*/
|
|
3131
|
-
clientEngine: string;
|
|
3132
|
-
/**
|
|
3133
|
-
* Client engine name.
|
|
3134
|
-
*/
|
|
3135
|
-
clientEngineVersion: string;
|
|
3136
|
-
/**
|
|
3137
|
-
* Device name.
|
|
3138
|
-
*/
|
|
3139
|
-
deviceName: string;
|
|
3140
|
-
/**
|
|
3141
|
-
* Device brand name.
|
|
3142
|
-
*/
|
|
3143
|
-
deviceBrand: string;
|
|
3144
|
-
/**
|
|
3145
|
-
* Device model name.
|
|
3146
|
-
*/
|
|
3147
|
-
deviceModel: string;
|
|
3148
|
-
/**
|
|
3149
|
-
* Country two-character ISO 3166-1 alpha code.
|
|
3150
|
-
*/
|
|
3151
|
-
countryCode: string;
|
|
3152
|
-
/**
|
|
3153
|
-
* Country name.
|
|
3154
|
-
*/
|
|
3155
|
-
countryName: string;
|
|
3156
|
-
};
|
|
3157
3051
|
/**
|
|
3158
3052
|
* User
|
|
3159
3053
|
*/
|
|
@@ -3234,6 +3128,10 @@ export declare namespace Models {
|
|
|
3234
3128
|
* Whether the user email is in its canonical form.
|
|
3235
3129
|
*/
|
|
3236
3130
|
emailIsCanonical?: boolean;
|
|
3131
|
+
/**
|
|
3132
|
+
* Whether the password was found in a known data breach the last time it was checked. Null when the password has never been checked.
|
|
3133
|
+
*/
|
|
3134
|
+
passwordPwned?: boolean;
|
|
3237
3135
|
/**
|
|
3238
3136
|
* Phone verification status.
|
|
3239
3137
|
*/
|
|
@@ -3539,6 +3437,10 @@ export declare namespace Models {
|
|
|
3539
3437
|
* Identity Provider Refresh Token.
|
|
3540
3438
|
*/
|
|
3541
3439
|
providerRefreshToken: string;
|
|
3440
|
+
/**
|
|
3441
|
+
* Identity Provider ID token (JWT) from the most recent native sign-in. Empty for identities created through the browser OAuth2 flow.
|
|
3442
|
+
*/
|
|
3443
|
+
providerIdToken: string;
|
|
3542
3444
|
};
|
|
3543
3445
|
/**
|
|
3544
3446
|
* Notification
|
|
@@ -4062,6 +3964,10 @@ export declare namespace Models {
|
|
|
4062
3964
|
* Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
|
|
4063
3965
|
*/
|
|
4064
3966
|
latestDeploymentStatus: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* Allowed permission scopes.
|
|
3969
|
+
*/
|
|
3970
|
+
scopes: string[];
|
|
4065
3971
|
/**
|
|
4066
3972
|
* Site variables.
|
|
4067
3973
|
*/
|
|
@@ -4154,7 +4060,7 @@ export declare namespace Models {
|
|
|
4154
4060
|
/**
|
|
4155
4061
|
* URL hosting a template demo.
|
|
4156
4062
|
*/
|
|
4157
|
-
demoUrl
|
|
4063
|
+
demoUrl?: string;
|
|
4158
4064
|
/**
|
|
4159
4065
|
* File URL with preview screenshot in dark theme preference.
|
|
4160
4066
|
*/
|
|
@@ -4231,7 +4137,7 @@ export declare namespace Models {
|
|
|
4231
4137
|
/**
|
|
4232
4138
|
* Fallback file for SPA. Only relevant for static serve runtime.
|
|
4233
4139
|
*/
|
|
4234
|
-
fallbackFile
|
|
4140
|
+
fallbackFile?: string;
|
|
4235
4141
|
};
|
|
4236
4142
|
/**
|
|
4237
4143
|
* Function
|
|
@@ -4843,7 +4749,7 @@ export declare namespace Models {
|
|
|
4843
4749
|
/**
|
|
4844
4750
|
* Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
|
|
4845
4751
|
*/
|
|
4846
|
-
fallbackFile
|
|
4752
|
+
fallbackFile?: string;
|
|
4847
4753
|
};
|
|
4848
4754
|
/**
|
|
4849
4755
|
* Deployment
|
|
@@ -4979,19 +4885,23 @@ export declare namespace Models {
|
|
|
4979
4885
|
*/
|
|
4980
4886
|
$permissions: string[];
|
|
4981
4887
|
/**
|
|
4982
|
-
* Function ID.
|
|
4888
|
+
* Function or site ID.
|
|
4889
|
+
*/
|
|
4890
|
+
resourceId: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Execution resource type.
|
|
4983
4893
|
*/
|
|
4984
|
-
|
|
4894
|
+
resourceType: ExecutionResourceType;
|
|
4985
4895
|
/**
|
|
4986
|
-
*
|
|
4896
|
+
* Deployment ID used to create the execution.
|
|
4987
4897
|
*/
|
|
4988
4898
|
deploymentId: string;
|
|
4989
4899
|
/**
|
|
4990
|
-
* The trigger that caused the
|
|
4900
|
+
* The trigger that caused the resource to execute. Possible values can be: `http`, `schedule`, or `event`.
|
|
4991
4901
|
*/
|
|
4992
4902
|
trigger: ExecutionTrigger;
|
|
4993
4903
|
/**
|
|
4994
|
-
* The status of the
|
|
4904
|
+
* The status of the resource execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
|
|
4995
4905
|
*/
|
|
4996
4906
|
status: ExecutionStatus;
|
|
4997
4907
|
/**
|
|
@@ -5019,15 +4929,15 @@ export declare namespace Models {
|
|
|
5019
4929
|
*/
|
|
5020
4930
|
responseHeaders: Headers[];
|
|
5021
4931
|
/**
|
|
5022
|
-
*
|
|
4932
|
+
* 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
4933
|
*/
|
|
5024
4934
|
logs: string;
|
|
5025
4935
|
/**
|
|
5026
|
-
*
|
|
4936
|
+
* 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
4937
|
*/
|
|
5028
4938
|
errors: string;
|
|
5029
4939
|
/**
|
|
5030
|
-
*
|
|
4940
|
+
* Total time the resource(function/site) took to respond, in seconds.
|
|
5031
4941
|
*/
|
|
5032
4942
|
duration: number;
|
|
5033
4943
|
/**
|
|
@@ -5063,10 +4973,6 @@ export declare namespace Models {
|
|
|
5063
4973
|
* Project region
|
|
5064
4974
|
*/
|
|
5065
4975
|
region: string;
|
|
5066
|
-
/**
|
|
5067
|
-
* Deprecated since 1.9.5: List of dev keys.
|
|
5068
|
-
*/
|
|
5069
|
-
devKeys: DevKey[];
|
|
5070
4976
|
/**
|
|
5071
4977
|
* Status for custom SMTP
|
|
5072
4978
|
*/
|
|
@@ -5150,11 +5056,19 @@ export declare namespace Models {
|
|
|
5150
5056
|
/**
|
|
5151
5057
|
* Whether WAF enforcement is enabled for the project.
|
|
5152
5058
|
*/
|
|
5153
|
-
wafEnabled
|
|
5059
|
+
wafEnabled?: boolean;
|
|
5154
5060
|
/**
|
|
5155
5061
|
* Billing limits reached
|
|
5156
5062
|
*/
|
|
5157
5063
|
billingLimits?: BillingLimits;
|
|
5064
|
+
/**
|
|
5065
|
+
* First time the project received a non-console API request. Empty until the project is used.
|
|
5066
|
+
*/
|
|
5067
|
+
firstAccessedAt?: string;
|
|
5068
|
+
/**
|
|
5069
|
+
* Last time the project was accessed through the MCP server. Empty if it was never accessed via MCP.
|
|
5070
|
+
*/
|
|
5071
|
+
mcpAccessedAt?: string;
|
|
5158
5072
|
/**
|
|
5159
5073
|
* OAuth2 server status
|
|
5160
5074
|
*/
|
|
@@ -5171,6 +5085,10 @@ export declare namespace Models {
|
|
|
5171
5085
|
* OAuth2 server scopes used when an authorization request omits the scope parameter
|
|
5172
5086
|
*/
|
|
5173
5087
|
oAuth2ServerDefaultScopes?: string[];
|
|
5088
|
+
/**
|
|
5089
|
+
* Scopes an application may request when installed on a team
|
|
5090
|
+
*/
|
|
5091
|
+
oAuth2ServerInstallationScopes?: string[];
|
|
5174
5092
|
/**
|
|
5175
5093
|
* OAuth2 server accepted RFC 9396 authorization_details types
|
|
5176
5094
|
*/
|
|
@@ -5398,43 +5316,6 @@ export declare namespace Models {
|
|
|
5398
5316
|
*/
|
|
5399
5317
|
sdks: string[];
|
|
5400
5318
|
};
|
|
5401
|
-
/**
|
|
5402
|
-
* DevKey
|
|
5403
|
-
*/
|
|
5404
|
-
export type DevKey = {
|
|
5405
|
-
/**
|
|
5406
|
-
* Key ID.
|
|
5407
|
-
*/
|
|
5408
|
-
$id: string;
|
|
5409
|
-
/**
|
|
5410
|
-
* Key creation date in ISO 8601 format.
|
|
5411
|
-
*/
|
|
5412
|
-
$createdAt: string;
|
|
5413
|
-
/**
|
|
5414
|
-
* Key update date in ISO 8601 format.
|
|
5415
|
-
*/
|
|
5416
|
-
$updatedAt: string;
|
|
5417
|
-
/**
|
|
5418
|
-
* Key name.
|
|
5419
|
-
*/
|
|
5420
|
-
name: string;
|
|
5421
|
-
/**
|
|
5422
|
-
* Key expiration date in ISO 8601 format.
|
|
5423
|
-
*/
|
|
5424
|
-
expire: string;
|
|
5425
|
-
/**
|
|
5426
|
-
* Secret key.
|
|
5427
|
-
*/
|
|
5428
|
-
secret: string;
|
|
5429
|
-
/**
|
|
5430
|
-
* Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
|
|
5431
|
-
*/
|
|
5432
|
-
accessedAt: string;
|
|
5433
|
-
/**
|
|
5434
|
-
* List of SDK user agents that used this key.
|
|
5435
|
-
*/
|
|
5436
|
-
sdks: string[];
|
|
5437
|
-
};
|
|
5438
5319
|
/**
|
|
5439
5320
|
* Mock Number
|
|
5440
5321
|
*/
|
|
@@ -5669,6 +5550,14 @@ export declare namespace Models {
|
|
|
5669
5550
|
* Google OAuth2 prompt values.
|
|
5670
5551
|
*/
|
|
5671
5552
|
prompt: OAuth2GooglePrompt[];
|
|
5553
|
+
/**
|
|
5554
|
+
* Native Google sign-in is active and can be used to create sessions from an ID token. Independent of enabled, which only controls the browser-based flow.
|
|
5555
|
+
*/
|
|
5556
|
+
nativeEnabled: boolean;
|
|
5557
|
+
/**
|
|
5558
|
+
* Additional OAuth2 client IDs accepted as ID token audiences for native sign-in, next to the client ID.
|
|
5559
|
+
*/
|
|
5560
|
+
nativeClientIds: string[];
|
|
5672
5561
|
};
|
|
5673
5562
|
/**
|
|
5674
5563
|
* OAuth2Zoom
|
|
@@ -5943,6 +5832,48 @@ export declare namespace Models {
|
|
|
5943
5832
|
*/
|
|
5944
5833
|
clientSecret: string;
|
|
5945
5834
|
};
|
|
5835
|
+
/**
|
|
5836
|
+
* OAuth2Cloudflare
|
|
5837
|
+
*/
|
|
5838
|
+
export type OAuth2Cloudflare = {
|
|
5839
|
+
/**
|
|
5840
|
+
* OAuth2 provider ID.
|
|
5841
|
+
*/
|
|
5842
|
+
$id: string;
|
|
5843
|
+
/**
|
|
5844
|
+
* OAuth2 provider is active and can be used to create sessions.
|
|
5845
|
+
*/
|
|
5846
|
+
enabled: boolean;
|
|
5847
|
+
/**
|
|
5848
|
+
* Cloudflare OAuth2 client ID.
|
|
5849
|
+
*/
|
|
5850
|
+
clientId: string;
|
|
5851
|
+
/**
|
|
5852
|
+
* Cloudflare OAuth2 client secret.
|
|
5853
|
+
*/
|
|
5854
|
+
clientSecret: string;
|
|
5855
|
+
};
|
|
5856
|
+
/**
|
|
5857
|
+
* OAuth2HuggingFace
|
|
5858
|
+
*/
|
|
5859
|
+
export type OAuth2HuggingFace = {
|
|
5860
|
+
/**
|
|
5861
|
+
* OAuth2 provider ID.
|
|
5862
|
+
*/
|
|
5863
|
+
$id: string;
|
|
5864
|
+
/**
|
|
5865
|
+
* OAuth2 provider is active and can be used to create sessions.
|
|
5866
|
+
*/
|
|
5867
|
+
enabled: boolean;
|
|
5868
|
+
/**
|
|
5869
|
+
* Hugging Face OAuth2 client ID.
|
|
5870
|
+
*/
|
|
5871
|
+
clientId: string;
|
|
5872
|
+
/**
|
|
5873
|
+
* Hugging Face OAuth2 client secret.
|
|
5874
|
+
*/
|
|
5875
|
+
clientSecret: string;
|
|
5876
|
+
};
|
|
5946
5877
|
/**
|
|
5947
5878
|
* OAuth2Linkedin
|
|
5948
5879
|
*/
|
|
@@ -6363,6 +6294,14 @@ export declare namespace Models {
|
|
|
6363
6294
|
* Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.
|
|
6364
6295
|
*/
|
|
6365
6296
|
p8File: string;
|
|
6297
|
+
/**
|
|
6298
|
+
* Native Sign in with Apple is active and can be used to create sessions from an ID token. Independent of enabled, which only controls the browser-based flow.
|
|
6299
|
+
*/
|
|
6300
|
+
nativeEnabled: boolean;
|
|
6301
|
+
/**
|
|
6302
|
+
* App bundle IDs accepted as ID token audiences for native Sign in with Apple, next to the Services ID.
|
|
6303
|
+
*/
|
|
6304
|
+
nativeClientIds: string[];
|
|
6366
6305
|
};
|
|
6367
6306
|
/**
|
|
6368
6307
|
* OAuth2Microsoft
|
|
@@ -6390,68 +6329,131 @@ export declare namespace Models {
|
|
|
6390
6329
|
tenant: string;
|
|
6391
6330
|
};
|
|
6392
6331
|
/**
|
|
6393
|
-
*
|
|
6332
|
+
* OAuth2Resend
|
|
6394
6333
|
*/
|
|
6395
|
-
export type
|
|
6334
|
+
export type OAuth2Resend = {
|
|
6396
6335
|
/**
|
|
6397
|
-
*
|
|
6336
|
+
* OAuth2 provider ID.
|
|
6398
6337
|
*/
|
|
6399
|
-
|
|
6338
|
+
$id: string;
|
|
6400
6339
|
/**
|
|
6401
|
-
*
|
|
6340
|
+
* OAuth2 provider is active and can be used to create sessions.
|
|
6341
|
+
*/
|
|
6342
|
+
enabled: boolean;
|
|
6343
|
+
/**
|
|
6344
|
+
* Resend OAuth2 client ID.
|
|
6345
|
+
*/
|
|
6346
|
+
clientId: string;
|
|
6347
|
+
/**
|
|
6348
|
+
* Resend OAuth2 client secret.
|
|
6402
6349
|
*/
|
|
6403
|
-
|
|
6350
|
+
clientSecret: string;
|
|
6404
6351
|
};
|
|
6405
6352
|
/**
|
|
6406
|
-
*
|
|
6353
|
+
* OAuth2TikTok
|
|
6407
6354
|
*/
|
|
6408
|
-
export type
|
|
6355
|
+
export type OAuth2TikTok = {
|
|
6409
6356
|
/**
|
|
6410
|
-
*
|
|
6357
|
+
* OAuth2 provider ID.
|
|
6411
6358
|
*/
|
|
6412
6359
|
$id: string;
|
|
6413
6360
|
/**
|
|
6414
|
-
*
|
|
6361
|
+
* OAuth2 provider is active and can be used to create sessions.
|
|
6415
6362
|
*/
|
|
6416
6363
|
enabled: boolean;
|
|
6417
|
-
};
|
|
6418
|
-
/**
|
|
6419
|
-
* Policy Password History
|
|
6420
|
-
*/
|
|
6421
|
-
export type PolicyPasswordHistory = {
|
|
6422
6364
|
/**
|
|
6423
|
-
*
|
|
6365
|
+
* TikTok OAuth2 client key.
|
|
6424
6366
|
*/
|
|
6425
|
-
|
|
6367
|
+
clientId: string;
|
|
6426
6368
|
/**
|
|
6427
|
-
*
|
|
6369
|
+
* TikTok OAuth2 client secret.
|
|
6428
6370
|
*/
|
|
6429
|
-
|
|
6371
|
+
clientSecret: string;
|
|
6430
6372
|
};
|
|
6431
6373
|
/**
|
|
6432
|
-
*
|
|
6374
|
+
* OAuth2Kakao
|
|
6433
6375
|
*/
|
|
6434
|
-
export type
|
|
6376
|
+
export type OAuth2Kakao = {
|
|
6435
6377
|
/**
|
|
6436
|
-
*
|
|
6378
|
+
* OAuth2 provider ID.
|
|
6437
6379
|
*/
|
|
6438
6380
|
$id: string;
|
|
6439
6381
|
/**
|
|
6440
|
-
*
|
|
6441
|
-
*/
|
|
6442
|
-
min: number;
|
|
6443
|
-
/**
|
|
6444
|
-
* Whether passwords must include at least one uppercase letter.
|
|
6382
|
+
* OAuth2 provider is active and can be used to create sessions.
|
|
6445
6383
|
*/
|
|
6446
|
-
|
|
6384
|
+
enabled: boolean;
|
|
6447
6385
|
/**
|
|
6448
|
-
*
|
|
6386
|
+
* Kakao OAuth2 REST API key.
|
|
6449
6387
|
*/
|
|
6450
|
-
|
|
6388
|
+
clientId: string;
|
|
6451
6389
|
/**
|
|
6452
|
-
*
|
|
6390
|
+
* Kakao OAuth2 client secret.
|
|
6453
6391
|
*/
|
|
6454
|
-
|
|
6392
|
+
clientSecret: string;
|
|
6393
|
+
};
|
|
6394
|
+
/**
|
|
6395
|
+
* OAuth2 Providers List
|
|
6396
|
+
*/
|
|
6397
|
+
export type OAuth2ProviderList = {
|
|
6398
|
+
/**
|
|
6399
|
+
* Total number of OAuth2 providers in the given project.
|
|
6400
|
+
*/
|
|
6401
|
+
total: number;
|
|
6402
|
+
/**
|
|
6403
|
+
* List of OAuth2 providers.
|
|
6404
|
+
*/
|
|
6405
|
+
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)[];
|
|
6406
|
+
};
|
|
6407
|
+
/**
|
|
6408
|
+
* Policy Password Dictionary
|
|
6409
|
+
*/
|
|
6410
|
+
export type PolicyPasswordDictionary = {
|
|
6411
|
+
/**
|
|
6412
|
+
* Policy ID.
|
|
6413
|
+
*/
|
|
6414
|
+
$id: string;
|
|
6415
|
+
/**
|
|
6416
|
+
* Whether password dictionary policy is enabled.
|
|
6417
|
+
*/
|
|
6418
|
+
enabled: boolean;
|
|
6419
|
+
};
|
|
6420
|
+
/**
|
|
6421
|
+
* Policy Password History
|
|
6422
|
+
*/
|
|
6423
|
+
export type PolicyPasswordHistory = {
|
|
6424
|
+
/**
|
|
6425
|
+
* Policy ID.
|
|
6426
|
+
*/
|
|
6427
|
+
$id: string;
|
|
6428
|
+
/**
|
|
6429
|
+
* Password history length. A value of 0 means the policy is disabled.
|
|
6430
|
+
*/
|
|
6431
|
+
total: number;
|
|
6432
|
+
};
|
|
6433
|
+
/**
|
|
6434
|
+
* Policy Password Strength
|
|
6435
|
+
*/
|
|
6436
|
+
export type PolicyPasswordStrength = {
|
|
6437
|
+
/**
|
|
6438
|
+
* Policy ID.
|
|
6439
|
+
*/
|
|
6440
|
+
$id: string;
|
|
6441
|
+
/**
|
|
6442
|
+
* Minimum password length required for user passwords.
|
|
6443
|
+
*/
|
|
6444
|
+
min: number;
|
|
6445
|
+
/**
|
|
6446
|
+
* Whether passwords must include at least one uppercase letter.
|
|
6447
|
+
*/
|
|
6448
|
+
uppercase: boolean;
|
|
6449
|
+
/**
|
|
6450
|
+
* Whether passwords must include at least one lowercase letter.
|
|
6451
|
+
*/
|
|
6452
|
+
lowercase: boolean;
|
|
6453
|
+
/**
|
|
6454
|
+
* Whether passwords must include at least one number.
|
|
6455
|
+
*/
|
|
6456
|
+
number: boolean;
|
|
6455
6457
|
/**
|
|
6456
6458
|
* Whether passwords must include at least one symbol.
|
|
6457
6459
|
*/
|
|
@@ -6470,6 +6472,27 @@ export declare namespace Models {
|
|
|
6470
6472
|
*/
|
|
6471
6473
|
enabled: boolean;
|
|
6472
6474
|
};
|
|
6475
|
+
/**
|
|
6476
|
+
* Policy Password Pwned
|
|
6477
|
+
*/
|
|
6478
|
+
export type PolicyPasswordPwned = {
|
|
6479
|
+
/**
|
|
6480
|
+
* Policy ID.
|
|
6481
|
+
*/
|
|
6482
|
+
$id: string;
|
|
6483
|
+
/**
|
|
6484
|
+
* Whether password pwned policy is enabled.
|
|
6485
|
+
*/
|
|
6486
|
+
enabled: boolean;
|
|
6487
|
+
/**
|
|
6488
|
+
* Whether passwords are checked when a session is created.
|
|
6489
|
+
*/
|
|
6490
|
+
sessions: boolean;
|
|
6491
|
+
/**
|
|
6492
|
+
* Whether users signing in with a breached password are blocked until they reset it. Only applies when sessions are checked.
|
|
6493
|
+
*/
|
|
6494
|
+
users: boolean;
|
|
6495
|
+
};
|
|
6473
6496
|
/**
|
|
6474
6497
|
* Policy Session Alert
|
|
6475
6498
|
*/
|
|
@@ -6568,6 +6591,83 @@ export declare namespace Models {
|
|
|
6568
6591
|
*/
|
|
6569
6592
|
userAccessedAt: boolean;
|
|
6570
6593
|
};
|
|
6594
|
+
/**
|
|
6595
|
+
* Policy MFA Factors
|
|
6596
|
+
*/
|
|
6597
|
+
export type PolicyMfaFactors = {
|
|
6598
|
+
/**
|
|
6599
|
+
* Policy ID.
|
|
6600
|
+
*/
|
|
6601
|
+
$id: string;
|
|
6602
|
+
/**
|
|
6603
|
+
* Whether TOTP can be used to complete an MFA challenge.
|
|
6604
|
+
*/
|
|
6605
|
+
totp: boolean;
|
|
6606
|
+
/**
|
|
6607
|
+
* Whether email can be used to complete an MFA challenge.
|
|
6608
|
+
*/
|
|
6609
|
+
email: boolean;
|
|
6610
|
+
/**
|
|
6611
|
+
* Whether phone (SMS) can be used to complete an MFA challenge.
|
|
6612
|
+
*/
|
|
6613
|
+
phone: boolean;
|
|
6614
|
+
/**
|
|
6615
|
+
* Whether the custom factor can be used to complete an MFA challenge.
|
|
6616
|
+
*/
|
|
6617
|
+
custom: boolean;
|
|
6618
|
+
};
|
|
6619
|
+
/**
|
|
6620
|
+
* Policy Deny Aliased Email
|
|
6621
|
+
*/
|
|
6622
|
+
export type PolicyDenyAliasedEmail = {
|
|
6623
|
+
/**
|
|
6624
|
+
* Policy ID.
|
|
6625
|
+
*/
|
|
6626
|
+
$id: string;
|
|
6627
|
+
/**
|
|
6628
|
+
* Whether the deny aliased email policy is enabled.
|
|
6629
|
+
*/
|
|
6630
|
+
enabled: boolean;
|
|
6631
|
+
};
|
|
6632
|
+
/**
|
|
6633
|
+
* Policy Deny Disposable Email
|
|
6634
|
+
*/
|
|
6635
|
+
export type PolicyDenyDisposableEmail = {
|
|
6636
|
+
/**
|
|
6637
|
+
* Policy ID.
|
|
6638
|
+
*/
|
|
6639
|
+
$id: string;
|
|
6640
|
+
/**
|
|
6641
|
+
* Whether the deny disposable email policy is enabled.
|
|
6642
|
+
*/
|
|
6643
|
+
enabled: boolean;
|
|
6644
|
+
};
|
|
6645
|
+
/**
|
|
6646
|
+
* Policy Deny Free Email
|
|
6647
|
+
*/
|
|
6648
|
+
export type PolicyDenyFreeEmail = {
|
|
6649
|
+
/**
|
|
6650
|
+
* Policy ID.
|
|
6651
|
+
*/
|
|
6652
|
+
$id: string;
|
|
6653
|
+
/**
|
|
6654
|
+
* Whether the deny free email policy is enabled.
|
|
6655
|
+
*/
|
|
6656
|
+
enabled: boolean;
|
|
6657
|
+
};
|
|
6658
|
+
/**
|
|
6659
|
+
* Policy Deny Corporate Email
|
|
6660
|
+
*/
|
|
6661
|
+
export type PolicyDenyCorporateEmail = {
|
|
6662
|
+
/**
|
|
6663
|
+
* Policy ID.
|
|
6664
|
+
*/
|
|
6665
|
+
$id: string;
|
|
6666
|
+
/**
|
|
6667
|
+
* Whether the deny non-corporate email policy is enabled.
|
|
6668
|
+
*/
|
|
6669
|
+
enabled: boolean;
|
|
6670
|
+
};
|
|
6571
6671
|
/**
|
|
6572
6672
|
* Platform Web
|
|
6573
6673
|
*/
|
|
@@ -6869,27 +6969,6 @@ export declare namespace Models {
|
|
|
6869
6969
|
*/
|
|
6870
6970
|
date: string;
|
|
6871
6971
|
};
|
|
6872
|
-
/**
|
|
6873
|
-
* Metric Breakdown
|
|
6874
|
-
*/
|
|
6875
|
-
export type MetricBreakdown = {
|
|
6876
|
-
/**
|
|
6877
|
-
* Resource ID.
|
|
6878
|
-
*/
|
|
6879
|
-
resourceId?: string;
|
|
6880
|
-
/**
|
|
6881
|
-
* Resource name.
|
|
6882
|
-
*/
|
|
6883
|
-
name: string;
|
|
6884
|
-
/**
|
|
6885
|
-
* The value of this metric at the timestamp.
|
|
6886
|
-
*/
|
|
6887
|
-
value: number;
|
|
6888
|
-
/**
|
|
6889
|
-
* The estimated value of this metric at the end of the period.
|
|
6890
|
-
*/
|
|
6891
|
-
estimate?: number;
|
|
6892
|
-
};
|
|
6893
6972
|
/**
|
|
6894
6973
|
* UsageUsers
|
|
6895
6974
|
*/
|
|
@@ -6933,281 +7012,180 @@ export declare namespace Models {
|
|
|
6933
7012
|
presences: Metric[];
|
|
6934
7013
|
};
|
|
6935
7014
|
/**
|
|
6936
|
-
*
|
|
7015
|
+
* usageDataPoint
|
|
6937
7016
|
*/
|
|
6938
|
-
export type
|
|
6939
|
-
/**
|
|
6940
|
-
* Total aggregated number of function executions.
|
|
6941
|
-
*/
|
|
6942
|
-
executionsTotal: number;
|
|
6943
|
-
/**
|
|
6944
|
-
* Total aggregated number of documents in legacy/tablesdb.
|
|
6945
|
-
*/
|
|
6946
|
-
documentsTotal: number;
|
|
6947
|
-
/**
|
|
6948
|
-
* Total aggregated number of documents in documentsdb.
|
|
6949
|
-
*/
|
|
6950
|
-
documentsdbDocumentsTotal: number;
|
|
6951
|
-
/**
|
|
6952
|
-
* Total aggregated number of rows.
|
|
6953
|
-
*/
|
|
6954
|
-
rowsTotal: number;
|
|
6955
|
-
/**
|
|
6956
|
-
* Total aggregated number of databases.
|
|
6957
|
-
*/
|
|
6958
|
-
databasesTotal: number;
|
|
6959
|
-
/**
|
|
6960
|
-
* Total aggregated number of documentsdb.
|
|
6961
|
-
*/
|
|
6962
|
-
documentsdbTotal: number;
|
|
6963
|
-
/**
|
|
6964
|
-
* Total aggregated sum of databases storage size (in bytes).
|
|
6965
|
-
*/
|
|
6966
|
-
databasesStorageTotal: number;
|
|
6967
|
-
/**
|
|
6968
|
-
* Total aggregated sum of documentsdb databases storage size (in bytes).
|
|
6969
|
-
*/
|
|
6970
|
-
documentsdbDatabasesStorageTotal: number;
|
|
6971
|
-
/**
|
|
6972
|
-
* Total aggregated number of users.
|
|
6973
|
-
*/
|
|
6974
|
-
usersTotal: number;
|
|
6975
|
-
/**
|
|
6976
|
-
* Total aggregated sum of files storage size (in bytes).
|
|
6977
|
-
*/
|
|
6978
|
-
filesStorageTotal: number;
|
|
6979
|
-
/**
|
|
6980
|
-
* Total aggregated sum of functions storage size (in bytes).
|
|
6981
|
-
*/
|
|
6982
|
-
functionsStorageTotal: number;
|
|
6983
|
-
/**
|
|
6984
|
-
* Total aggregated sum of builds storage size (in bytes).
|
|
6985
|
-
*/
|
|
6986
|
-
buildsStorageTotal: number;
|
|
6987
|
-
/**
|
|
6988
|
-
* Total aggregated sum of deployments storage size (in bytes).
|
|
6989
|
-
*/
|
|
6990
|
-
deploymentsStorageTotal: number;
|
|
6991
|
-
/**
|
|
6992
|
-
* Total aggregated number of buckets.
|
|
6993
|
-
*/
|
|
6994
|
-
bucketsTotal: number;
|
|
6995
|
-
/**
|
|
6996
|
-
* Total aggregated number of function executions mbSeconds.
|
|
6997
|
-
*/
|
|
6998
|
-
executionsMbSecondsTotal: number;
|
|
6999
|
-
/**
|
|
7000
|
-
* Total aggregated number of function builds mbSeconds.
|
|
7001
|
-
*/
|
|
7002
|
-
buildsMbSecondsTotal: number;
|
|
7003
|
-
/**
|
|
7004
|
-
* Aggregated stats for total databases reads.
|
|
7005
|
-
*/
|
|
7006
|
-
databasesReadsTotal: number;
|
|
7007
|
-
/**
|
|
7008
|
-
* Aggregated stats for total databases writes.
|
|
7009
|
-
*/
|
|
7010
|
-
databasesWritesTotal: number;
|
|
7011
|
-
/**
|
|
7012
|
-
* Total number of documentsdb databases reads.
|
|
7013
|
-
*/
|
|
7014
|
-
documentsdbDatabasesReadsTotal: number;
|
|
7015
|
-
/**
|
|
7016
|
-
* Total number of documentsdb databases writes.
|
|
7017
|
-
*/
|
|
7018
|
-
documentsdbDatabasesWritesTotal: number;
|
|
7019
|
-
/**
|
|
7020
|
-
* Aggregated number of requests per period.
|
|
7021
|
-
*/
|
|
7022
|
-
requests: Metric[];
|
|
7023
|
-
/**
|
|
7024
|
-
* Aggregated number of consumed bandwidth per period.
|
|
7025
|
-
*/
|
|
7026
|
-
network: Metric[];
|
|
7027
|
-
/**
|
|
7028
|
-
* Aggregated number of users per period.
|
|
7029
|
-
*/
|
|
7030
|
-
users: Metric[];
|
|
7031
|
-
/**
|
|
7032
|
-
* Aggregated number of executions per period.
|
|
7033
|
-
*/
|
|
7034
|
-
executions: Metric[];
|
|
7035
|
-
/**
|
|
7036
|
-
* Aggregated stats for total auth phone.
|
|
7037
|
-
*/
|
|
7038
|
-
authPhoneTotal: number;
|
|
7039
|
-
/**
|
|
7040
|
-
* Aggregated stats for total auth phone estimation.
|
|
7041
|
-
*/
|
|
7042
|
-
authPhoneEstimate: number;
|
|
7043
|
-
/**
|
|
7044
|
-
* Aggregated breakdown in totals of phone auth by country.
|
|
7045
|
-
*/
|
|
7046
|
-
authPhoneCountryBreakdown: MetricBreakdown[];
|
|
7047
|
-
/**
|
|
7048
|
-
* Aggregated stats for database reads.
|
|
7049
|
-
*/
|
|
7050
|
-
databasesReads: Metric[];
|
|
7051
|
-
/**
|
|
7052
|
-
* Aggregated stats for database writes.
|
|
7053
|
-
*/
|
|
7054
|
-
databasesWrites: Metric[];
|
|
7017
|
+
export type UsageDataPoint = {
|
|
7055
7018
|
/**
|
|
7056
|
-
*
|
|
7019
|
+
* Bucket start timestamp in ISO 8601. Omitted for flat dimension aggregates.
|
|
7057
7020
|
*/
|
|
7058
|
-
|
|
7021
|
+
time?: string;
|
|
7059
7022
|
/**
|
|
7060
|
-
*
|
|
7023
|
+
* Aggregated value for the point.
|
|
7061
7024
|
*/
|
|
7062
|
-
|
|
7025
|
+
value: number;
|
|
7063
7026
|
/**
|
|
7064
|
-
*
|
|
7027
|
+
* Value when broken down by `path`.
|
|
7065
7028
|
*/
|
|
7066
|
-
|
|
7029
|
+
path?: string;
|
|
7067
7030
|
/**
|
|
7068
|
-
*
|
|
7031
|
+
* Value when broken down by `method`.
|
|
7069
7032
|
*/
|
|
7070
|
-
|
|
7033
|
+
method?: string;
|
|
7071
7034
|
/**
|
|
7072
|
-
*
|
|
7035
|
+
* Value when broken down by `status`.
|
|
7073
7036
|
*/
|
|
7074
|
-
|
|
7037
|
+
status?: string;
|
|
7075
7038
|
/**
|
|
7076
|
-
*
|
|
7039
|
+
* Value when broken down by `service`.
|
|
7077
7040
|
*/
|
|
7078
|
-
|
|
7041
|
+
service?: string;
|
|
7079
7042
|
/**
|
|
7080
|
-
*
|
|
7043
|
+
* Value when broken down by `country`.
|
|
7081
7044
|
*/
|
|
7082
|
-
|
|
7045
|
+
country?: string;
|
|
7083
7046
|
/**
|
|
7084
|
-
*
|
|
7047
|
+
* Value when broken down by `region`.
|
|
7085
7048
|
*/
|
|
7086
|
-
|
|
7049
|
+
region?: string;
|
|
7087
7050
|
/**
|
|
7088
|
-
*
|
|
7051
|
+
* Value when broken down by `hostname`.
|
|
7089
7052
|
*/
|
|
7090
|
-
|
|
7053
|
+
hostname?: string;
|
|
7091
7054
|
/**
|
|
7092
|
-
*
|
|
7055
|
+
* Value when broken down by `ip`.
|
|
7093
7056
|
*/
|
|
7094
|
-
|
|
7057
|
+
ip?: string;
|
|
7095
7058
|
/**
|
|
7096
|
-
*
|
|
7059
|
+
* Value when broken down by `protocol`.
|
|
7097
7060
|
*/
|
|
7098
|
-
|
|
7061
|
+
protocol?: string;
|
|
7099
7062
|
/**
|
|
7100
|
-
*
|
|
7063
|
+
* Value when broken down by `accept`.
|
|
7101
7064
|
*/
|
|
7102
|
-
|
|
7065
|
+
accept?: string;
|
|
7103
7066
|
/**
|
|
7104
|
-
*
|
|
7067
|
+
* Value when broken down by `acceptLanguage`.
|
|
7105
7068
|
*/
|
|
7106
|
-
|
|
7069
|
+
acceptLanguage?: string;
|
|
7107
7070
|
/**
|
|
7108
|
-
*
|
|
7071
|
+
* Value when broken down by `queryKeys`.
|
|
7109
7072
|
*/
|
|
7110
|
-
|
|
7073
|
+
queryKeys?: string;
|
|
7111
7074
|
/**
|
|
7112
|
-
*
|
|
7075
|
+
* Value when broken down by `osName`.
|
|
7113
7076
|
*/
|
|
7114
|
-
|
|
7077
|
+
osName?: string;
|
|
7115
7078
|
/**
|
|
7116
|
-
*
|
|
7079
|
+
* Value when broken down by `clientType`.
|
|
7117
7080
|
*/
|
|
7118
|
-
|
|
7081
|
+
clientType?: string;
|
|
7119
7082
|
/**
|
|
7120
|
-
*
|
|
7083
|
+
* Value when broken down by `clientName`.
|
|
7121
7084
|
*/
|
|
7122
|
-
|
|
7085
|
+
clientName?: string;
|
|
7123
7086
|
/**
|
|
7124
|
-
*
|
|
7087
|
+
* Value when broken down by `sdk`.
|
|
7125
7088
|
*/
|
|
7126
|
-
|
|
7089
|
+
sdk?: string;
|
|
7127
7090
|
/**
|
|
7128
|
-
*
|
|
7091
|
+
* Value when broken down by `sdkVersion`.
|
|
7129
7092
|
*/
|
|
7130
|
-
|
|
7093
|
+
sdkVersion?: string;
|
|
7131
7094
|
/**
|
|
7132
|
-
*
|
|
7095
|
+
* Value when broken down by `deviceName`.
|
|
7133
7096
|
*/
|
|
7134
|
-
|
|
7097
|
+
deviceName?: string;
|
|
7135
7098
|
/**
|
|
7136
|
-
*
|
|
7099
|
+
* Value when broken down by `resourceId`.
|
|
7137
7100
|
*/
|
|
7138
|
-
|
|
7101
|
+
resourceId?: string;
|
|
7139
7102
|
/**
|
|
7140
|
-
*
|
|
7103
|
+
* Value when broken down by `resourceType`.
|
|
7141
7104
|
*/
|
|
7142
|
-
|
|
7105
|
+
resourceType?: string;
|
|
7143
7106
|
/**
|
|
7144
|
-
*
|
|
7107
|
+
* Value when broken down by `ordinal`.
|
|
7145
7108
|
*/
|
|
7146
|
-
|
|
7109
|
+
ordinal?: string;
|
|
7147
7110
|
/**
|
|
7148
|
-
*
|
|
7111
|
+
* Continent code when broken down by `continentCode`.
|
|
7149
7112
|
*/
|
|
7150
|
-
|
|
7113
|
+
continentCode?: string;
|
|
7151
7114
|
/**
|
|
7152
|
-
*
|
|
7115
|
+
* City name when broken down by `city`.
|
|
7153
7116
|
*/
|
|
7154
|
-
|
|
7117
|
+
city?: string;
|
|
7155
7118
|
/**
|
|
7156
|
-
*
|
|
7119
|
+
* Region/state chain when broken down by `subdivisions`.
|
|
7157
7120
|
*/
|
|
7158
|
-
|
|
7121
|
+
subdivisions?: string;
|
|
7159
7122
|
/**
|
|
7160
|
-
*
|
|
7123
|
+
* Internet service provider when broken down by `isp`.
|
|
7161
7124
|
*/
|
|
7162
|
-
|
|
7125
|
+
isp?: string;
|
|
7163
7126
|
/**
|
|
7164
|
-
*
|
|
7127
|
+
* Autonomous System Number (ASN) when broken down by `autonomousSystemNumber`.
|
|
7165
7128
|
*/
|
|
7166
|
-
|
|
7129
|
+
autonomousSystemNumber?: string;
|
|
7167
7130
|
/**
|
|
7168
|
-
*
|
|
7131
|
+
* Organization owning the ASN when broken down by `autonomousSystemOrganization`.
|
|
7169
7132
|
*/
|
|
7170
|
-
|
|
7133
|
+
autonomousSystemOrganization?: string;
|
|
7171
7134
|
/**
|
|
7172
|
-
*
|
|
7135
|
+
* Connection type when broken down by `connectionType`.
|
|
7173
7136
|
*/
|
|
7174
|
-
|
|
7137
|
+
connectionType?: string;
|
|
7175
7138
|
/**
|
|
7176
|
-
*
|
|
7139
|
+
* Connection usage type when broken down by `connectionUsageType`.
|
|
7177
7140
|
*/
|
|
7178
|
-
|
|
7141
|
+
connectionUsageType?: string;
|
|
7179
7142
|
/**
|
|
7180
|
-
*
|
|
7143
|
+
* Registered organization of the IP when broken down by `connectionOrganization`.
|
|
7181
7144
|
*/
|
|
7182
|
-
|
|
7145
|
+
connectionOrganization?: string;
|
|
7183
7146
|
/**
|
|
7184
|
-
*
|
|
7147
|
+
* Owning team ID when broken down by `teamId`.
|
|
7185
7148
|
*/
|
|
7186
|
-
|
|
7149
|
+
teamId?: string;
|
|
7150
|
+
};
|
|
7151
|
+
/**
|
|
7152
|
+
* usageMetric
|
|
7153
|
+
*/
|
|
7154
|
+
export type UsageMetric = {
|
|
7187
7155
|
/**
|
|
7188
|
-
*
|
|
7156
|
+
* Metric key this series describes.
|
|
7189
7157
|
*/
|
|
7190
|
-
|
|
7158
|
+
metric: string;
|
|
7191
7159
|
/**
|
|
7192
|
-
*
|
|
7160
|
+
* Data points in the requested order.
|
|
7193
7161
|
*/
|
|
7194
|
-
|
|
7162
|
+
points: UsageDataPoint[];
|
|
7163
|
+
};
|
|
7164
|
+
/**
|
|
7165
|
+
* usageEventList
|
|
7166
|
+
*/
|
|
7167
|
+
export type UsageEventList = {
|
|
7195
7168
|
/**
|
|
7196
|
-
*
|
|
7169
|
+
* Requested interval, or an empty string for a flat aggregate.
|
|
7197
7170
|
*/
|
|
7198
|
-
|
|
7171
|
+
interval: string;
|
|
7199
7172
|
/**
|
|
7200
|
-
*
|
|
7173
|
+
* One series per requested event metric.
|
|
7201
7174
|
*/
|
|
7202
|
-
|
|
7175
|
+
metrics: UsageMetric[];
|
|
7176
|
+
};
|
|
7177
|
+
/**
|
|
7178
|
+
* usageGaugeList
|
|
7179
|
+
*/
|
|
7180
|
+
export type UsageGaugeList = {
|
|
7203
7181
|
/**
|
|
7204
|
-
*
|
|
7182
|
+
* Requested interval, or an empty string for a flat aggregate.
|
|
7205
7183
|
*/
|
|
7206
|
-
|
|
7184
|
+
interval: string;
|
|
7207
7185
|
/**
|
|
7208
|
-
*
|
|
7186
|
+
* One series per requested gauge metric.
|
|
7209
7187
|
*/
|
|
7210
|
-
|
|
7188
|
+
metrics: UsageMetric[];
|
|
7211
7189
|
};
|
|
7212
7190
|
/**
|
|
7213
7191
|
* Headers
|
|
@@ -7463,6 +7441,14 @@ export declare namespace Models {
|
|
|
7463
7441
|
* List of configured VCS providers.
|
|
7464
7442
|
*/
|
|
7465
7443
|
_APP_VCS_PROVIDERS: string[];
|
|
7444
|
+
/**
|
|
7445
|
+
* List of configured VCS providers that support repository creation.
|
|
7446
|
+
*/
|
|
7447
|
+
_APP_VCS_PROVIDERS_WITH_REPOSITORY_CREATION: string[];
|
|
7448
|
+
/**
|
|
7449
|
+
* List of configured VCS providers that can host public repositories.
|
|
7450
|
+
*/
|
|
7451
|
+
_APP_VCS_PROVIDERS_WITH_PUBLIC_REPOSITORIES: string[];
|
|
7466
7452
|
/**
|
|
7467
7453
|
* Defines if main domain is configured. If so, custom domains can be created.
|
|
7468
7454
|
*/
|
|
@@ -7638,6 +7624,31 @@ export declare namespace Models {
|
|
|
7638
7624
|
*/
|
|
7639
7625
|
expire: string;
|
|
7640
7626
|
};
|
|
7627
|
+
/**
|
|
7628
|
+
* MFA Challenge Secret
|
|
7629
|
+
*/
|
|
7630
|
+
export type MfaChallengeSecret = {
|
|
7631
|
+
/**
|
|
7632
|
+
* Token ID.
|
|
7633
|
+
*/
|
|
7634
|
+
$id: string;
|
|
7635
|
+
/**
|
|
7636
|
+
* Token creation date in ISO 8601 format.
|
|
7637
|
+
*/
|
|
7638
|
+
$createdAt: string;
|
|
7639
|
+
/**
|
|
7640
|
+
* User ID.
|
|
7641
|
+
*/
|
|
7642
|
+
userId: string;
|
|
7643
|
+
/**
|
|
7644
|
+
* Token expiration date in ISO 8601 format.
|
|
7645
|
+
*/
|
|
7646
|
+
expire: string;
|
|
7647
|
+
/**
|
|
7648
|
+
* Challenge code to be delivered to the end user through a custom channel.
|
|
7649
|
+
*/
|
|
7650
|
+
code: string;
|
|
7651
|
+
};
|
|
7641
7652
|
/**
|
|
7642
7653
|
* MFA Recovery Codes
|
|
7643
7654
|
*/
|
|
@@ -7680,6 +7691,10 @@ export declare namespace Models {
|
|
|
7680
7691
|
* Can recovery code be used for MFA challenge for this account.
|
|
7681
7692
|
*/
|
|
7682
7693
|
recoveryCode: boolean;
|
|
7694
|
+
/**
|
|
7695
|
+
* Can custom factor be used for MFA challenge for this account.
|
|
7696
|
+
*/
|
|
7697
|
+
custom: boolean;
|
|
7683
7698
|
};
|
|
7684
7699
|
/**
|
|
7685
7700
|
* Provider
|
|
@@ -7815,6 +7830,14 @@ export declare namespace Models {
|
|
|
7815
7830
|
* Subscribe permissions.
|
|
7816
7831
|
*/
|
|
7817
7832
|
subscribe: string[];
|
|
7833
|
+
/**
|
|
7834
|
+
* MQTT QoS for delivery on this topic. Null lets the subscriber choose their level.
|
|
7835
|
+
*/
|
|
7836
|
+
qos?: number;
|
|
7837
|
+
/**
|
|
7838
|
+
* Message retention in seconds for offline delivery.
|
|
7839
|
+
*/
|
|
7840
|
+
expiry?: number;
|
|
7818
7841
|
};
|
|
7819
7842
|
/**
|
|
7820
7843
|
* Transaction
|
|
@@ -8006,7 +8029,7 @@ export declare namespace Models {
|
|
|
8006
8029
|
/**
|
|
8007
8030
|
* An array of objects containing the report data of the resources that were migrated.
|
|
8008
8031
|
*/
|
|
8009
|
-
resourceData:
|
|
8032
|
+
resourceData: Record<string, any>[];
|
|
8010
8033
|
/**
|
|
8011
8034
|
* All errors that occurred during the migration process.
|
|
8012
8035
|
*/
|
|
@@ -8747,6 +8770,14 @@ export declare namespace Models {
|
|
|
8747
8770
|
* Total databases storage usage
|
|
8748
8771
|
*/
|
|
8749
8772
|
usageDatabasesStorage: number;
|
|
8773
|
+
/**
|
|
8774
|
+
* Total functions storage usage, deployments and builds together. Supersedes usageDeploymentsStorage and usageBuildsStorage.
|
|
8775
|
+
*/
|
|
8776
|
+
usageFunctionsStorage: number;
|
|
8777
|
+
/**
|
|
8778
|
+
* Total sites storage usage, deployments and builds together. Supersedes usageDeploymentsStorage and usageBuildsStorage.
|
|
8779
|
+
*/
|
|
8780
|
+
usageSitesStorage: number;
|
|
8750
8781
|
/**
|
|
8751
8782
|
* Total active users for the billing period
|
|
8752
8783
|
*/
|
|
@@ -9206,6 +9237,10 @@ export declare namespace Models {
|
|
|
9206
9237
|
* Usage log time intervals allowed for this plan (e.g. 15m, 1h, 1d).
|
|
9207
9238
|
*/
|
|
9208
9239
|
usageLogsIntervals?: string[];
|
|
9240
|
+
/**
|
|
9241
|
+
* 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.
|
|
9242
|
+
*/
|
|
9243
|
+
usageAggregateOnlyMetrics?: string[];
|
|
9209
9244
|
/**
|
|
9210
9245
|
* Number of days of console inactivity before a project is paused. 0 means pausing is disabled.
|
|
9211
9246
|
*/
|
|
@@ -9242,6 +9277,10 @@ export declare namespace Models {
|
|
|
9242
9277
|
* Does plan require billing address
|
|
9243
9278
|
*/
|
|
9244
9279
|
requiresBillingAddress: boolean;
|
|
9280
|
+
/**
|
|
9281
|
+
* ISO country codes eligible for this regional plan. Empty means no restriction.
|
|
9282
|
+
*/
|
|
9283
|
+
eligibleCountries?: string[];
|
|
9245
9284
|
/**
|
|
9246
9285
|
* Is the billing plan available
|
|
9247
9286
|
*/
|
|
@@ -9270,6 +9309,10 @@ export declare namespace Models {
|
|
|
9270
9309
|
* Does plan support credit
|
|
9271
9310
|
*/
|
|
9272
9311
|
supportsCredits: boolean;
|
|
9312
|
+
/**
|
|
9313
|
+
* Does plan support dedicated databases.
|
|
9314
|
+
*/
|
|
9315
|
+
supportsDedicatedDatabases: boolean;
|
|
9273
9316
|
/**
|
|
9274
9317
|
* Does plan support blocking disposable email addresses.
|
|
9275
9318
|
*/
|
|
@@ -9330,6 +9373,10 @@ export declare namespace Models {
|
|
|
9330
9373
|
* Details of the program this plan is a part of.
|
|
9331
9374
|
*/
|
|
9332
9375
|
program?: Program;
|
|
9376
|
+
/**
|
|
9377
|
+
* Included monthly dedicated-database compute credit in USD. Resets each billing cycle with no roll-over.
|
|
9378
|
+
*/
|
|
9379
|
+
databaseComputeCredit: number;
|
|
9333
9380
|
/**
|
|
9334
9381
|
* Dedicated database limits available to this plan.
|
|
9335
9382
|
*/
|
|
@@ -9516,47 +9563,10 @@ export declare namespace Models {
|
|
|
9516
9563
|
* Block mode. full blocks reads and writes; readOnly blocks writes only.
|
|
9517
9564
|
*/
|
|
9518
9565
|
mode: string;
|
|
9519
|
-
/**
|
|
9520
|
-
* Reason for the block. Can be null if no reason was provided.
|
|
9521
|
-
*/
|
|
9522
|
-
reason?: string;
|
|
9523
9566
|
/**
|
|
9524
9567
|
* Block expiration date in ISO 8601 format. Can be null if the block does not expire.
|
|
9525
9568
|
*/
|
|
9526
9569
|
expiredAt?: string;
|
|
9527
|
-
/**
|
|
9528
|
-
* Name of the project this block applies to.
|
|
9529
|
-
*/
|
|
9530
|
-
projectName: string;
|
|
9531
|
-
/**
|
|
9532
|
-
* Region of the project this block applies to.
|
|
9533
|
-
*/
|
|
9534
|
-
region: string;
|
|
9535
|
-
/**
|
|
9536
|
-
* Name of the organization that owns the project.
|
|
9537
|
-
*/
|
|
9538
|
-
organizationName: string;
|
|
9539
|
-
/**
|
|
9540
|
-
* ID of the organization that owns the project.
|
|
9541
|
-
*/
|
|
9542
|
-
organizationId: string;
|
|
9543
|
-
/**
|
|
9544
|
-
* Billing plan of the organization that owns the project.
|
|
9545
|
-
*/
|
|
9546
|
-
billingPlan: string;
|
|
9547
|
-
};
|
|
9548
|
-
/**
|
|
9549
|
-
* BlockDelete
|
|
9550
|
-
*/
|
|
9551
|
-
export type BlockDelete = {
|
|
9552
|
-
/**
|
|
9553
|
-
* Number of blocks deleted
|
|
9554
|
-
*/
|
|
9555
|
-
deleted: number;
|
|
9556
|
-
/**
|
|
9557
|
-
* List of deleted blocks
|
|
9558
|
-
*/
|
|
9559
|
-
blocks: Block[];
|
|
9560
9570
|
};
|
|
9561
9571
|
/**
|
|
9562
9572
|
* Branch
|
|
@@ -9587,7 +9597,7 @@ export declare namespace Models {
|
|
|
9587
9597
|
*/
|
|
9588
9598
|
port: number;
|
|
9589
9599
|
/**
|
|
9590
|
-
*
|
|
9600
|
+
* Advertised catalog the client connects to. MySQL/MariaDB use default; Postgres uses the routing label.
|
|
9591
9601
|
*/
|
|
9592
9602
|
database: string;
|
|
9593
9603
|
/**
|
|
@@ -9615,6 +9625,10 @@ export declare namespace Models {
|
|
|
9615
9625
|
* BranchList
|
|
9616
9626
|
*/
|
|
9617
9627
|
export type DedicatedDatabaseBranchList = {
|
|
9628
|
+
/**
|
|
9629
|
+
* Total number of branches.
|
|
9630
|
+
*/
|
|
9631
|
+
total: number;
|
|
9618
9632
|
/**
|
|
9619
9633
|
* List of branches.
|
|
9620
9634
|
*/
|
|
@@ -9829,6 +9843,10 @@ export declare namespace Models {
|
|
|
9829
9843
|
* Number of documents still pending replication to the target.
|
|
9830
9844
|
*/
|
|
9831
9845
|
lagDocuments: number;
|
|
9846
|
+
/**
|
|
9847
|
+
* Highest source changelog sequence applied to the target so far.
|
|
9848
|
+
*/
|
|
9849
|
+
changelogWatermark: number;
|
|
9832
9850
|
/**
|
|
9833
9851
|
* Time the migrated data was verified against the source in ISO 8601 format.
|
|
9834
9852
|
*/
|
|
@@ -9842,9 +9860,13 @@ export declare namespace Models {
|
|
|
9842
9860
|
*/
|
|
9843
9861
|
soakUntil: string;
|
|
9844
9862
|
/**
|
|
9845
|
-
* Whether the migration cuts over automatically once ready.
|
|
9863
|
+
* 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.
|
|
9846
9864
|
*/
|
|
9847
9865
|
autoCutover: boolean;
|
|
9866
|
+
/**
|
|
9867
|
+
* 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.
|
|
9868
|
+
*/
|
|
9869
|
+
cutoverRequested: boolean;
|
|
9848
9870
|
/**
|
|
9849
9871
|
* Whether the migration is paused.
|
|
9850
9872
|
*/
|
|
@@ -9891,7 +9913,7 @@ export declare namespace Models {
|
|
|
9891
9913
|
*/
|
|
9892
9914
|
specification: string;
|
|
9893
9915
|
/**
|
|
9894
|
-
* Database backend provider. Possible values:
|
|
9916
|
+
* Database backend provider. Possible values: edge.
|
|
9895
9917
|
*/
|
|
9896
9918
|
backend: string;
|
|
9897
9919
|
/**
|
|
@@ -9910,6 +9932,10 @@ export declare namespace Models {
|
|
|
9910
9932
|
* Database password for connections.
|
|
9911
9933
|
*/
|
|
9912
9934
|
connectionPassword: string;
|
|
9935
|
+
/**
|
|
9936
|
+
* Committed generation of the primary connection credentials. Null until the rotation contract has been initialized.
|
|
9937
|
+
*/
|
|
9938
|
+
credentialGeneration: number;
|
|
9913
9939
|
/**
|
|
9914
9940
|
* Full database connection string (URI format).
|
|
9915
9941
|
*/
|
|
@@ -9923,7 +9949,7 @@ export declare namespace Models {
|
|
|
9923
9949
|
*/
|
|
9924
9950
|
status: string;
|
|
9925
9951
|
/**
|
|
9926
|
-
* Container status for lifecycle-managed database runtimes: active or
|
|
9952
|
+
* Container status for lifecycle-managed database runtimes: active, inactive, or failed (a wake was declined because the backing namespace is gone).
|
|
9927
9953
|
*/
|
|
9928
9954
|
containerStatus: string;
|
|
9929
9955
|
/**
|
|
@@ -9954,6 +9980,18 @@ export declare namespace Models {
|
|
|
9954
9980
|
* Storage allocated in GB.
|
|
9955
9981
|
*/
|
|
9956
9982
|
storage: number;
|
|
9983
|
+
/**
|
|
9984
|
+
* Storage resize status. Possible values: idle (no resize in flight), resizing (the volume is growing towards storageTargetGb).
|
|
9985
|
+
*/
|
|
9986
|
+
storageStatus: string;
|
|
9987
|
+
/**
|
|
9988
|
+
* Size in GB the volume is growing towards while storageStatus is resizing. 0 when no resize is in flight.
|
|
9989
|
+
*/
|
|
9990
|
+
storageTargetGb: number;
|
|
9991
|
+
/**
|
|
9992
|
+
* Time the in-flight storage resize started, in ISO 8601 format.
|
|
9993
|
+
*/
|
|
9994
|
+
storageResizeStartedAt?: string;
|
|
9957
9995
|
/**
|
|
9958
9996
|
* Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.
|
|
9959
9997
|
*/
|
|
@@ -9974,10 +10012,6 @@ export declare namespace Models {
|
|
|
9974
10012
|
* Replication sync mode: async, sync, or quorum.
|
|
9975
10013
|
*/
|
|
9976
10014
|
syncMode: string;
|
|
9977
|
-
/**
|
|
9978
|
-
* Number of cross-region replicas. Cross-region availability is enabled when greater than 0.
|
|
9979
|
-
*/
|
|
9980
|
-
crossRegionReplicas: number;
|
|
9981
10015
|
/**
|
|
9982
10016
|
* 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.
|
|
9983
10017
|
*/
|
|
@@ -10011,7 +10045,7 @@ export declare namespace Models {
|
|
|
10011
10045
|
*/
|
|
10012
10046
|
storageAutoscalingThresholdPercent: number;
|
|
10013
10047
|
/**
|
|
10014
|
-
* Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
10048
|
+
* Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.
|
|
10015
10049
|
*/
|
|
10016
10050
|
storageAutoscalingMaxGb: number;
|
|
10017
10051
|
/**
|
|
@@ -10058,7 +10092,7 @@ export declare namespace Models {
|
|
|
10058
10092
|
/**
|
|
10059
10093
|
* Result rows as a list of column-name => value maps. Empty for non-returning statements.
|
|
10060
10094
|
*/
|
|
10061
|
-
rows:
|
|
10095
|
+
rows: Record<string, any>[];
|
|
10062
10096
|
/**
|
|
10063
10097
|
* Number of rows returned (for SELECT) or affected (for INSERT/UPDATE/DELETE).
|
|
10064
10098
|
*/
|
|
@@ -10106,9 +10140,13 @@ export declare namespace Models {
|
|
|
10106
10140
|
*/
|
|
10107
10141
|
$createdAt: string;
|
|
10108
10142
|
/**
|
|
10109
|
-
* Database ID being restored.
|
|
10143
|
+
* Database ID being restored into.
|
|
10110
10144
|
*/
|
|
10111
10145
|
databaseId: string;
|
|
10146
|
+
/**
|
|
10147
|
+
* Source database ID when restoring a backup into another database.
|
|
10148
|
+
*/
|
|
10149
|
+
sourceDatabaseId: string;
|
|
10112
10150
|
/**
|
|
10113
10151
|
* Project ID.
|
|
10114
10152
|
*/
|
|
@@ -10147,7 +10185,7 @@ export declare namespace Models {
|
|
|
10147
10185
|
*/
|
|
10148
10186
|
export type DatabaseStatus = {
|
|
10149
10187
|
/**
|
|
10150
|
-
* Overall health status: healthy, degraded, or
|
|
10188
|
+
* Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured.
|
|
10151
10189
|
*/
|
|
10152
10190
|
health: string;
|
|
10153
10191
|
/**
|
|
@@ -10191,9 +10229,9 @@ export declare namespace Models {
|
|
|
10191
10229
|
*/
|
|
10192
10230
|
syncStandbyCount: number;
|
|
10193
10231
|
/**
|
|
10194
|
-
* Whether the
|
|
10232
|
+
* 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.
|
|
10195
10233
|
*/
|
|
10196
|
-
syncStateConfirmed
|
|
10234
|
+
syncStateConfirmed?: boolean;
|
|
10197
10235
|
/**
|
|
10198
10236
|
* 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.
|
|
10199
10237
|
*/
|
|
@@ -10330,9 +10368,9 @@ export declare namespace Models {
|
|
|
10330
10368
|
*/
|
|
10331
10369
|
available: boolean;
|
|
10332
10370
|
/**
|
|
10333
|
-
* Domain registration price.
|
|
10371
|
+
* Domain registration price. Null when the price could not be resolved, for example for an unsupported TLD.
|
|
10334
10372
|
*/
|
|
10335
|
-
price
|
|
10373
|
+
price?: number;
|
|
10336
10374
|
/**
|
|
10337
10375
|
* Price period in years.
|
|
10338
10376
|
*/
|
|
@@ -10341,6 +10379,14 @@ export declare namespace Models {
|
|
|
10341
10379
|
* Whether the domain is a premium domain.
|
|
10342
10380
|
*/
|
|
10343
10381
|
premium: boolean;
|
|
10382
|
+
/**
|
|
10383
|
+
* Domain renewal price for the same period. Null when the domain was not priced or the registrar has no renewal price for it.
|
|
10384
|
+
*/
|
|
10385
|
+
renewalPrice?: number;
|
|
10386
|
+
/**
|
|
10387
|
+
* Renewal price period in years.
|
|
10388
|
+
*/
|
|
10389
|
+
renewalPeriodYears: number;
|
|
10344
10390
|
};
|
|
10345
10391
|
/**
|
|
10346
10392
|
* DomainPurchase
|
|
@@ -10638,7 +10684,11 @@ export declare namespace Models {
|
|
|
10638
10684
|
*/
|
|
10639
10685
|
status: string;
|
|
10640
10686
|
/**
|
|
10641
|
-
*
|
|
10687
|
+
* 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.
|
|
10688
|
+
*/
|
|
10689
|
+
replicating?: boolean;
|
|
10690
|
+
/**
|
|
10691
|
+
* 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.
|
|
10642
10692
|
*/
|
|
10643
10693
|
lagSeconds?: number;
|
|
10644
10694
|
};
|
|
@@ -10659,11 +10709,11 @@ export declare namespace Models {
|
|
|
10659
10709
|
*/
|
|
10660
10710
|
databaseId: string;
|
|
10661
10711
|
/**
|
|
10662
|
-
* Operation type, such as provision, update, restore, pausing, resuming, failover, backup-create or cross-region-enable.
|
|
10712
|
+
* Operation type, such as provision, update, credentials-update, restore, pausing, resuming, failover, backup-create or cross-region-enable.
|
|
10663
10713
|
*/
|
|
10664
10714
|
type: string;
|
|
10665
10715
|
/**
|
|
10666
|
-
* Operation status. Possible values: running (in progress), completed (finished successfully), failed (ended in an error).
|
|
10716
|
+
* Operation status. Possible values: queued (accepted and waiting to resume), running (in progress), completed (finished successfully), failed (ended in an error).
|
|
10667
10717
|
*/
|
|
10668
10718
|
status: string;
|
|
10669
10719
|
/**
|
|
@@ -10683,7 +10733,7 @@ export declare namespace Models {
|
|
|
10683
10733
|
*/
|
|
10684
10734
|
completedAt?: string;
|
|
10685
10735
|
/**
|
|
10686
|
-
* Machine-readable failure code. `
|
|
10736
|
+
* Machine-readable failure code. `Interrupted` marks an attempt that ended before its outcome could be confirmed.
|
|
10687
10737
|
*/
|
|
10688
10738
|
errorCode: string;
|
|
10689
10739
|
/**
|
|
@@ -10733,9 +10783,9 @@ export declare namespace Models {
|
|
|
10733
10783
|
*/
|
|
10734
10784
|
syncStandbyCount: number;
|
|
10735
10785
|
/**
|
|
10736
|
-
* Whether the
|
|
10786
|
+
* 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.
|
|
10737
10787
|
*/
|
|
10738
|
-
syncStateConfirmed
|
|
10788
|
+
syncStateConfirmed?: boolean;
|
|
10739
10789
|
/**
|
|
10740
10790
|
* Per-pod statuses for the primary and every replica.
|
|
10741
10791
|
*/
|
|
@@ -10859,6 +10909,68 @@ export declare namespace Models {
|
|
|
10859
10909
|
*/
|
|
10860
10910
|
to: string;
|
|
10861
10911
|
};
|
|
10912
|
+
/**
|
|
10913
|
+
* ManagerBlock
|
|
10914
|
+
*/
|
|
10915
|
+
export type ManagerBlock = {
|
|
10916
|
+
/**
|
|
10917
|
+
* Block creation date in ISO 8601 format.
|
|
10918
|
+
*/
|
|
10919
|
+
$createdAt: string;
|
|
10920
|
+
/**
|
|
10921
|
+
* Resource type that is blocked
|
|
10922
|
+
*/
|
|
10923
|
+
resourceType: string;
|
|
10924
|
+
/**
|
|
10925
|
+
* Resource identifier that is blocked
|
|
10926
|
+
*/
|
|
10927
|
+
resourceId: string;
|
|
10928
|
+
/**
|
|
10929
|
+
* Block mode. full blocks reads and writes; readOnly blocks writes only.
|
|
10930
|
+
*/
|
|
10931
|
+
mode: string;
|
|
10932
|
+
/**
|
|
10933
|
+
* Block expiration date in ISO 8601 format. Can be null if the block does not expire.
|
|
10934
|
+
*/
|
|
10935
|
+
expiredAt?: string;
|
|
10936
|
+
/**
|
|
10937
|
+
* Reason for the block. Can be null if no reason was provided.
|
|
10938
|
+
*/
|
|
10939
|
+
reason?: string;
|
|
10940
|
+
/**
|
|
10941
|
+
* Name of the project this block applies to.
|
|
10942
|
+
*/
|
|
10943
|
+
projectName: string;
|
|
10944
|
+
/**
|
|
10945
|
+
* Region of the project this block applies to.
|
|
10946
|
+
*/
|
|
10947
|
+
region: string;
|
|
10948
|
+
/**
|
|
10949
|
+
* Name of the organization that owns the project.
|
|
10950
|
+
*/
|
|
10951
|
+
organizationName: string;
|
|
10952
|
+
/**
|
|
10953
|
+
* ID of the organization that owns the project.
|
|
10954
|
+
*/
|
|
10955
|
+
organizationId: string;
|
|
10956
|
+
/**
|
|
10957
|
+
* Billing plan of the organization that owns the project.
|
|
10958
|
+
*/
|
|
10959
|
+
billingPlan: string;
|
|
10960
|
+
};
|
|
10961
|
+
/**
|
|
10962
|
+
* ManagerBlockDelete
|
|
10963
|
+
*/
|
|
10964
|
+
export type ManagerBlockDelete = {
|
|
10965
|
+
/**
|
|
10966
|
+
* Number of blocks deleted
|
|
10967
|
+
*/
|
|
10968
|
+
deleted: number;
|
|
10969
|
+
/**
|
|
10970
|
+
* List of deleted blocks
|
|
10971
|
+
*/
|
|
10972
|
+
blocks: ManagerBlock[];
|
|
10973
|
+
};
|
|
10862
10974
|
/**
|
|
10863
10975
|
* Organization
|
|
10864
10976
|
*/
|
|
@@ -11166,36 +11278,44 @@ export declare namespace Models {
|
|
|
11166
11278
|
/**
|
|
11167
11279
|
* Line items breakdown
|
|
11168
11280
|
*/
|
|
11169
|
-
items:
|
|
11281
|
+
items: Record<string, any>[];
|
|
11170
11282
|
/**
|
|
11171
11283
|
* Applied discounts breakdown
|
|
11172
11284
|
*/
|
|
11173
|
-
discounts:
|
|
11285
|
+
discounts: Record<string, any>[];
|
|
11174
11286
|
};
|
|
11175
11287
|
/**
|
|
11176
11288
|
* PlanChangeLimits
|
|
11177
11289
|
*/
|
|
11178
11290
|
export type PlanChangeLimits = {
|
|
11179
11291
|
/**
|
|
11180
|
-
*
|
|
11292
|
+
* Whether the plan change is allowed
|
|
11293
|
+
*/
|
|
11294
|
+
canChangePlan: boolean;
|
|
11295
|
+
/**
|
|
11296
|
+
* Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.
|
|
11297
|
+
*/
|
|
11298
|
+
unsupportedAddons: string[];
|
|
11299
|
+
/**
|
|
11300
|
+
* Project count against the target plan limit
|
|
11181
11301
|
*/
|
|
11182
|
-
|
|
11302
|
+
projects: PlanChangeResourceCompliance;
|
|
11183
11303
|
/**
|
|
11184
|
-
*
|
|
11304
|
+
* Organization member count against the target plan limit
|
|
11185
11305
|
*/
|
|
11186
|
-
|
|
11306
|
+
members: PlanChangeResourceCompliance;
|
|
11187
11307
|
/**
|
|
11188
|
-
*
|
|
11308
|
+
* Custom domain count against the target plan limit
|
|
11189
11309
|
*/
|
|
11190
|
-
|
|
11310
|
+
domains: PlanChangeResourceCompliance;
|
|
11191
11311
|
/**
|
|
11192
|
-
*
|
|
11312
|
+
* Number of projects exceeding target plan limits
|
|
11193
11313
|
*/
|
|
11194
|
-
|
|
11314
|
+
nonCompliantProjects: number;
|
|
11195
11315
|
/**
|
|
11196
|
-
*
|
|
11316
|
+
* Per-project compliance details. Populated for downgrades only.
|
|
11197
11317
|
*/
|
|
11198
|
-
|
|
11318
|
+
projectCompliance: PlanChangeProjectCompliance[];
|
|
11199
11319
|
};
|
|
11200
11320
|
/**
|
|
11201
11321
|
* PlanChangeProjectCompliance
|
|
@@ -11239,7 +11359,7 @@ export declare namespace Models {
|
|
|
11239
11359
|
*/
|
|
11240
11360
|
limit: number;
|
|
11241
11361
|
/**
|
|
11242
|
-
* Compliance status
|
|
11362
|
+
* Compliance status. Either `over_limit` or `within_limit`.
|
|
11243
11363
|
*/
|
|
11244
11364
|
status: string;
|
|
11245
11365
|
/**
|
|
@@ -11247,7 +11367,7 @@ export declare namespace Models {
|
|
|
11247
11367
|
*/
|
|
11248
11368
|
excess: number;
|
|
11249
11369
|
/**
|
|
11250
|
-
* Suggestion for resolving the compliance issue
|
|
11370
|
+
* Suggestion for resolving the compliance issue. Empty when the resource is within limits.
|
|
11251
11371
|
*/
|
|
11252
11372
|
resolutionHint: string;
|
|
11253
11373
|
};
|
|
@@ -11304,58 +11424,6 @@ export declare namespace Models {
|
|
|
11304
11424
|
*/
|
|
11305
11425
|
enabled: boolean;
|
|
11306
11426
|
};
|
|
11307
|
-
/**
|
|
11308
|
-
* Policy Deny Aliased Email
|
|
11309
|
-
*/
|
|
11310
|
-
export type PolicyDenyAliasedEmail = {
|
|
11311
|
-
/**
|
|
11312
|
-
* Policy ID.
|
|
11313
|
-
*/
|
|
11314
|
-
$id: string;
|
|
11315
|
-
/**
|
|
11316
|
-
* Whether the deny aliased email policy is enabled.
|
|
11317
|
-
*/
|
|
11318
|
-
enabled: boolean;
|
|
11319
|
-
};
|
|
11320
|
-
/**
|
|
11321
|
-
* Policy Deny Disposable Email
|
|
11322
|
-
*/
|
|
11323
|
-
export type PolicyDenyDisposableEmail = {
|
|
11324
|
-
/**
|
|
11325
|
-
* Policy ID.
|
|
11326
|
-
*/
|
|
11327
|
-
$id: string;
|
|
11328
|
-
/**
|
|
11329
|
-
* Whether the deny disposable email policy is enabled.
|
|
11330
|
-
*/
|
|
11331
|
-
enabled: boolean;
|
|
11332
|
-
};
|
|
11333
|
-
/**
|
|
11334
|
-
* Policy Deny Free Email
|
|
11335
|
-
*/
|
|
11336
|
-
export type PolicyDenyFreeEmail = {
|
|
11337
|
-
/**
|
|
11338
|
-
* Policy ID.
|
|
11339
|
-
*/
|
|
11340
|
-
$id: string;
|
|
11341
|
-
/**
|
|
11342
|
-
* Whether the deny free email policy is enabled.
|
|
11343
|
-
*/
|
|
11344
|
-
enabled: boolean;
|
|
11345
|
-
};
|
|
11346
|
-
/**
|
|
11347
|
-
* Policy Deny Corporate Email
|
|
11348
|
-
*/
|
|
11349
|
-
export type PolicyDenyCorporateEmail = {
|
|
11350
|
-
/**
|
|
11351
|
-
* Policy ID.
|
|
11352
|
-
*/
|
|
11353
|
-
$id: string;
|
|
11354
|
-
/**
|
|
11355
|
-
* Whether the deny non-corporate email policy is enabled.
|
|
11356
|
-
*/
|
|
11357
|
-
enabled: boolean;
|
|
11358
|
-
};
|
|
11359
11427
|
/**
|
|
11360
11428
|
* PoolerConfig
|
|
11361
11429
|
*/
|
|
@@ -11604,6 +11672,22 @@ export declare namespace Models {
|
|
|
11604
11672
|
* Monthly price of the specification in USD.
|
|
11605
11673
|
*/
|
|
11606
11674
|
price: number;
|
|
11675
|
+
/**
|
|
11676
|
+
* Price per GB of storage above the included amount, per month, in USD.
|
|
11677
|
+
*/
|
|
11678
|
+
storageOverageRate: number;
|
|
11679
|
+
/**
|
|
11680
|
+
* Price per GB of bandwidth above the included amount, per month, in USD.
|
|
11681
|
+
*/
|
|
11682
|
+
bandwidthOverageRate: number;
|
|
11683
|
+
/**
|
|
11684
|
+
* High availability replica price as a fraction of the specification price.
|
|
11685
|
+
*/
|
|
11686
|
+
replicaRate: number;
|
|
11687
|
+
/**
|
|
11688
|
+
* Point-in-time recovery price as a fraction of the specification price.
|
|
11689
|
+
*/
|
|
11690
|
+
pitrRate: number;
|
|
11607
11691
|
/**
|
|
11608
11692
|
* Allocated CPU in millicores.
|
|
11609
11693
|
*/
|
|
@@ -11641,35 +11725,6 @@ export declare namespace Models {
|
|
|
11641
11725
|
* Total number of specifications.
|
|
11642
11726
|
*/
|
|
11643
11727
|
total: number;
|
|
11644
|
-
/**
|
|
11645
|
-
* Overage and add-on pricing shared across all specifications.
|
|
11646
|
-
*/
|
|
11647
|
-
pricing: DedicatedDatabaseSpecificationPricing;
|
|
11648
|
-
};
|
|
11649
|
-
/**
|
|
11650
|
-
* SpecificationPricing
|
|
11651
|
-
*/
|
|
11652
|
-
export type DedicatedDatabaseSpecificationPricing = {
|
|
11653
|
-
/**
|
|
11654
|
-
* Price per GB of storage above the included amount, per month, in USD.
|
|
11655
|
-
*/
|
|
11656
|
-
storageOverageRate: number;
|
|
11657
|
-
/**
|
|
11658
|
-
* Price per GB of bandwidth above the included amount, per month, in USD.
|
|
11659
|
-
*/
|
|
11660
|
-
bandwidthOverageRate: number;
|
|
11661
|
-
/**
|
|
11662
|
-
* High availability replica price as a fraction of the specification cost.
|
|
11663
|
-
*/
|
|
11664
|
-
replicaRate: number;
|
|
11665
|
-
/**
|
|
11666
|
-
* Cross-region replica price as a fraction of the specification cost.
|
|
11667
|
-
*/
|
|
11668
|
-
crossRegionReplicaRate: number;
|
|
11669
|
-
/**
|
|
11670
|
-
* Point-in-time recovery price as a fraction of the specification cost.
|
|
11671
|
-
*/
|
|
11672
|
-
pitrRate: number;
|
|
11673
11728
|
};
|
|
11674
11729
|
/**
|
|
11675
11730
|
* Connections
|
|
@@ -11701,7 +11756,11 @@ export declare namespace Models {
|
|
|
11701
11756
|
*/
|
|
11702
11757
|
healthy: boolean;
|
|
11703
11758
|
/**
|
|
11704
|
-
*
|
|
11759
|
+
* 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.
|
|
11760
|
+
*/
|
|
11761
|
+
replicating?: boolean;
|
|
11762
|
+
/**
|
|
11763
|
+
* 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.
|
|
11705
11764
|
*/
|
|
11706
11765
|
lagSeconds?: number;
|
|
11707
11766
|
};
|
|
@@ -11775,166 +11834,6 @@ export declare namespace Models {
|
|
|
11775
11834
|
*/
|
|
11776
11835
|
credits?: AdditionalResource;
|
|
11777
11836
|
};
|
|
11778
|
-
/**
|
|
11779
|
-
* usageDataPoint
|
|
11780
|
-
*/
|
|
11781
|
-
export type UsageDataPoint = {
|
|
11782
|
-
/**
|
|
11783
|
-
* Bucket start timestamp (ISO 8601). When `interval` is omitted this is the request end time, marking the aggregate as-of moment.
|
|
11784
|
-
*/
|
|
11785
|
-
time: string;
|
|
11786
|
-
/**
|
|
11787
|
-
* Aggregated value for the bucket. Counters are whole numbers; gauge rates (e.g. queries per second) may be fractional.
|
|
11788
|
-
*/
|
|
11789
|
-
value: number;
|
|
11790
|
-
/**
|
|
11791
|
-
* API endpoint path when broken down by `path`.
|
|
11792
|
-
*/
|
|
11793
|
-
path?: string;
|
|
11794
|
-
/**
|
|
11795
|
-
* HTTP method when broken down by `method`.
|
|
11796
|
-
*/
|
|
11797
|
-
method?: string;
|
|
11798
|
-
/**
|
|
11799
|
-
* HTTP status code when broken down by `status`.
|
|
11800
|
-
*/
|
|
11801
|
-
status?: string;
|
|
11802
|
-
/**
|
|
11803
|
-
* API service segment when broken down by `service`.
|
|
11804
|
-
*/
|
|
11805
|
-
service?: string;
|
|
11806
|
-
/**
|
|
11807
|
-
* Country code when broken down by `country`.
|
|
11808
|
-
*/
|
|
11809
|
-
country?: string;
|
|
11810
|
-
/**
|
|
11811
|
-
* Continent code when broken down by `continentCode`.
|
|
11812
|
-
*/
|
|
11813
|
-
continentCode?: string;
|
|
11814
|
-
/**
|
|
11815
|
-
* City name when broken down by `city`.
|
|
11816
|
-
*/
|
|
11817
|
-
city?: string;
|
|
11818
|
-
/**
|
|
11819
|
-
* Region/state chain when broken down by `subdivisions`.
|
|
11820
|
-
*/
|
|
11821
|
-
subdivisions?: string;
|
|
11822
|
-
/**
|
|
11823
|
-
* Internet service provider when broken down by `isp`.
|
|
11824
|
-
*/
|
|
11825
|
-
isp?: string;
|
|
11826
|
-
/**
|
|
11827
|
-
* Autonomous System Number (ASN) when broken down by `autonomousSystemNumber`.
|
|
11828
|
-
*/
|
|
11829
|
-
autonomousSystemNumber?: string;
|
|
11830
|
-
/**
|
|
11831
|
-
* Organization owning the ASN when broken down by `autonomousSystemOrganization`.
|
|
11832
|
-
*/
|
|
11833
|
-
autonomousSystemOrganization?: string;
|
|
11834
|
-
/**
|
|
11835
|
-
* Connection type (e.g. cable, cellular, corporate) when broken down by `connectionType`.
|
|
11836
|
-
*/
|
|
11837
|
-
connectionType?: string;
|
|
11838
|
-
/**
|
|
11839
|
-
* User type (e.g. residential, business, hosting) when broken down by `connectionUsageType`.
|
|
11840
|
-
*/
|
|
11841
|
-
connectionUsageType?: string;
|
|
11842
|
-
/**
|
|
11843
|
-
* Registered organization of the IP when broken down by `connectionOrganization`.
|
|
11844
|
-
*/
|
|
11845
|
-
connectionOrganization?: string;
|
|
11846
|
-
/**
|
|
11847
|
-
* Appwrite region when broken down by `region`.
|
|
11848
|
-
*/
|
|
11849
|
-
region?: string;
|
|
11850
|
-
/**
|
|
11851
|
-
* Caller origin hostname when broken down by `hostname`.
|
|
11852
|
-
*/
|
|
11853
|
-
hostname?: string;
|
|
11854
|
-
/**
|
|
11855
|
-
* Caller IP address when broken down by `ip`.
|
|
11856
|
-
*/
|
|
11857
|
-
ip?: string;
|
|
11858
|
-
/**
|
|
11859
|
-
* Operating system name when broken down by `osName`.
|
|
11860
|
-
*/
|
|
11861
|
-
osName?: string;
|
|
11862
|
-
/**
|
|
11863
|
-
* Client type when broken down by `clientType`.
|
|
11864
|
-
*/
|
|
11865
|
-
clientType?: string;
|
|
11866
|
-
/**
|
|
11867
|
-
* Client name when broken down by `clientName`.
|
|
11868
|
-
*/
|
|
11869
|
-
clientName?: string;
|
|
11870
|
-
/**
|
|
11871
|
-
* SDK name when broken down by `sdk`.
|
|
11872
|
-
*/
|
|
11873
|
-
sdk?: string;
|
|
11874
|
-
/**
|
|
11875
|
-
* SDK version when broken down by `sdkVersion`.
|
|
11876
|
-
*/
|
|
11877
|
-
sdkVersion?: string;
|
|
11878
|
-
/**
|
|
11879
|
-
* Device classification when broken down by `deviceName`.
|
|
11880
|
-
*/
|
|
11881
|
-
deviceName?: string;
|
|
11882
|
-
/**
|
|
11883
|
-
* Owning team ID when broken down by `teamId`.
|
|
11884
|
-
*/
|
|
11885
|
-
teamId?: string;
|
|
11886
|
-
/**
|
|
11887
|
-
* External resource ID when broken down by `resourceId`.
|
|
11888
|
-
*/
|
|
11889
|
-
resourceId?: string;
|
|
11890
|
-
/**
|
|
11891
|
-
* Resource type when broken down by `resourceType`.
|
|
11892
|
-
*/
|
|
11893
|
-
resourceType?: string;
|
|
11894
|
-
/**
|
|
11895
|
-
* Node ordinal when broken down by `ordinal`. A stable per-node identity, not a role: ordinal 0 is the first member created, and a failover can leave the primary on any ordinal. Read the role from the database's replicas endpoint.
|
|
11896
|
-
*/
|
|
11897
|
-
ordinal?: string;
|
|
11898
|
-
};
|
|
11899
|
-
/**
|
|
11900
|
-
* usageEventList
|
|
11901
|
-
*/
|
|
11902
|
-
export type UsageEventList = {
|
|
11903
|
-
/**
|
|
11904
|
-
* Time interval size (1h or 1d). Empty when the request omits `interval` — points then carry the request end time as their as-of marker.
|
|
11905
|
-
*/
|
|
11906
|
-
interval: string;
|
|
11907
|
-
/**
|
|
11908
|
-
* One entry per requested metric, each carrying its own points[] time series (sums per bucket / dimension over time).
|
|
11909
|
-
*/
|
|
11910
|
-
metrics: UsageMetric[];
|
|
11911
|
-
};
|
|
11912
|
-
/**
|
|
11913
|
-
* usageGaugeList
|
|
11914
|
-
*/
|
|
11915
|
-
export type UsageGaugeList = {
|
|
11916
|
-
/**
|
|
11917
|
-
* Time interval size (1h or 1d). Empty when the request omits `interval` — points then carry the request end time as their as-of marker.
|
|
11918
|
-
*/
|
|
11919
|
-
interval: string;
|
|
11920
|
-
/**
|
|
11921
|
-
* One entry per requested metric, each carrying its own points[] time series (latest-snapshot per bucket / dimension via argMax over time).
|
|
11922
|
-
*/
|
|
11923
|
-
metrics: UsageMetric[];
|
|
11924
|
-
};
|
|
11925
|
-
/**
|
|
11926
|
-
* usageMetric
|
|
11927
|
-
*/
|
|
11928
|
-
export type UsageMetric = {
|
|
11929
|
-
/**
|
|
11930
|
-
* Metric key this series describes.
|
|
11931
|
-
*/
|
|
11932
|
-
metric: string;
|
|
11933
|
-
/**
|
|
11934
|
-
* 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.
|
|
11935
|
-
*/
|
|
11936
|
-
points: UsageDataPoint[];
|
|
11937
|
-
};
|
|
11938
11837
|
/**
|
|
11939
11838
|
* Organization
|
|
11940
11839
|
*/
|
|
@@ -12071,11 +11970,11 @@ export declare namespace Models {
|
|
|
12071
11970
|
/**
|
|
12072
11971
|
* Aggregated stats for number of requests.
|
|
12073
11972
|
*/
|
|
12074
|
-
bandwidth:
|
|
11973
|
+
bandwidth: number;
|
|
12075
11974
|
/**
|
|
12076
11975
|
* Aggregated stats for consumed bandwidth.
|
|
12077
11976
|
*/
|
|
12078
|
-
users:
|
|
11977
|
+
users: number;
|
|
12079
11978
|
/**
|
|
12080
11979
|
* Aggregated stats for function executions.
|
|
12081
11980
|
*/
|
|
@@ -12083,11 +11982,11 @@ export declare namespace Models {
|
|
|
12083
11982
|
/**
|
|
12084
11983
|
* Aggregated stats for database reads.
|
|
12085
11984
|
*/
|
|
12086
|
-
databasesReads:
|
|
11985
|
+
databasesReads: number;
|
|
12087
11986
|
/**
|
|
12088
11987
|
* Aggregated stats for database writes.
|
|
12089
11988
|
*/
|
|
12090
|
-
databasesWrites:
|
|
11989
|
+
databasesWrites: number;
|
|
12091
11990
|
/**
|
|
12092
11991
|
* Aggregated stats for function executions in mb seconds.
|
|
12093
11992
|
*/
|
|
@@ -12119,7 +12018,7 @@ export declare namespace Models {
|
|
|
12119
12018
|
/**
|
|
12120
12019
|
* Aggregated stats for file transformations.
|
|
12121
12020
|
*/
|
|
12122
|
-
imageTransformations:
|
|
12021
|
+
imageTransformations: number;
|
|
12123
12022
|
/**
|
|
12124
12023
|
* Aggregated stats for total file transformations.
|
|
12125
12024
|
*/
|
|
@@ -12127,7 +12026,7 @@ export declare namespace Models {
|
|
|
12127
12026
|
/**
|
|
12128
12027
|
* Aggregated stats for file transformations.
|
|
12129
12028
|
*/
|
|
12130
|
-
screenshotsGenerated:
|
|
12029
|
+
screenshotsGenerated: number;
|
|
12131
12030
|
/**
|
|
12132
12031
|
* Aggregated stats for total file transformations.
|
|
12133
12032
|
*/
|
|
@@ -12429,7 +12328,7 @@ export declare namespace Models {
|
|
|
12429
12328
|
/**
|
|
12430
12329
|
* Authorization details granted to the application. Rich authorization request (RFC 9396) style entries; the Appwrite Console stores authorized project IDs here.
|
|
12431
12330
|
*/
|
|
12432
|
-
authorizationDetails:
|
|
12331
|
+
authorizationDetails: Record<string, any>[];
|
|
12433
12332
|
/**
|
|
12434
12333
|
* ID of the user who created the installation.
|
|
12435
12334
|
*/
|
|
@@ -12792,7 +12691,7 @@ export declare namespace Models {
|
|
|
12792
12691
|
/**
|
|
12793
12692
|
* List of conditions evaluated for this rule.
|
|
12794
12693
|
*/
|
|
12795
|
-
conditions:
|
|
12694
|
+
conditions: Record<string, any>[];
|
|
12796
12695
|
/**
|
|
12797
12696
|
* Action specific configuration.
|
|
12798
12697
|
*/
|
|
@@ -12853,7 +12752,7 @@ export declare namespace Models {
|
|
|
12853
12752
|
/**
|
|
12854
12753
|
* List of conditions evaluated for this rule.
|
|
12855
12754
|
*/
|
|
12856
|
-
conditions:
|
|
12755
|
+
conditions: Record<string, any>[];
|
|
12857
12756
|
/**
|
|
12858
12757
|
* Action specific configuration.
|
|
12859
12758
|
*/
|
|
@@ -12914,7 +12813,7 @@ export declare namespace Models {
|
|
|
12914
12813
|
/**
|
|
12915
12814
|
* List of conditions evaluated for this rule.
|
|
12916
12815
|
*/
|
|
12917
|
-
conditions:
|
|
12816
|
+
conditions: Record<string, any>[];
|
|
12918
12817
|
/**
|
|
12919
12818
|
* Action specific configuration.
|
|
12920
12819
|
*/
|
|
@@ -12975,7 +12874,7 @@ export declare namespace Models {
|
|
|
12975
12874
|
/**
|
|
12976
12875
|
* List of conditions evaluated for this rule.
|
|
12977
12876
|
*/
|
|
12978
|
-
conditions:
|
|
12877
|
+
conditions: Record<string, any>[];
|
|
12979
12878
|
/**
|
|
12980
12879
|
* Action specific configuration.
|
|
12981
12880
|
*/
|
|
@@ -13048,7 +12947,7 @@ export declare namespace Models {
|
|
|
13048
12947
|
/**
|
|
13049
12948
|
* List of conditions evaluated for this rule.
|
|
13050
12949
|
*/
|
|
13051
|
-
conditions:
|
|
12950
|
+
conditions: Record<string, any>[];
|
|
13052
12951
|
/**
|
|
13053
12952
|
* Action specific configuration.
|
|
13054
12953
|
*/
|
|
@@ -13065,6 +12964,14 @@ export declare namespace Models {
|
|
|
13065
12964
|
* Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.
|
|
13066
12965
|
*/
|
|
13067
12966
|
key: string;
|
|
12967
|
+
/**
|
|
12968
|
+
* Rate limit strategy: `fixedWindow`, `slidingWindow`, or `tokenBucket`.
|
|
12969
|
+
*/
|
|
12970
|
+
strategy: string;
|
|
12971
|
+
/**
|
|
12972
|
+
* Maximum burst capacity in tokens, applied by the `tokenBucket` strategy. The sustained refill rate is `limit / interval`. Defaults to `limit`.
|
|
12973
|
+
*/
|
|
12974
|
+
maxBucketSize: number;
|
|
13068
12975
|
};
|
|
13069
12976
|
/**
|
|
13070
12977
|
* WafRuleRedirect
|
|
@@ -13121,7 +13028,7 @@ export declare namespace Models {
|
|
|
13121
13028
|
/**
|
|
13122
13029
|
* List of conditions evaluated for this rule.
|
|
13123
13030
|
*/
|
|
13124
|
-
conditions:
|
|
13031
|
+
conditions: Record<string, any>[];
|
|
13125
13032
|
/**
|
|
13126
13033
|
* Action specific configuration.
|
|
13127
13034
|
*/
|
|
@@ -13344,9 +13251,9 @@ export declare namespace Models {
|
|
|
13344
13251
|
plans: BillingPlan[];
|
|
13345
13252
|
};
|
|
13346
13253
|
/**
|
|
13347
|
-
*
|
|
13254
|
+
* Manager blocks list
|
|
13348
13255
|
*/
|
|
13349
|
-
export type
|
|
13256
|
+
export type ManagerBlockList = {
|
|
13350
13257
|
/**
|
|
13351
13258
|
* Total number of blocks that matched your query.
|
|
13352
13259
|
*/
|
|
@@ -13354,7 +13261,7 @@ export declare namespace Models {
|
|
|
13354
13261
|
/**
|
|
13355
13262
|
* List of blocks.
|
|
13356
13263
|
*/
|
|
13357
|
-
blocks:
|
|
13264
|
+
blocks: ManagerBlock[];
|
|
13358
13265
|
};
|
|
13359
13266
|
/**
|
|
13360
13267
|
* Database Migrations List
|
|
@@ -13408,6 +13315,19 @@ export declare namespace Models {
|
|
|
13408
13315
|
*/
|
|
13409
13316
|
suggestions: DomainSuggestion[];
|
|
13410
13317
|
};
|
|
13318
|
+
/**
|
|
13319
|
+
* Domain prices list
|
|
13320
|
+
*/
|
|
13321
|
+
export type DomainPricesList = {
|
|
13322
|
+
/**
|
|
13323
|
+
* Total number of prices that matched your query.
|
|
13324
|
+
*/
|
|
13325
|
+
total: number;
|
|
13326
|
+
/**
|
|
13327
|
+
* List of prices.
|
|
13328
|
+
*/
|
|
13329
|
+
prices: DomainPrice[];
|
|
13330
|
+
};
|
|
13411
13331
|
/**
|
|
13412
13332
|
* Domains list
|
|
13413
13333
|
*/
|