@appwrite.io/console 13.0.0 → 13.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.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +1658 -1162
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1656 -1163
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1676 -1180
- package/package.json +1 -1
- package/types/channel.d.ts +8 -3
- package/types/client.d.ts +1 -1
- package/types/enums/account-key-scopes.d.ts +5 -0
- package/types/enums/appwrite-migration-resource.d.ts +1 -0
- package/types/enums/backup-services.d.ts +1 -0
- package/types/enums/{resource-type.d.ts → block-resource-type.d.ts} +2 -6
- package/types/enums/{theme.d.ts → browser-theme.d.ts} +1 -1
- package/types/enums/cache-database.d.ts +5 -0
- package/types/enums/cache-target.d.ts +8 -0
- package/types/enums/{registration-type.d.ts → domain-registration-type.d.ts} +1 -1
- package/types/enums/{filter-type.d.ts → domain-suggestion-type.d.ts} +1 -1
- package/types/enums/{model.d.ts → embedding-model.d.ts} +1 -1
- package/types/enums/{runtime.d.ts → function-runtime.d.ts} +4 -2
- package/types/enums/function-template-use-case.d.ts +9 -0
- package/types/enums/{name.d.ts → health-queue-name.d.ts} +1 -1
- package/types/enums/{on-duplicate.d.ts → migration-on-duplicate.d.ts} +1 -1
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/organization-addon.d.ts +4 -0
- package/types/enums/organization-key-scopes.d.ts +12 -0
- package/types/enums/{auth-method.d.ts → project-auth-method-id.d.ts} +1 -1
- package/types/enums/{email-template-type.d.ts → project-email-template-id.d.ts} +1 -1
- package/types/enums/{email-template-locale.d.ts → project-email-template-locale.d.ts} +1 -1
- package/types/enums/{scopes.d.ts → project-key-scopes.d.ts} +10 -8
- package/types/enums/{prompt.d.ts → project-o-auth-2-google-prompt.d.ts} +1 -1
- package/types/enums/project-o-auth-provider-id.d.ts +45 -0
- package/types/enums/{project-policy.d.ts → project-policy-id.d.ts} +1 -1
- package/types/enums/{protocol-id.d.ts → project-protocol-id.d.ts} +1 -1
- package/types/enums/{service-id.d.ts → project-service-id.d.ts} +3 -2
- package/types/enums/project-smtp-secure.d.ts +4 -0
- package/types/enums/project-status.d.ts +3 -0
- package/types/enums/query-suggestion-resource.d.ts +10 -1
- package/types/enums/redirect-status-code.d.ts +6 -0
- package/types/enums/schedule-resource-type.d.ts +6 -0
- package/types/enums/{adapter.d.ts → site-adapter.d.ts} +1 -1
- package/types/enums/{runtimes.d.ts → site-build-runtime.d.ts} +4 -2
- package/types/enums/{framework.d.ts → site-framework.d.ts} +1 -1
- package/types/enums/{use-cases.d.ts → site-template-use-case.d.ts} +3 -8
- package/types/index.d.ts +35 -27
- package/types/models.d.ts +1183 -1187
- package/types/services/account.d.ts +9 -9
- package/types/services/avatars.d.ts +5 -5
- package/types/services/console.d.ts +31 -0
- package/types/services/documents-db.d.ts +1 -4
- package/types/services/domains.d.ts +216 -216
- package/types/services/functions.d.ts +36 -25
- package/types/services/health.d.ts +5 -5
- package/types/services/manager.d.ts +49 -9
- package/types/services/migrations.d.ts +13 -13
- package/types/services/organization.d.ts +234 -0
- package/types/services/organizations.d.ts +5 -131
- package/types/services/presences.d.ts +166 -0
- package/types/services/project.d.ts +93 -86
- package/types/services/projects.d.ts +10 -159
- package/types/services/proxy.d.ts +5 -5
- package/types/services/realtime.d.ts +45 -3
- package/types/services/sites.d.ts +43 -32
- package/types/services/usage.d.ts +50 -0
- package/types/services/vectors-db.d.ts +6 -9
- package/types/enums/addon.d.ts +0 -3
- package/types/enums/build-runtime.d.ts +0 -91
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/secure.d.ts +0 -4
- package/types/enums/status-code.d.ts +0 -6
- package/types/enums/status.d.ts +0 -3
package/types/models.d.ts
CHANGED
|
@@ -7,6 +7,9 @@ import { DetectionRuntimeType } from "./enums/detection-runtime-type";
|
|
|
7
7
|
import { DeploymentStatus } from "./enums/deployment-status";
|
|
8
8
|
import { ExecutionTrigger } from "./enums/execution-trigger";
|
|
9
9
|
import { ExecutionStatus } from "./enums/execution-status";
|
|
10
|
+
import { ProjectAuthMethodId } from "./enums/project-auth-method-id";
|
|
11
|
+
import { ProjectServiceId } from "./enums/project-service-id";
|
|
12
|
+
import { ProjectProtocolId } from "./enums/project-protocol-id";
|
|
10
13
|
import { OAuth2GooglePrompt } from "./enums/o-auth-2-google-prompt";
|
|
11
14
|
import { PlatformType } from "./enums/platform-type";
|
|
12
15
|
import { HealthAntivirusStatus } from "./enums/health-antivirus-status";
|
|
@@ -48,6 +51,19 @@ export declare namespace Models {
|
|
|
48
51
|
*/
|
|
49
52
|
documents: Document[];
|
|
50
53
|
};
|
|
54
|
+
/**
|
|
55
|
+
* Presences List
|
|
56
|
+
*/
|
|
57
|
+
export type PresenceList = {
|
|
58
|
+
/**
|
|
59
|
+
* Total number of presences that matched your query.
|
|
60
|
+
*/
|
|
61
|
+
total: number;
|
|
62
|
+
/**
|
|
63
|
+
* List of presences.
|
|
64
|
+
*/
|
|
65
|
+
presences: Presence[];
|
|
66
|
+
};
|
|
51
67
|
/**
|
|
52
68
|
* Tables List
|
|
53
69
|
*/
|
|
@@ -789,11 +805,11 @@ export declare namespace Models {
|
|
|
789
805
|
/**
|
|
790
806
|
* Database backup policies.
|
|
791
807
|
*/
|
|
792
|
-
policies:
|
|
808
|
+
policies: BackupPolicy[];
|
|
793
809
|
/**
|
|
794
810
|
* Database backup archives.
|
|
795
811
|
*/
|
|
796
|
-
archives:
|
|
812
|
+
archives: BackupArchive[];
|
|
797
813
|
};
|
|
798
814
|
/**
|
|
799
815
|
* Embedding
|
|
@@ -3070,6 +3086,47 @@ export declare namespace Models {
|
|
|
3070
3086
|
[key: string]: any;
|
|
3071
3087
|
[__default]: true;
|
|
3072
3088
|
};
|
|
3089
|
+
/**
|
|
3090
|
+
* Presence
|
|
3091
|
+
*/
|
|
3092
|
+
export type Presence = {
|
|
3093
|
+
/**
|
|
3094
|
+
* Presence ID.
|
|
3095
|
+
*/
|
|
3096
|
+
$id: string;
|
|
3097
|
+
/**
|
|
3098
|
+
* Presence creation date in ISO 8601 format.
|
|
3099
|
+
*/
|
|
3100
|
+
$createdAt: string;
|
|
3101
|
+
/**
|
|
3102
|
+
* Presence update date in ISO 8601 format.
|
|
3103
|
+
*/
|
|
3104
|
+
$updatedAt: string;
|
|
3105
|
+
/**
|
|
3106
|
+
* Presence permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
3107
|
+
*/
|
|
3108
|
+
$permissions: string[];
|
|
3109
|
+
/**
|
|
3110
|
+
* User ID.
|
|
3111
|
+
*/
|
|
3112
|
+
userId: string;
|
|
3113
|
+
/**
|
|
3114
|
+
* Presence status.
|
|
3115
|
+
*/
|
|
3116
|
+
status?: string;
|
|
3117
|
+
/**
|
|
3118
|
+
* Presence source.
|
|
3119
|
+
*/
|
|
3120
|
+
source: string;
|
|
3121
|
+
/**
|
|
3122
|
+
* Presence expiry date in ISO 8601 format.
|
|
3123
|
+
*/
|
|
3124
|
+
expiresAt?: string;
|
|
3125
|
+
/**
|
|
3126
|
+
* Presence metadata.
|
|
3127
|
+
*/
|
|
3128
|
+
metadata?: object;
|
|
3129
|
+
};
|
|
3073
3130
|
/**
|
|
3074
3131
|
* Log
|
|
3075
3132
|
*/
|
|
@@ -3653,6 +3710,10 @@ export declare namespace Models {
|
|
|
3653
3710
|
* File original size in bytes.
|
|
3654
3711
|
*/
|
|
3655
3712
|
sizeOriginal: number;
|
|
3713
|
+
/**
|
|
3714
|
+
* File actual stored size in bytes after compression and/or encryption.
|
|
3715
|
+
*/
|
|
3716
|
+
sizeActual: number;
|
|
3656
3717
|
/**
|
|
3657
3718
|
* Total number of chunks available
|
|
3658
3719
|
*/
|
|
@@ -3966,6 +4027,14 @@ export declare namespace Models {
|
|
|
3966
4027
|
* Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
|
|
3967
4028
|
*/
|
|
3968
4029
|
providerSilentMode: boolean;
|
|
4030
|
+
/**
|
|
4031
|
+
* List of branch name patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all branches.
|
|
4032
|
+
*/
|
|
4033
|
+
providerBranches: string[];
|
|
4034
|
+
/**
|
|
4035
|
+
* List of file path patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all file changes.
|
|
4036
|
+
*/
|
|
4037
|
+
providerPaths: string[];
|
|
3969
4038
|
/**
|
|
3970
4039
|
* Machine specification for deployment builds.
|
|
3971
4040
|
*/
|
|
@@ -4201,6 +4270,14 @@ export declare namespace Models {
|
|
|
4201
4270
|
* Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
|
|
4202
4271
|
*/
|
|
4203
4272
|
providerSilentMode: boolean;
|
|
4273
|
+
/**
|
|
4274
|
+
* List of branch name patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all branches.
|
|
4275
|
+
*/
|
|
4276
|
+
providerBranches: string[];
|
|
4277
|
+
/**
|
|
4278
|
+
* List of file path patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all file changes.
|
|
4279
|
+
*/
|
|
4280
|
+
providerPaths: string[];
|
|
4204
4281
|
/**
|
|
4205
4282
|
* Machine specification for deployment builds.
|
|
4206
4283
|
*/
|
|
@@ -4899,132 +4976,12 @@ export declare namespace Models {
|
|
|
4899
4976
|
* Project name.
|
|
4900
4977
|
*/
|
|
4901
4978
|
name: string;
|
|
4902
|
-
/**
|
|
4903
|
-
* Project description.
|
|
4904
|
-
*/
|
|
4905
|
-
description: string;
|
|
4906
4979
|
/**
|
|
4907
4980
|
* Project team ID.
|
|
4908
4981
|
*/
|
|
4909
4982
|
teamId: string;
|
|
4910
4983
|
/**
|
|
4911
|
-
*
|
|
4912
|
-
*/
|
|
4913
|
-
logo: string;
|
|
4914
|
-
/**
|
|
4915
|
-
* Project website URL.
|
|
4916
|
-
*/
|
|
4917
|
-
url: string;
|
|
4918
|
-
/**
|
|
4919
|
-
* Company legal name.
|
|
4920
|
-
*/
|
|
4921
|
-
legalName: string;
|
|
4922
|
-
/**
|
|
4923
|
-
* Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format.
|
|
4924
|
-
*/
|
|
4925
|
-
legalCountry: string;
|
|
4926
|
-
/**
|
|
4927
|
-
* State name.
|
|
4928
|
-
*/
|
|
4929
|
-
legalState: string;
|
|
4930
|
-
/**
|
|
4931
|
-
* City name.
|
|
4932
|
-
*/
|
|
4933
|
-
legalCity: string;
|
|
4934
|
-
/**
|
|
4935
|
-
* Company Address.
|
|
4936
|
-
*/
|
|
4937
|
-
legalAddress: string;
|
|
4938
|
-
/**
|
|
4939
|
-
* Company Tax ID.
|
|
4940
|
-
*/
|
|
4941
|
-
legalTaxId: string;
|
|
4942
|
-
/**
|
|
4943
|
-
* Session duration in seconds.
|
|
4944
|
-
*/
|
|
4945
|
-
authDuration: number;
|
|
4946
|
-
/**
|
|
4947
|
-
* Max users allowed. 0 is unlimited.
|
|
4948
|
-
*/
|
|
4949
|
-
authLimit: number;
|
|
4950
|
-
/**
|
|
4951
|
-
* Max sessions allowed per user. 100 maximum.
|
|
4952
|
-
*/
|
|
4953
|
-
authSessionsLimit: number;
|
|
4954
|
-
/**
|
|
4955
|
-
* Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.
|
|
4956
|
-
*/
|
|
4957
|
-
authPasswordHistory: number;
|
|
4958
|
-
/**
|
|
4959
|
-
* Whether or not to check user's password against most commonly used passwords.
|
|
4960
|
-
*/
|
|
4961
|
-
authPasswordDictionary: boolean;
|
|
4962
|
-
/**
|
|
4963
|
-
* Whether or not to check the user password for similarity with their personal data.
|
|
4964
|
-
*/
|
|
4965
|
-
authPersonalDataCheck: boolean;
|
|
4966
|
-
/**
|
|
4967
|
-
* Whether or not to disallow disposable email addresses during signup and email updates.
|
|
4968
|
-
*/
|
|
4969
|
-
authDisposableEmails: boolean;
|
|
4970
|
-
/**
|
|
4971
|
-
* Whether or not to require canonical email addresses during signup and email updates.
|
|
4972
|
-
*/
|
|
4973
|
-
authCanonicalEmails: boolean;
|
|
4974
|
-
/**
|
|
4975
|
-
* Whether or not to disallow free email addresses during signup and email updates.
|
|
4976
|
-
*/
|
|
4977
|
-
authFreeEmails: boolean;
|
|
4978
|
-
/**
|
|
4979
|
-
* An array of mock numbers and their corresponding verification codes (OTPs).
|
|
4980
|
-
*/
|
|
4981
|
-
authMockNumbers: MockNumber[];
|
|
4982
|
-
/**
|
|
4983
|
-
* Whether or not to send session alert emails to users.
|
|
4984
|
-
*/
|
|
4985
|
-
authSessionAlerts: boolean;
|
|
4986
|
-
/**
|
|
4987
|
-
* Whether or not to show user names in the teams membership response.
|
|
4988
|
-
*/
|
|
4989
|
-
authMembershipsUserName: boolean;
|
|
4990
|
-
/**
|
|
4991
|
-
* Whether or not to show user emails in the teams membership response.
|
|
4992
|
-
*/
|
|
4993
|
-
authMembershipsUserEmail: boolean;
|
|
4994
|
-
/**
|
|
4995
|
-
* Whether or not to show user MFA status in the teams membership response.
|
|
4996
|
-
*/
|
|
4997
|
-
authMembershipsMfa: boolean;
|
|
4998
|
-
/**
|
|
4999
|
-
* Whether or not to show user IDs in the teams membership response.
|
|
5000
|
-
*/
|
|
5001
|
-
authMembershipsUserId: boolean;
|
|
5002
|
-
/**
|
|
5003
|
-
* Whether or not to show user phone numbers in the teams membership response.
|
|
5004
|
-
*/
|
|
5005
|
-
authMembershipsUserPhone: boolean;
|
|
5006
|
-
/**
|
|
5007
|
-
* Whether or not all existing sessions should be invalidated on password change
|
|
5008
|
-
*/
|
|
5009
|
-
authInvalidateSessions: boolean;
|
|
5010
|
-
/**
|
|
5011
|
-
* List of Auth Providers.
|
|
5012
|
-
*/
|
|
5013
|
-
oAuthProviders: AuthProvider[];
|
|
5014
|
-
/**
|
|
5015
|
-
* List of Platforms.
|
|
5016
|
-
*/
|
|
5017
|
-
platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
|
|
5018
|
-
/**
|
|
5019
|
-
* List of Webhooks.
|
|
5020
|
-
*/
|
|
5021
|
-
webhooks: Webhook[];
|
|
5022
|
-
/**
|
|
5023
|
-
* List of API Keys.
|
|
5024
|
-
*/
|
|
5025
|
-
keys: Key[];
|
|
5026
|
-
/**
|
|
5027
|
-
* List of dev keys.
|
|
4984
|
+
* Deprecated since 1.9.5: List of dev keys.
|
|
5028
4985
|
*/
|
|
5029
4986
|
devKeys: DevKey[];
|
|
5030
4987
|
/**
|
|
@@ -5084,129 +5041,72 @@ export declare namespace Models {
|
|
|
5084
5041
|
*/
|
|
5085
5042
|
status: string;
|
|
5086
5043
|
/**
|
|
5087
|
-
*
|
|
5088
|
-
*/
|
|
5089
|
-
authEmailPassword: boolean;
|
|
5090
|
-
/**
|
|
5091
|
-
* Magic URL auth method status
|
|
5092
|
-
*/
|
|
5093
|
-
authUsersAuthMagicURL: boolean;
|
|
5094
|
-
/**
|
|
5095
|
-
* Email (OTP) auth method status
|
|
5096
|
-
*/
|
|
5097
|
-
authEmailOtp: boolean;
|
|
5098
|
-
/**
|
|
5099
|
-
* Anonymous auth method status
|
|
5100
|
-
*/
|
|
5101
|
-
authAnonymous: boolean;
|
|
5102
|
-
/**
|
|
5103
|
-
* Invites auth method status
|
|
5104
|
-
*/
|
|
5105
|
-
authInvites: boolean;
|
|
5106
|
-
/**
|
|
5107
|
-
* JWT auth method status
|
|
5108
|
-
*/
|
|
5109
|
-
authJWT: boolean;
|
|
5110
|
-
/**
|
|
5111
|
-
* Phone auth method status
|
|
5044
|
+
* List of auth methods.
|
|
5112
5045
|
*/
|
|
5113
|
-
|
|
5046
|
+
authMethods: ProjectAuthMethod[];
|
|
5114
5047
|
/**
|
|
5115
|
-
*
|
|
5048
|
+
* List of services.
|
|
5116
5049
|
*/
|
|
5117
|
-
|
|
5050
|
+
services: ProjectService[];
|
|
5118
5051
|
/**
|
|
5119
|
-
*
|
|
5052
|
+
* List of protocols.
|
|
5120
5053
|
*/
|
|
5121
|
-
|
|
5054
|
+
protocols: ProjectProtocol[];
|
|
5122
5055
|
/**
|
|
5123
|
-
*
|
|
5124
|
-
*/
|
|
5125
|
-
serviceStatusForDatabases: boolean;
|
|
5126
|
-
/**
|
|
5127
|
-
* TablesDB service status
|
|
5128
|
-
*/
|
|
5129
|
-
serviceStatusForTablesdb: boolean;
|
|
5130
|
-
/**
|
|
5131
|
-
* Locale service status
|
|
5132
|
-
*/
|
|
5133
|
-
serviceStatusForLocale: boolean;
|
|
5134
|
-
/**
|
|
5135
|
-
* Health service status
|
|
5136
|
-
*/
|
|
5137
|
-
serviceStatusForHealth: boolean;
|
|
5138
|
-
/**
|
|
5139
|
-
* Project service status
|
|
5140
|
-
*/
|
|
5141
|
-
serviceStatusForProject: boolean;
|
|
5142
|
-
/**
|
|
5143
|
-
* Storage service status
|
|
5144
|
-
*/
|
|
5145
|
-
serviceStatusForStorage: boolean;
|
|
5146
|
-
/**
|
|
5147
|
-
* Teams service status
|
|
5148
|
-
*/
|
|
5149
|
-
serviceStatusForTeams: boolean;
|
|
5150
|
-
/**
|
|
5151
|
-
* Users service status
|
|
5152
|
-
*/
|
|
5153
|
-
serviceStatusForUsers: boolean;
|
|
5154
|
-
/**
|
|
5155
|
-
* VCS service status
|
|
5156
|
-
*/
|
|
5157
|
-
serviceStatusForVcs: boolean;
|
|
5158
|
-
/**
|
|
5159
|
-
* Sites service status
|
|
5160
|
-
*/
|
|
5161
|
-
serviceStatusForSites: boolean;
|
|
5162
|
-
/**
|
|
5163
|
-
* Functions service status
|
|
5164
|
-
*/
|
|
5165
|
-
serviceStatusForFunctions: boolean;
|
|
5166
|
-
/**
|
|
5167
|
-
* Proxy service status
|
|
5168
|
-
*/
|
|
5169
|
-
serviceStatusForProxy: boolean;
|
|
5170
|
-
/**
|
|
5171
|
-
* GraphQL service status
|
|
5056
|
+
* Project region
|
|
5172
5057
|
*/
|
|
5173
|
-
|
|
5058
|
+
region: string;
|
|
5174
5059
|
/**
|
|
5175
|
-
*
|
|
5060
|
+
* Billing limits reached
|
|
5176
5061
|
*/
|
|
5177
|
-
|
|
5062
|
+
billingLimits?: BillingLimits;
|
|
5178
5063
|
/**
|
|
5179
|
-
*
|
|
5064
|
+
* Project blocks information
|
|
5180
5065
|
*/
|
|
5181
|
-
|
|
5066
|
+
blocks: Block[];
|
|
5182
5067
|
/**
|
|
5183
|
-
*
|
|
5068
|
+
* Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.
|
|
5184
5069
|
*/
|
|
5185
|
-
|
|
5070
|
+
consoleAccessedAt: string;
|
|
5071
|
+
};
|
|
5072
|
+
/**
|
|
5073
|
+
* ProjectAuthMethod
|
|
5074
|
+
*/
|
|
5075
|
+
export type ProjectAuthMethod = {
|
|
5186
5076
|
/**
|
|
5187
|
-
*
|
|
5077
|
+
* Auth method ID.
|
|
5188
5078
|
*/
|
|
5189
|
-
|
|
5079
|
+
$id: ProjectAuthMethodId;
|
|
5190
5080
|
/**
|
|
5191
|
-
*
|
|
5081
|
+
* Auth method status.
|
|
5192
5082
|
*/
|
|
5193
|
-
|
|
5083
|
+
enabled: boolean;
|
|
5084
|
+
};
|
|
5085
|
+
/**
|
|
5086
|
+
* ProjectService
|
|
5087
|
+
*/
|
|
5088
|
+
export type ProjectService = {
|
|
5194
5089
|
/**
|
|
5195
|
-
*
|
|
5090
|
+
* Service ID.
|
|
5196
5091
|
*/
|
|
5197
|
-
|
|
5092
|
+
$id: ProjectServiceId;
|
|
5198
5093
|
/**
|
|
5199
|
-
*
|
|
5094
|
+
* Service status.
|
|
5200
5095
|
*/
|
|
5201
|
-
|
|
5096
|
+
enabled: boolean;
|
|
5097
|
+
};
|
|
5098
|
+
/**
|
|
5099
|
+
* ProjectProtocol
|
|
5100
|
+
*/
|
|
5101
|
+
export type ProjectProtocol = {
|
|
5202
5102
|
/**
|
|
5203
|
-
*
|
|
5103
|
+
* Protocol ID.
|
|
5204
5104
|
*/
|
|
5205
|
-
|
|
5105
|
+
$id: ProjectProtocolId;
|
|
5206
5106
|
/**
|
|
5207
|
-
*
|
|
5107
|
+
* Protocol status.
|
|
5208
5108
|
*/
|
|
5209
|
-
|
|
5109
|
+
enabled: boolean;
|
|
5210
5110
|
};
|
|
5211
5111
|
/**
|
|
5212
5112
|
* Webhook
|
|
@@ -6455,31 +6355,6 @@ export declare namespace Models {
|
|
|
6455
6355
|
*/
|
|
6456
6356
|
userMFA: boolean;
|
|
6457
6357
|
};
|
|
6458
|
-
/**
|
|
6459
|
-
* AuthProvider
|
|
6460
|
-
*/
|
|
6461
|
-
export type AuthProvider = {
|
|
6462
|
-
/**
|
|
6463
|
-
* Auth Provider.
|
|
6464
|
-
*/
|
|
6465
|
-
key: string;
|
|
6466
|
-
/**
|
|
6467
|
-
* Auth Provider name.
|
|
6468
|
-
*/
|
|
6469
|
-
name: string;
|
|
6470
|
-
/**
|
|
6471
|
-
* OAuth 2.0 application ID.
|
|
6472
|
-
*/
|
|
6473
|
-
appId: string;
|
|
6474
|
-
/**
|
|
6475
|
-
* OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.
|
|
6476
|
-
*/
|
|
6477
|
-
secret: string;
|
|
6478
|
-
/**
|
|
6479
|
-
* Auth Provider is active and can be used to create session.
|
|
6480
|
-
*/
|
|
6481
|
-
enabled: boolean;
|
|
6482
|
-
};
|
|
6483
6358
|
/**
|
|
6484
6359
|
* Platform Web
|
|
6485
6360
|
*/
|
|
@@ -7084,6 +6959,23 @@ export declare namespace Models {
|
|
|
7084
6959
|
*/
|
|
7085
6960
|
sessions: Metric[];
|
|
7086
6961
|
};
|
|
6962
|
+
/**
|
|
6963
|
+
* UsagePresence
|
|
6964
|
+
*/
|
|
6965
|
+
export type UsagePresence = {
|
|
6966
|
+
/**
|
|
6967
|
+
* Time range of the usage stats.
|
|
6968
|
+
*/
|
|
6969
|
+
range: string;
|
|
6970
|
+
/**
|
|
6971
|
+
* Current total number of online users.
|
|
6972
|
+
*/
|
|
6973
|
+
usersOnlineTotal: number;
|
|
6974
|
+
/**
|
|
6975
|
+
* Aggregated number of online users per period.
|
|
6976
|
+
*/
|
|
6977
|
+
presences: Metric[];
|
|
6978
|
+
};
|
|
7087
6979
|
/**
|
|
7088
6980
|
* StorageUsage
|
|
7089
6981
|
*/
|
|
@@ -7611,7 +7503,7 @@ export declare namespace Models {
|
|
|
7611
7503
|
outbound: Metric[];
|
|
7612
7504
|
};
|
|
7613
7505
|
/**
|
|
7614
|
-
*
|
|
7506
|
+
* Project
|
|
7615
7507
|
*/
|
|
7616
7508
|
export type UsageProject = {
|
|
7617
7509
|
/**
|
|
@@ -8697,6 +8589,10 @@ export declare namespace Models {
|
|
|
8697
8589
|
* Number of functions to be migrated.
|
|
8698
8590
|
*/
|
|
8699
8591
|
function: number;
|
|
8592
|
+
/**
|
|
8593
|
+
* Number of platforms to be migrated.
|
|
8594
|
+
*/
|
|
8595
|
+
platform: number;
|
|
8700
8596
|
/**
|
|
8701
8597
|
* Number of sites to be migrated.
|
|
8702
8598
|
*/
|
|
@@ -8725,6 +8621,10 @@ export declare namespace Models {
|
|
|
8725
8621
|
* Version of the Appwrite instance to be migrated.
|
|
8726
8622
|
*/
|
|
8727
8623
|
version: string;
|
|
8624
|
+
/**
|
|
8625
|
+
* Number of backup policies to be migrated.
|
|
8626
|
+
*/
|
|
8627
|
+
backuppolicy: number;
|
|
8728
8628
|
};
|
|
8729
8629
|
/**
|
|
8730
8630
|
* ActivityEvent
|
|
@@ -8735,21 +8635,21 @@ export declare namespace Models {
|
|
|
8735
8635
|
*/
|
|
8736
8636
|
$id: string;
|
|
8737
8637
|
/**
|
|
8738
|
-
*
|
|
8638
|
+
* Actor type.
|
|
8739
8639
|
*/
|
|
8740
|
-
|
|
8640
|
+
actorType: string;
|
|
8741
8641
|
/**
|
|
8742
|
-
*
|
|
8642
|
+
* Actor ID.
|
|
8743
8643
|
*/
|
|
8744
|
-
|
|
8644
|
+
actorId: string;
|
|
8745
8645
|
/**
|
|
8746
|
-
*
|
|
8646
|
+
* Actor Email.
|
|
8747
8647
|
*/
|
|
8748
|
-
|
|
8648
|
+
actorEmail: string;
|
|
8749
8649
|
/**
|
|
8750
|
-
*
|
|
8650
|
+
* Actor Name.
|
|
8751
8651
|
*/
|
|
8752
|
-
|
|
8652
|
+
actorName: string;
|
|
8753
8653
|
/**
|
|
8754
8654
|
* Resource parent.
|
|
8755
8655
|
*/
|
|
@@ -8889,53 +8789,160 @@ export declare namespace Models {
|
|
|
8889
8789
|
invoiceDesc: string;
|
|
8890
8790
|
};
|
|
8891
8791
|
/**
|
|
8892
|
-
*
|
|
8792
|
+
* Addon
|
|
8893
8793
|
*/
|
|
8894
|
-
export type
|
|
8794
|
+
export type Addon = {
|
|
8895
8795
|
/**
|
|
8896
|
-
*
|
|
8796
|
+
* Addon ID.
|
|
8897
8797
|
*/
|
|
8898
8798
|
$id: string;
|
|
8899
8799
|
/**
|
|
8900
|
-
*
|
|
8800
|
+
* Addon creation time in ISO 8601 format.
|
|
8901
8801
|
*/
|
|
8902
8802
|
$createdAt: string;
|
|
8903
8803
|
/**
|
|
8904
|
-
*
|
|
8804
|
+
* Addon update date in ISO 8601 format.
|
|
8905
8805
|
*/
|
|
8906
8806
|
$updatedAt: string;
|
|
8907
8807
|
/**
|
|
8908
|
-
*
|
|
8808
|
+
* Addon permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
8909
8809
|
*/
|
|
8910
8810
|
$permissions: string[];
|
|
8911
8811
|
/**
|
|
8912
|
-
*
|
|
8913
|
-
*/
|
|
8914
|
-
from: string;
|
|
8915
|
-
/**
|
|
8916
|
-
* End date of the invoice
|
|
8812
|
+
* Addon key
|
|
8917
8813
|
*/
|
|
8918
|
-
|
|
8814
|
+
key: string;
|
|
8919
8815
|
/**
|
|
8920
|
-
*
|
|
8816
|
+
* Resource type (organization or project)
|
|
8921
8817
|
*/
|
|
8922
|
-
|
|
8818
|
+
resourceType: string;
|
|
8923
8819
|
/**
|
|
8924
|
-
*
|
|
8820
|
+
* Resource ID
|
|
8925
8821
|
*/
|
|
8926
|
-
|
|
8822
|
+
resourceId: string;
|
|
8927
8823
|
/**
|
|
8928
|
-
*
|
|
8824
|
+
* Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).
|
|
8929
8825
|
*/
|
|
8930
|
-
|
|
8826
|
+
status: string;
|
|
8931
8827
|
/**
|
|
8932
|
-
*
|
|
8828
|
+
* Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.
|
|
8933
8829
|
*/
|
|
8934
|
-
|
|
8830
|
+
currentValue: number;
|
|
8935
8831
|
/**
|
|
8936
|
-
*
|
|
8832
|
+
* Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.
|
|
8937
8833
|
*/
|
|
8938
|
-
|
|
8834
|
+
nextValue?: number;
|
|
8835
|
+
};
|
|
8836
|
+
/**
|
|
8837
|
+
* AddonPrice
|
|
8838
|
+
*/
|
|
8839
|
+
export type AddonPrice = {
|
|
8840
|
+
/**
|
|
8841
|
+
* Addon key.
|
|
8842
|
+
*/
|
|
8843
|
+
addonKey: string;
|
|
8844
|
+
/**
|
|
8845
|
+
* Addon display name.
|
|
8846
|
+
*/
|
|
8847
|
+
name: string;
|
|
8848
|
+
/**
|
|
8849
|
+
* Full monthly price of the addon.
|
|
8850
|
+
*/
|
|
8851
|
+
monthlyPrice: number;
|
|
8852
|
+
/**
|
|
8853
|
+
* Calculated prorated amount for the current billing cycle.
|
|
8854
|
+
*/
|
|
8855
|
+
proratedAmount: number;
|
|
8856
|
+
/**
|
|
8857
|
+
* Days remaining in the current billing cycle.
|
|
8858
|
+
*/
|
|
8859
|
+
remainingDays: number;
|
|
8860
|
+
/**
|
|
8861
|
+
* Total days in the billing cycle.
|
|
8862
|
+
*/
|
|
8863
|
+
totalCycleDays: number;
|
|
8864
|
+
/**
|
|
8865
|
+
* Currency code.
|
|
8866
|
+
*/
|
|
8867
|
+
currency: string;
|
|
8868
|
+
/**
|
|
8869
|
+
* When the current billing cycle ends.
|
|
8870
|
+
*/
|
|
8871
|
+
billingCycleEnd: string;
|
|
8872
|
+
};
|
|
8873
|
+
/**
|
|
8874
|
+
* Breakdown
|
|
8875
|
+
*/
|
|
8876
|
+
export type AggregationBreakdown = {
|
|
8877
|
+
/**
|
|
8878
|
+
* Aggregation ID.
|
|
8879
|
+
*/
|
|
8880
|
+
$id: string;
|
|
8881
|
+
/**
|
|
8882
|
+
* Project name
|
|
8883
|
+
*/
|
|
8884
|
+
name: string;
|
|
8885
|
+
/**
|
|
8886
|
+
* Project region
|
|
8887
|
+
*/
|
|
8888
|
+
region: string;
|
|
8889
|
+
/**
|
|
8890
|
+
* Aggregated amount
|
|
8891
|
+
*/
|
|
8892
|
+
amount: number;
|
|
8893
|
+
/**
|
|
8894
|
+
*
|
|
8895
|
+
*/
|
|
8896
|
+
resources: UsageResources[];
|
|
8897
|
+
};
|
|
8898
|
+
/**
|
|
8899
|
+
* Team
|
|
8900
|
+
*/
|
|
8901
|
+
export type AggregationTeam = {
|
|
8902
|
+
/**
|
|
8903
|
+
* Aggregation ID.
|
|
8904
|
+
*/
|
|
8905
|
+
$id: string;
|
|
8906
|
+
/**
|
|
8907
|
+
* Aggregation creation time in ISO 8601 format.
|
|
8908
|
+
*/
|
|
8909
|
+
$createdAt: string;
|
|
8910
|
+
/**
|
|
8911
|
+
* Aggregation update date in ISO 8601 format.
|
|
8912
|
+
*/
|
|
8913
|
+
$updatedAt: string;
|
|
8914
|
+
/**
|
|
8915
|
+
* Aggregation permissions. [Learn more about permissions](/docs/permissions).
|
|
8916
|
+
*/
|
|
8917
|
+
$permissions: string[];
|
|
8918
|
+
/**
|
|
8919
|
+
* Beginning date of the invoice
|
|
8920
|
+
*/
|
|
8921
|
+
from: string;
|
|
8922
|
+
/**
|
|
8923
|
+
* End date of the invoice
|
|
8924
|
+
*/
|
|
8925
|
+
to: string;
|
|
8926
|
+
/**
|
|
8927
|
+
* Total storage usage
|
|
8928
|
+
*/
|
|
8929
|
+
usageStorage: number;
|
|
8930
|
+
/**
|
|
8931
|
+
* Total storage usage with builds storage
|
|
8932
|
+
*/
|
|
8933
|
+
usageTotalStorage: number;
|
|
8934
|
+
/**
|
|
8935
|
+
* Total files storage usage
|
|
8936
|
+
*/
|
|
8937
|
+
usageFilesStorage: number;
|
|
8938
|
+
/**
|
|
8939
|
+
* Total deployments storage usage
|
|
8940
|
+
*/
|
|
8941
|
+
usageDeploymentsStorage: number;
|
|
8942
|
+
/**
|
|
8943
|
+
* Total builds storage usage
|
|
8944
|
+
*/
|
|
8945
|
+
usageBuildsStorage: number;
|
|
8939
8946
|
/**
|
|
8940
8947
|
* Total databases storage usage
|
|
8941
8948
|
*/
|
|
@@ -9009,31 +9016,6 @@ export declare namespace Models {
|
|
|
9009
9016
|
*/
|
|
9010
9017
|
resources: UsageResources[];
|
|
9011
9018
|
};
|
|
9012
|
-
/**
|
|
9013
|
-
* AggregationBreakdown
|
|
9014
|
-
*/
|
|
9015
|
-
export type AggregationBreakdown = {
|
|
9016
|
-
/**
|
|
9017
|
-
* Aggregation ID.
|
|
9018
|
-
*/
|
|
9019
|
-
$id: string;
|
|
9020
|
-
/**
|
|
9021
|
-
* Project name
|
|
9022
|
-
*/
|
|
9023
|
-
name: string;
|
|
9024
|
-
/**
|
|
9025
|
-
* Project region
|
|
9026
|
-
*/
|
|
9027
|
-
region: string;
|
|
9028
|
-
/**
|
|
9029
|
-
* Aggregated amount
|
|
9030
|
-
*/
|
|
9031
|
-
amount: number;
|
|
9032
|
-
/**
|
|
9033
|
-
*
|
|
9034
|
-
*/
|
|
9035
|
-
resources: UsageResources[];
|
|
9036
|
-
};
|
|
9037
9019
|
/**
|
|
9038
9020
|
* Archive
|
|
9039
9021
|
*/
|
|
@@ -9088,7 +9070,7 @@ export declare namespace Models {
|
|
|
9088
9070
|
resourceType?: string;
|
|
9089
9071
|
};
|
|
9090
9072
|
/**
|
|
9091
|
-
*
|
|
9073
|
+
* Address
|
|
9092
9074
|
*/
|
|
9093
9075
|
export type BillingAddress = {
|
|
9094
9076
|
/**
|
|
@@ -9124,6 +9106,43 @@ export declare namespace Models {
|
|
|
9124
9106
|
*/
|
|
9125
9107
|
postalCode: string;
|
|
9126
9108
|
};
|
|
9109
|
+
/**
|
|
9110
|
+
* Limits
|
|
9111
|
+
*/
|
|
9112
|
+
export type BillingLimits = {
|
|
9113
|
+
/**
|
|
9114
|
+
* Bandwidth limit
|
|
9115
|
+
*/
|
|
9116
|
+
bandwidth?: number;
|
|
9117
|
+
/**
|
|
9118
|
+
* Storage limit
|
|
9119
|
+
*/
|
|
9120
|
+
storage?: number;
|
|
9121
|
+
/**
|
|
9122
|
+
* Users limit
|
|
9123
|
+
*/
|
|
9124
|
+
users?: number;
|
|
9125
|
+
/**
|
|
9126
|
+
* Executions limit
|
|
9127
|
+
*/
|
|
9128
|
+
executions?: number;
|
|
9129
|
+
/**
|
|
9130
|
+
* GBHours limit
|
|
9131
|
+
*/
|
|
9132
|
+
GBHours?: number;
|
|
9133
|
+
/**
|
|
9134
|
+
* Image transformations limit
|
|
9135
|
+
*/
|
|
9136
|
+
imageTransformations?: number;
|
|
9137
|
+
/**
|
|
9138
|
+
* Auth phone limit
|
|
9139
|
+
*/
|
|
9140
|
+
authPhone?: number;
|
|
9141
|
+
/**
|
|
9142
|
+
* Budget limit percentage
|
|
9143
|
+
*/
|
|
9144
|
+
budgetLimit?: number;
|
|
9145
|
+
};
|
|
9127
9146
|
/**
|
|
9128
9147
|
* billingPlan
|
|
9129
9148
|
*/
|
|
@@ -9382,7 +9401,7 @@ export declare namespace Models {
|
|
|
9382
9401
|
program?: Program;
|
|
9383
9402
|
};
|
|
9384
9403
|
/**
|
|
9385
|
-
*
|
|
9404
|
+
* Addon
|
|
9386
9405
|
*/
|
|
9387
9406
|
export type BillingPlanAddon = {
|
|
9388
9407
|
/**
|
|
@@ -9395,7 +9414,7 @@ export declare namespace Models {
|
|
|
9395
9414
|
projects: BillingPlanAddonDetails;
|
|
9396
9415
|
};
|
|
9397
9416
|
/**
|
|
9398
|
-
*
|
|
9417
|
+
* Details
|
|
9399
9418
|
*/
|
|
9400
9419
|
export type BillingPlanAddonDetails = {
|
|
9401
9420
|
/**
|
|
@@ -9432,7 +9451,7 @@ export declare namespace Models {
|
|
|
9432
9451
|
invoiceDesc: string;
|
|
9433
9452
|
};
|
|
9434
9453
|
/**
|
|
9435
|
-
*
|
|
9454
|
+
* PlanLimits
|
|
9436
9455
|
*/
|
|
9437
9456
|
export type BillingPlanLimits = {
|
|
9438
9457
|
/**
|
|
@@ -9453,43 +9472,6 @@ export declare namespace Models {
|
|
|
9453
9472
|
*/
|
|
9454
9473
|
baa: boolean;
|
|
9455
9474
|
};
|
|
9456
|
-
/**
|
|
9457
|
-
* BillingLimits
|
|
9458
|
-
*/
|
|
9459
|
-
export type BillingLimits = {
|
|
9460
|
-
/**
|
|
9461
|
-
* Bandwidth limit
|
|
9462
|
-
*/
|
|
9463
|
-
bandwidth: number;
|
|
9464
|
-
/**
|
|
9465
|
-
* Storage limit
|
|
9466
|
-
*/
|
|
9467
|
-
storage: number;
|
|
9468
|
-
/**
|
|
9469
|
-
* Users limit
|
|
9470
|
-
*/
|
|
9471
|
-
users: number;
|
|
9472
|
-
/**
|
|
9473
|
-
* Executions limit
|
|
9474
|
-
*/
|
|
9475
|
-
executions: number;
|
|
9476
|
-
/**
|
|
9477
|
-
* GBHours limit
|
|
9478
|
-
*/
|
|
9479
|
-
GBHours: number;
|
|
9480
|
-
/**
|
|
9481
|
-
* Image transformations limit
|
|
9482
|
-
*/
|
|
9483
|
-
imageTransformations: number;
|
|
9484
|
-
/**
|
|
9485
|
-
* Auth phone limit
|
|
9486
|
-
*/
|
|
9487
|
-
authPhone: number;
|
|
9488
|
-
/**
|
|
9489
|
-
* Budget limit percentage
|
|
9490
|
-
*/
|
|
9491
|
-
budgetLimit: number;
|
|
9492
|
-
};
|
|
9493
9475
|
/**
|
|
9494
9476
|
* Block
|
|
9495
9477
|
*/
|
|
@@ -9601,47 +9583,6 @@ export declare namespace Models {
|
|
|
9601
9583
|
*/
|
|
9602
9584
|
footer?: boolean;
|
|
9603
9585
|
};
|
|
9604
|
-
/**
|
|
9605
|
-
* Program
|
|
9606
|
-
*/
|
|
9607
|
-
export type Program = {
|
|
9608
|
-
/**
|
|
9609
|
-
* Program ID
|
|
9610
|
-
*/
|
|
9611
|
-
$id: string;
|
|
9612
|
-
/**
|
|
9613
|
-
* Program title
|
|
9614
|
-
*/
|
|
9615
|
-
title: string;
|
|
9616
|
-
/**
|
|
9617
|
-
* Program description
|
|
9618
|
-
*/
|
|
9619
|
-
description: string;
|
|
9620
|
-
/**
|
|
9621
|
-
* Program tag for highlighting on console
|
|
9622
|
-
*/
|
|
9623
|
-
tag: string;
|
|
9624
|
-
/**
|
|
9625
|
-
* Program icon for highlighting on console
|
|
9626
|
-
*/
|
|
9627
|
-
icon: string;
|
|
9628
|
-
/**
|
|
9629
|
-
* URL for more information on this program
|
|
9630
|
-
*/
|
|
9631
|
-
url: string;
|
|
9632
|
-
/**
|
|
9633
|
-
* Whether this program is active
|
|
9634
|
-
*/
|
|
9635
|
-
active: boolean;
|
|
9636
|
-
/**
|
|
9637
|
-
* Whether this program is external
|
|
9638
|
-
*/
|
|
9639
|
-
external: boolean;
|
|
9640
|
-
/**
|
|
9641
|
-
* Billing plan ID that this is program is associated with.
|
|
9642
|
-
*/
|
|
9643
|
-
billingPlanId: string;
|
|
9644
|
-
};
|
|
9645
9586
|
/**
|
|
9646
9587
|
* Coupon
|
|
9647
9588
|
*/
|
|
@@ -9755,1433 +9696,1449 @@ export declare namespace Models {
|
|
|
9755
9696
|
available: number;
|
|
9756
9697
|
};
|
|
9757
9698
|
/**
|
|
9758
|
-
*
|
|
9699
|
+
* DNSRecord
|
|
9759
9700
|
*/
|
|
9760
|
-
export type
|
|
9701
|
+
export type DnsRecord = {
|
|
9761
9702
|
/**
|
|
9762
|
-
*
|
|
9703
|
+
* DNS Record ID.
|
|
9763
9704
|
*/
|
|
9764
9705
|
$id: string;
|
|
9765
9706
|
/**
|
|
9766
|
-
*
|
|
9707
|
+
* DNS Record creation time in ISO 8601 format.
|
|
9767
9708
|
*/
|
|
9768
9709
|
$createdAt: string;
|
|
9769
9710
|
/**
|
|
9770
|
-
*
|
|
9711
|
+
* DNS Record update date in ISO 8601 format.
|
|
9771
9712
|
*/
|
|
9772
9713
|
$updatedAt: string;
|
|
9773
9714
|
/**
|
|
9774
|
-
*
|
|
9715
|
+
* DNS record type (e.g. A, CNAME, MX).
|
|
9775
9716
|
*/
|
|
9776
|
-
|
|
9717
|
+
type: string;
|
|
9777
9718
|
/**
|
|
9778
|
-
*
|
|
9719
|
+
* Record name or subdomain.
|
|
9779
9720
|
*/
|
|
9780
|
-
|
|
9721
|
+
name: string;
|
|
9781
9722
|
/**
|
|
9782
|
-
*
|
|
9723
|
+
* Value of the record (IP address, domain, etc.).
|
|
9783
9724
|
*/
|
|
9784
|
-
|
|
9725
|
+
value: string;
|
|
9785
9726
|
/**
|
|
9786
|
-
*
|
|
9727
|
+
* Time to live (in seconds).
|
|
9787
9728
|
*/
|
|
9788
|
-
|
|
9729
|
+
ttl: number;
|
|
9789
9730
|
/**
|
|
9790
|
-
*
|
|
9731
|
+
* Record priority (commonly used for MX).
|
|
9791
9732
|
*/
|
|
9792
|
-
|
|
9733
|
+
priority: number;
|
|
9793
9734
|
/**
|
|
9794
|
-
*
|
|
9735
|
+
* Whether this record is locked (read-only).
|
|
9795
9736
|
*/
|
|
9796
|
-
|
|
9737
|
+
lock: boolean;
|
|
9797
9738
|
/**
|
|
9798
|
-
*
|
|
9739
|
+
* Record weight (used for SRV records).
|
|
9799
9740
|
*/
|
|
9800
|
-
|
|
9741
|
+
weight: number;
|
|
9742
|
+
/**
|
|
9743
|
+
* Target port (used for SRV records).
|
|
9744
|
+
*/
|
|
9745
|
+
port: number;
|
|
9746
|
+
/**
|
|
9747
|
+
* Comment for the DNS record.
|
|
9748
|
+
*/
|
|
9749
|
+
comment: string;
|
|
9801
9750
|
};
|
|
9802
9751
|
/**
|
|
9803
|
-
*
|
|
9752
|
+
* Domain
|
|
9804
9753
|
*/
|
|
9805
|
-
export type
|
|
9754
|
+
export type Domain = {
|
|
9806
9755
|
/**
|
|
9807
|
-
*
|
|
9756
|
+
* Domain ID.
|
|
9808
9757
|
*/
|
|
9809
9758
|
$id: string;
|
|
9810
9759
|
/**
|
|
9811
|
-
*
|
|
9760
|
+
* Domain creation time in ISO 8601 format.
|
|
9812
9761
|
*/
|
|
9813
9762
|
$createdAt: string;
|
|
9814
9763
|
/**
|
|
9815
|
-
*
|
|
9764
|
+
* Domain update date in ISO 8601 format.
|
|
9816
9765
|
*/
|
|
9817
9766
|
$updatedAt: string;
|
|
9818
9767
|
/**
|
|
9819
|
-
*
|
|
9820
|
-
*/
|
|
9821
|
-
$permissions: string[];
|
|
9822
|
-
/**
|
|
9823
|
-
* Project ID
|
|
9824
|
-
*/
|
|
9825
|
-
teamId: string;
|
|
9826
|
-
/**
|
|
9827
|
-
* Aggregation ID
|
|
9828
|
-
*/
|
|
9829
|
-
aggregationId: string;
|
|
9830
|
-
/**
|
|
9831
|
-
* Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.
|
|
9832
|
-
*/
|
|
9833
|
-
plan: string;
|
|
9834
|
-
/**
|
|
9835
|
-
* Usage breakdown per resource
|
|
9768
|
+
* Domain name.
|
|
9836
9769
|
*/
|
|
9837
|
-
|
|
9770
|
+
domain: string;
|
|
9838
9771
|
/**
|
|
9839
|
-
*
|
|
9772
|
+
* Domain registrar (e.g. "appwrite" or "third_party").
|
|
9840
9773
|
*/
|
|
9841
|
-
|
|
9774
|
+
registrar: string;
|
|
9842
9775
|
/**
|
|
9843
|
-
*
|
|
9776
|
+
* Nameservers setting. "Appwrite" or empty string.
|
|
9844
9777
|
*/
|
|
9845
|
-
|
|
9778
|
+
nameservers: string;
|
|
9846
9779
|
/**
|
|
9847
|
-
*
|
|
9780
|
+
* Domain expiry date in ISO 8601 format.
|
|
9848
9781
|
*/
|
|
9849
|
-
|
|
9782
|
+
expire: string;
|
|
9850
9783
|
/**
|
|
9851
|
-
*
|
|
9784
|
+
* Domain renewal date in ISO 8601 format.
|
|
9852
9785
|
*/
|
|
9853
|
-
|
|
9786
|
+
renewal: string;
|
|
9854
9787
|
/**
|
|
9855
|
-
*
|
|
9788
|
+
* If set to true, the domain will automatically renew.
|
|
9856
9789
|
*/
|
|
9857
|
-
|
|
9790
|
+
autoRenewal: boolean;
|
|
9858
9791
|
/**
|
|
9859
|
-
*
|
|
9792
|
+
* Renewal price (in cents).
|
|
9860
9793
|
*/
|
|
9861
|
-
|
|
9794
|
+
renewalPrice: number;
|
|
9862
9795
|
/**
|
|
9863
|
-
*
|
|
9796
|
+
* Transfer status for domains being transferred in.
|
|
9864
9797
|
*/
|
|
9865
|
-
|
|
9798
|
+
transferStatus: DomainTransferStatusEnum;
|
|
9866
9799
|
/**
|
|
9867
|
-
*
|
|
9800
|
+
* Team ID.
|
|
9868
9801
|
*/
|
|
9869
|
-
|
|
9802
|
+
teamId: string;
|
|
9870
9803
|
/**
|
|
9871
|
-
*
|
|
9804
|
+
* Dns records
|
|
9872
9805
|
*/
|
|
9873
|
-
|
|
9806
|
+
dnsRecords: DnsRecord[];
|
|
9807
|
+
};
|
|
9808
|
+
/**
|
|
9809
|
+
* DomainPrice
|
|
9810
|
+
*/
|
|
9811
|
+
export type DomainPrice = {
|
|
9874
9812
|
/**
|
|
9875
|
-
*
|
|
9813
|
+
* Domain name.
|
|
9876
9814
|
*/
|
|
9877
|
-
|
|
9815
|
+
domain: string;
|
|
9878
9816
|
/**
|
|
9879
|
-
*
|
|
9817
|
+
* Top-level domain for the requested domain.
|
|
9880
9818
|
*/
|
|
9881
|
-
|
|
9819
|
+
tld: string;
|
|
9882
9820
|
/**
|
|
9883
|
-
*
|
|
9821
|
+
* Whether the domain is currently available for registration.
|
|
9884
9822
|
*/
|
|
9885
|
-
|
|
9823
|
+
available: boolean;
|
|
9886
9824
|
/**
|
|
9887
|
-
*
|
|
9825
|
+
* Domain registration price.
|
|
9888
9826
|
*/
|
|
9889
|
-
|
|
9827
|
+
price: number;
|
|
9890
9828
|
/**
|
|
9891
|
-
*
|
|
9829
|
+
* Price period in years.
|
|
9892
9830
|
*/
|
|
9893
|
-
|
|
9831
|
+
periodYears: number;
|
|
9894
9832
|
/**
|
|
9895
|
-
*
|
|
9833
|
+
* Whether the domain is a premium domain.
|
|
9896
9834
|
*/
|
|
9897
|
-
|
|
9835
|
+
premium: boolean;
|
|
9898
9836
|
};
|
|
9899
9837
|
/**
|
|
9900
|
-
*
|
|
9838
|
+
* DomainPurchase
|
|
9901
9839
|
*/
|
|
9902
|
-
export type
|
|
9840
|
+
export type DomainPurchase = {
|
|
9903
9841
|
/**
|
|
9904
|
-
*
|
|
9842
|
+
* Purchase/invoice ID.
|
|
9905
9843
|
*/
|
|
9906
9844
|
$id: string;
|
|
9907
9845
|
/**
|
|
9908
|
-
*
|
|
9846
|
+
* Purchase creation time in ISO 8601 format.
|
|
9909
9847
|
*/
|
|
9910
9848
|
$createdAt: string;
|
|
9911
9849
|
/**
|
|
9912
|
-
*
|
|
9850
|
+
* Purchase update date in ISO 8601 format.
|
|
9913
9851
|
*/
|
|
9914
9852
|
$updatedAt: string;
|
|
9915
9853
|
/**
|
|
9916
|
-
*
|
|
9854
|
+
* Domain document ID.
|
|
9917
9855
|
*/
|
|
9918
|
-
|
|
9856
|
+
domainId: string;
|
|
9919
9857
|
/**
|
|
9920
|
-
*
|
|
9858
|
+
* Domain name.
|
|
9921
9859
|
*/
|
|
9922
|
-
|
|
9860
|
+
domain: string;
|
|
9923
9861
|
/**
|
|
9924
|
-
* Team
|
|
9862
|
+
* Team ID that owns the domain.
|
|
9925
9863
|
*/
|
|
9926
|
-
|
|
9864
|
+
organizationId: string;
|
|
9927
9865
|
/**
|
|
9928
|
-
*
|
|
9866
|
+
* Domain purchase status.
|
|
9929
9867
|
*/
|
|
9930
|
-
|
|
9868
|
+
status: DomainPurchaseStatus;
|
|
9931
9869
|
/**
|
|
9932
|
-
*
|
|
9870
|
+
* Stripe client secret for 3DS; empty when not applicable.
|
|
9933
9871
|
*/
|
|
9934
|
-
|
|
9872
|
+
clientSecret: string;
|
|
9935
9873
|
/**
|
|
9936
|
-
*
|
|
9874
|
+
* Purchase amount.
|
|
9937
9875
|
*/
|
|
9938
|
-
|
|
9876
|
+
amount: number;
|
|
9939
9877
|
/**
|
|
9940
|
-
*
|
|
9878
|
+
* Currency code.
|
|
9941
9879
|
*/
|
|
9942
|
-
|
|
9880
|
+
currency: string;
|
|
9881
|
+
};
|
|
9882
|
+
/**
|
|
9883
|
+
* DomainSuggestion
|
|
9884
|
+
*/
|
|
9885
|
+
export type DomainSuggestion = {
|
|
9943
9886
|
/**
|
|
9944
|
-
*
|
|
9887
|
+
* Domain suggestion.
|
|
9945
9888
|
*/
|
|
9946
|
-
|
|
9889
|
+
domain: string;
|
|
9947
9890
|
/**
|
|
9948
|
-
*
|
|
9891
|
+
* Is the domain premium?
|
|
9949
9892
|
*/
|
|
9950
|
-
|
|
9893
|
+
premium: boolean;
|
|
9951
9894
|
/**
|
|
9952
|
-
*
|
|
9895
|
+
* Domain price.
|
|
9953
9896
|
*/
|
|
9954
|
-
|
|
9897
|
+
price?: number;
|
|
9955
9898
|
/**
|
|
9956
|
-
*
|
|
9899
|
+
* Is the domain available?
|
|
9957
9900
|
*/
|
|
9958
|
-
|
|
9901
|
+
available: boolean;
|
|
9902
|
+
};
|
|
9903
|
+
/**
|
|
9904
|
+
* domainTransferOut
|
|
9905
|
+
*/
|
|
9906
|
+
export type DomainTransferOut = {
|
|
9959
9907
|
/**
|
|
9960
|
-
*
|
|
9908
|
+
* Domain transfer authorization code.
|
|
9961
9909
|
*/
|
|
9962
|
-
|
|
9910
|
+
authCode: string;
|
|
9911
|
+
};
|
|
9912
|
+
/**
|
|
9913
|
+
* domainTransferStatus
|
|
9914
|
+
*/
|
|
9915
|
+
export type DomainTransferStatus = {
|
|
9963
9916
|
/**
|
|
9964
|
-
*
|
|
9917
|
+
* Transfer status.
|
|
9965
9918
|
*/
|
|
9966
|
-
|
|
9919
|
+
status: DomainTransferStatusEnum;
|
|
9967
9920
|
/**
|
|
9968
|
-
*
|
|
9921
|
+
* Additional transfer status information.
|
|
9969
9922
|
*/
|
|
9970
|
-
|
|
9923
|
+
reason: string;
|
|
9971
9924
|
/**
|
|
9972
|
-
*
|
|
9925
|
+
* Transfer status timestamp in ISO 8601 format.
|
|
9973
9926
|
*/
|
|
9974
|
-
|
|
9927
|
+
timestamp: string;
|
|
9928
|
+
};
|
|
9929
|
+
/**
|
|
9930
|
+
* Downgrade Feedback
|
|
9931
|
+
*/
|
|
9932
|
+
export type DowngradeFeedback = {
|
|
9975
9933
|
/**
|
|
9976
|
-
*
|
|
9934
|
+
* Feedback ID.
|
|
9977
9935
|
*/
|
|
9978
|
-
|
|
9936
|
+
$id: string;
|
|
9979
9937
|
/**
|
|
9980
|
-
*
|
|
9938
|
+
* Feedback creation date in ISO 8601 format.
|
|
9981
9939
|
*/
|
|
9982
|
-
|
|
9940
|
+
$createdAt: string;
|
|
9983
9941
|
/**
|
|
9984
|
-
*
|
|
9942
|
+
* Feedback update date in ISO 8601 format.
|
|
9985
9943
|
*/
|
|
9986
|
-
|
|
9944
|
+
$updatedAt: string;
|
|
9987
9945
|
/**
|
|
9988
|
-
*
|
|
9946
|
+
* Feedback reason
|
|
9989
9947
|
*/
|
|
9990
|
-
|
|
9948
|
+
title: string;
|
|
9991
9949
|
/**
|
|
9992
|
-
*
|
|
9950
|
+
* Feedback message
|
|
9993
9951
|
*/
|
|
9994
|
-
|
|
9952
|
+
message: string;
|
|
9995
9953
|
/**
|
|
9996
|
-
*
|
|
9954
|
+
* Plan ID downgrading from
|
|
9997
9955
|
*/
|
|
9998
|
-
|
|
9956
|
+
fromPlanId: string;
|
|
9999
9957
|
/**
|
|
10000
|
-
*
|
|
9958
|
+
* Plan ID downgrading to
|
|
10001
9959
|
*/
|
|
10002
|
-
|
|
9960
|
+
toPlanId: string;
|
|
10003
9961
|
/**
|
|
10004
|
-
*
|
|
9962
|
+
* Organization ID
|
|
10005
9963
|
*/
|
|
10006
|
-
|
|
9964
|
+
teamId: string;
|
|
10007
9965
|
/**
|
|
10008
|
-
*
|
|
9966
|
+
* User ID who submitted feedback
|
|
10009
9967
|
*/
|
|
10010
|
-
|
|
9968
|
+
userId: string;
|
|
10011
9969
|
/**
|
|
10012
|
-
*
|
|
9970
|
+
* Console version
|
|
10013
9971
|
*/
|
|
10014
|
-
|
|
10015
|
-
|
|
10016
|
-
|
|
10017
|
-
|
|
10018
|
-
|
|
9972
|
+
version: string;
|
|
9973
|
+
};
|
|
9974
|
+
/**
|
|
9975
|
+
* Estimation
|
|
9976
|
+
*/
|
|
9977
|
+
export type Estimation = {
|
|
10019
9978
|
/**
|
|
10020
|
-
*
|
|
9979
|
+
* Total amount
|
|
10021
9980
|
*/
|
|
10022
|
-
|
|
9981
|
+
amount: number;
|
|
10023
9982
|
/**
|
|
10024
|
-
*
|
|
9983
|
+
* Gross payable amount
|
|
10025
9984
|
*/
|
|
10026
|
-
|
|
9985
|
+
grossAmount: number;
|
|
10027
9986
|
/**
|
|
10028
|
-
*
|
|
9987
|
+
* Discount amount
|
|
10029
9988
|
*/
|
|
10030
|
-
|
|
9989
|
+
discount: number;
|
|
10031
9990
|
/**
|
|
10032
|
-
*
|
|
9991
|
+
* Credits amount
|
|
10033
9992
|
*/
|
|
10034
|
-
|
|
9993
|
+
credits: number;
|
|
10035
9994
|
/**
|
|
10036
|
-
*
|
|
9995
|
+
* Estimation items
|
|
10037
9996
|
*/
|
|
10038
|
-
|
|
9997
|
+
items: EstimationItem[];
|
|
10039
9998
|
/**
|
|
10040
|
-
*
|
|
9999
|
+
* Estimation discount items
|
|
10041
10000
|
*/
|
|
10042
|
-
|
|
10043
|
-
};
|
|
10044
|
-
/**
|
|
10045
|
-
* PaymentAuthentication
|
|
10046
|
-
*/
|
|
10047
|
-
export type PaymentAuthentication = {
|
|
10001
|
+
discounts: EstimationItem[];
|
|
10048
10002
|
/**
|
|
10049
|
-
*
|
|
10003
|
+
* Trial days
|
|
10050
10004
|
*/
|
|
10051
|
-
|
|
10005
|
+
trialDays: number;
|
|
10052
10006
|
/**
|
|
10053
|
-
*
|
|
10007
|
+
* Trial end date
|
|
10054
10008
|
*/
|
|
10055
|
-
|
|
10009
|
+
trialEndDate?: string;
|
|
10010
|
+
};
|
|
10011
|
+
/**
|
|
10012
|
+
* DeleteOrganization
|
|
10013
|
+
*/
|
|
10014
|
+
export type EstimationDeleteOrganization = {
|
|
10056
10015
|
/**
|
|
10057
|
-
*
|
|
10016
|
+
* List of unpaid invoices
|
|
10058
10017
|
*/
|
|
10059
|
-
|
|
10018
|
+
unpaidInvoices: Invoice[];
|
|
10019
|
+
};
|
|
10020
|
+
/**
|
|
10021
|
+
* Item
|
|
10022
|
+
*/
|
|
10023
|
+
export type EstimationItem = {
|
|
10060
10024
|
/**
|
|
10061
|
-
*
|
|
10025
|
+
* Label
|
|
10062
10026
|
*/
|
|
10063
|
-
|
|
10027
|
+
label: string;
|
|
10064
10028
|
/**
|
|
10065
|
-
*
|
|
10029
|
+
* Gross payable amount
|
|
10066
10030
|
*/
|
|
10067
|
-
|
|
10031
|
+
value: number;
|
|
10068
10032
|
};
|
|
10069
10033
|
/**
|
|
10070
|
-
*
|
|
10034
|
+
* EstimationPlanChange
|
|
10071
10035
|
*/
|
|
10072
|
-
export type
|
|
10036
|
+
export type EstimationPlanChange = {
|
|
10073
10037
|
/**
|
|
10074
|
-
*
|
|
10038
|
+
* Current billing plan ID
|
|
10075
10039
|
*/
|
|
10076
|
-
|
|
10040
|
+
currentBillingPlanId: string;
|
|
10077
10041
|
/**
|
|
10078
|
-
*
|
|
10042
|
+
* Target billing plan ID
|
|
10079
10043
|
*/
|
|
10080
|
-
|
|
10044
|
+
targetBillingPlanId: string;
|
|
10081
10045
|
/**
|
|
10082
|
-
*
|
|
10046
|
+
* Direction of plan change: upgrade, downgrade, or same
|
|
10083
10047
|
*/
|
|
10084
|
-
|
|
10048
|
+
direction: string;
|
|
10085
10049
|
/**
|
|
10086
|
-
*
|
|
10050
|
+
* Cost estimation details
|
|
10087
10051
|
*/
|
|
10088
|
-
|
|
10052
|
+
estimation: PlanChangeEstimationDetails;
|
|
10089
10053
|
/**
|
|
10090
|
-
*
|
|
10054
|
+
* Plan limits and compliance information
|
|
10091
10055
|
*/
|
|
10092
|
-
|
|
10056
|
+
limits: PlanChangeLimits;
|
|
10057
|
+
};
|
|
10058
|
+
/**
|
|
10059
|
+
* UpdatePlan
|
|
10060
|
+
*/
|
|
10061
|
+
export type EstimationUpdatePlan = {
|
|
10093
10062
|
/**
|
|
10094
|
-
*
|
|
10063
|
+
* Total amount
|
|
10095
10064
|
*/
|
|
10096
|
-
|
|
10065
|
+
amount: number;
|
|
10097
10066
|
/**
|
|
10098
|
-
*
|
|
10067
|
+
* Gross payable amount
|
|
10099
10068
|
*/
|
|
10100
|
-
|
|
10069
|
+
grossAmount: number;
|
|
10101
10070
|
/**
|
|
10102
|
-
*
|
|
10071
|
+
* Discount amount
|
|
10103
10072
|
*/
|
|
10104
|
-
|
|
10073
|
+
discount: number;
|
|
10105
10074
|
/**
|
|
10106
|
-
*
|
|
10075
|
+
* Credits amount
|
|
10107
10076
|
*/
|
|
10108
|
-
|
|
10077
|
+
credits: number;
|
|
10109
10078
|
/**
|
|
10110
|
-
*
|
|
10079
|
+
* Estimation items
|
|
10111
10080
|
*/
|
|
10112
|
-
|
|
10081
|
+
items: EstimationItem[];
|
|
10113
10082
|
/**
|
|
10114
|
-
*
|
|
10083
|
+
* Estimation discount items
|
|
10115
10084
|
*/
|
|
10116
|
-
|
|
10085
|
+
discounts: EstimationItem[];
|
|
10117
10086
|
/**
|
|
10118
|
-
*
|
|
10087
|
+
* Trial days
|
|
10119
10088
|
*/
|
|
10120
|
-
|
|
10089
|
+
trialDays: number;
|
|
10121
10090
|
/**
|
|
10122
|
-
*
|
|
10091
|
+
* Trial end date
|
|
10123
10092
|
*/
|
|
10124
|
-
|
|
10093
|
+
trialEndDate?: string;
|
|
10125
10094
|
/**
|
|
10126
|
-
*
|
|
10095
|
+
* Organization's existing credits
|
|
10127
10096
|
*/
|
|
10128
|
-
|
|
10097
|
+
organizationCredits: number;
|
|
10098
|
+
};
|
|
10099
|
+
/**
|
|
10100
|
+
* Invoice
|
|
10101
|
+
*/
|
|
10102
|
+
export type Invoice = {
|
|
10129
10103
|
/**
|
|
10130
|
-
*
|
|
10104
|
+
* Invoice ID.
|
|
10131
10105
|
*/
|
|
10132
|
-
|
|
10106
|
+
$id: string;
|
|
10133
10107
|
/**
|
|
10134
|
-
*
|
|
10108
|
+
* Invoice creation time in ISO 8601 format.
|
|
10135
10109
|
*/
|
|
10136
|
-
|
|
10110
|
+
$createdAt: string;
|
|
10137
10111
|
/**
|
|
10138
|
-
*
|
|
10112
|
+
* Invoice update date in ISO 8601 format.
|
|
10139
10113
|
*/
|
|
10140
|
-
|
|
10114
|
+
$updatedAt: string;
|
|
10141
10115
|
/**
|
|
10142
|
-
*
|
|
10116
|
+
* Invoice permissions. [Learn more about permissions](/docs/permissions).
|
|
10143
10117
|
*/
|
|
10144
|
-
|
|
10118
|
+
$permissions: string[];
|
|
10145
10119
|
/**
|
|
10146
|
-
*
|
|
10120
|
+
* Project ID
|
|
10147
10121
|
*/
|
|
10148
|
-
|
|
10122
|
+
teamId: string;
|
|
10149
10123
|
/**
|
|
10150
|
-
*
|
|
10124
|
+
* Aggregation ID
|
|
10151
10125
|
*/
|
|
10152
|
-
|
|
10153
|
-
};
|
|
10154
|
-
/**
|
|
10155
|
-
* backup
|
|
10156
|
-
*/
|
|
10157
|
-
export type BackupPolicy = {
|
|
10126
|
+
aggregationId: string;
|
|
10158
10127
|
/**
|
|
10159
|
-
*
|
|
10128
|
+
* Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.
|
|
10160
10129
|
*/
|
|
10161
|
-
|
|
10130
|
+
plan: string;
|
|
10162
10131
|
/**
|
|
10163
|
-
*
|
|
10132
|
+
* Usage breakdown per resource
|
|
10164
10133
|
*/
|
|
10165
|
-
|
|
10134
|
+
usage: UsageResources[];
|
|
10166
10135
|
/**
|
|
10167
|
-
*
|
|
10136
|
+
* Invoice Amount
|
|
10168
10137
|
*/
|
|
10169
|
-
|
|
10138
|
+
amount: number;
|
|
10170
10139
|
/**
|
|
10171
|
-
*
|
|
10140
|
+
* Tax percentage
|
|
10172
10141
|
*/
|
|
10173
|
-
|
|
10142
|
+
tax: number;
|
|
10174
10143
|
/**
|
|
10175
|
-
*
|
|
10144
|
+
* Tax amount
|
|
10176
10145
|
*/
|
|
10177
|
-
|
|
10146
|
+
taxAmount: number;
|
|
10178
10147
|
/**
|
|
10179
|
-
*
|
|
10148
|
+
* VAT percentage
|
|
10180
10149
|
*/
|
|
10181
|
-
|
|
10150
|
+
vat: number;
|
|
10182
10151
|
/**
|
|
10183
|
-
*
|
|
10152
|
+
* VAT amount
|
|
10184
10153
|
*/
|
|
10185
|
-
|
|
10154
|
+
vatAmount: number;
|
|
10186
10155
|
/**
|
|
10187
|
-
*
|
|
10156
|
+
* Gross amount after vat, tax, and discounts applied.
|
|
10188
10157
|
*/
|
|
10189
|
-
|
|
10158
|
+
grossAmount: number;
|
|
10190
10159
|
/**
|
|
10191
|
-
*
|
|
10160
|
+
* Credits used.
|
|
10192
10161
|
*/
|
|
10193
|
-
|
|
10162
|
+
creditsUsed: number;
|
|
10194
10163
|
/**
|
|
10195
|
-
*
|
|
10164
|
+
* Currency the invoice is in
|
|
10196
10165
|
*/
|
|
10197
|
-
|
|
10166
|
+
currency: string;
|
|
10198
10167
|
/**
|
|
10199
|
-
*
|
|
10168
|
+
* Client secret for processing failed payments in front-end
|
|
10200
10169
|
*/
|
|
10201
|
-
|
|
10202
|
-
};
|
|
10203
|
-
/**
|
|
10204
|
-
* Region
|
|
10205
|
-
*/
|
|
10206
|
-
export type ConsoleRegion = {
|
|
10170
|
+
clientSecret: string;
|
|
10207
10171
|
/**
|
|
10208
|
-
*
|
|
10172
|
+
* Invoice status
|
|
10209
10173
|
*/
|
|
10210
|
-
|
|
10174
|
+
status: string;
|
|
10211
10175
|
/**
|
|
10212
|
-
*
|
|
10176
|
+
* Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.
|
|
10213
10177
|
*/
|
|
10214
|
-
|
|
10178
|
+
type: string;
|
|
10215
10179
|
/**
|
|
10216
|
-
*
|
|
10180
|
+
* Last payment error associated with the invoice
|
|
10217
10181
|
*/
|
|
10218
|
-
|
|
10182
|
+
lastError: string;
|
|
10219
10183
|
/**
|
|
10220
|
-
*
|
|
10184
|
+
* Invoice due date.
|
|
10221
10185
|
*/
|
|
10222
|
-
|
|
10186
|
+
dueAt: string;
|
|
10223
10187
|
/**
|
|
10224
|
-
*
|
|
10188
|
+
* Beginning date of the invoice
|
|
10225
10189
|
*/
|
|
10226
|
-
|
|
10190
|
+
from: string;
|
|
10227
10191
|
/**
|
|
10228
|
-
*
|
|
10192
|
+
* End date of the invoice
|
|
10229
10193
|
*/
|
|
10230
|
-
|
|
10194
|
+
to: string;
|
|
10231
10195
|
};
|
|
10232
10196
|
/**
|
|
10233
|
-
*
|
|
10197
|
+
* Organization
|
|
10234
10198
|
*/
|
|
10235
|
-
export type
|
|
10199
|
+
export type Organization<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
10236
10200
|
/**
|
|
10237
|
-
*
|
|
10201
|
+
* Team ID.
|
|
10238
10202
|
*/
|
|
10239
10203
|
$id: string;
|
|
10240
10204
|
/**
|
|
10241
|
-
*
|
|
10205
|
+
* Team creation date in ISO 8601 format.
|
|
10242
10206
|
*/
|
|
10243
10207
|
$createdAt: string;
|
|
10244
10208
|
/**
|
|
10245
|
-
*
|
|
10209
|
+
* Team update date in ISO 8601 format.
|
|
10246
10210
|
*/
|
|
10247
10211
|
$updatedAt: string;
|
|
10248
10212
|
/**
|
|
10249
|
-
*
|
|
10213
|
+
* Team name.
|
|
10250
10214
|
*/
|
|
10251
|
-
|
|
10215
|
+
name: string;
|
|
10252
10216
|
/**
|
|
10253
|
-
*
|
|
10217
|
+
* Total number of team members.
|
|
10254
10218
|
*/
|
|
10255
|
-
|
|
10219
|
+
total: number;
|
|
10256
10220
|
/**
|
|
10257
|
-
*
|
|
10221
|
+
* Team preferences as a key-value object
|
|
10258
10222
|
*/
|
|
10259
|
-
|
|
10260
|
-
/**
|
|
10261
|
-
* The backup start time.
|
|
10262
|
-
*/
|
|
10263
|
-
startedAt: string;
|
|
10223
|
+
prefs: Preferences;
|
|
10264
10224
|
/**
|
|
10265
|
-
*
|
|
10225
|
+
* Project budget limit
|
|
10266
10226
|
*/
|
|
10267
|
-
|
|
10227
|
+
billingBudget: number;
|
|
10268
10228
|
/**
|
|
10269
|
-
*
|
|
10229
|
+
* Project budget limit
|
|
10270
10230
|
*/
|
|
10271
|
-
|
|
10231
|
+
budgetAlerts: number[];
|
|
10272
10232
|
/**
|
|
10273
|
-
*
|
|
10233
|
+
* Organization's billing plan ID.
|
|
10274
10234
|
*/
|
|
10275
|
-
|
|
10235
|
+
billingPlan: string;
|
|
10276
10236
|
/**
|
|
10277
|
-
*
|
|
10237
|
+
* Organization's billing plan ID.
|
|
10278
10238
|
*/
|
|
10279
|
-
|
|
10280
|
-
};
|
|
10281
|
-
/**
|
|
10282
|
-
* Review
|
|
10283
|
-
*/
|
|
10284
|
-
export type Review = {
|
|
10239
|
+
billingPlanId: string;
|
|
10285
10240
|
/**
|
|
10286
|
-
*
|
|
10241
|
+
* Organization's billing plan.
|
|
10287
10242
|
*/
|
|
10288
|
-
|
|
10243
|
+
billingPlanDetails: BillingPlan;
|
|
10289
10244
|
/**
|
|
10290
|
-
*
|
|
10245
|
+
* Billing email set for the organization.
|
|
10291
10246
|
*/
|
|
10292
|
-
|
|
10247
|
+
billingEmail: string;
|
|
10293
10248
|
/**
|
|
10294
|
-
*
|
|
10249
|
+
* Billing cycle start date.
|
|
10295
10250
|
*/
|
|
10296
|
-
|
|
10251
|
+
billingStartDate: string;
|
|
10297
10252
|
/**
|
|
10298
|
-
*
|
|
10253
|
+
* Current invoice cycle start date.
|
|
10299
10254
|
*/
|
|
10300
|
-
|
|
10301
|
-
};
|
|
10302
|
-
/**
|
|
10303
|
-
* Roles
|
|
10304
|
-
*/
|
|
10305
|
-
export type Roles = {
|
|
10255
|
+
billingCurrentInvoiceDate: string;
|
|
10306
10256
|
/**
|
|
10307
|
-
*
|
|
10257
|
+
* Next invoice cycle start date.
|
|
10308
10258
|
*/
|
|
10309
|
-
|
|
10259
|
+
billingNextInvoiceDate: string;
|
|
10310
10260
|
/**
|
|
10311
|
-
*
|
|
10261
|
+
* Start date of trial.
|
|
10312
10262
|
*/
|
|
10313
|
-
|
|
10314
|
-
};
|
|
10315
|
-
/**
|
|
10316
|
-
* UsageOrganization
|
|
10317
|
-
*/
|
|
10318
|
-
export type UsageOrganization = {
|
|
10263
|
+
billingTrialStartDate: string;
|
|
10319
10264
|
/**
|
|
10320
|
-
*
|
|
10265
|
+
* Number of trial days.
|
|
10321
10266
|
*/
|
|
10322
|
-
|
|
10267
|
+
billingTrialDays: number;
|
|
10323
10268
|
/**
|
|
10324
|
-
*
|
|
10269
|
+
* Current active aggregation id.
|
|
10325
10270
|
*/
|
|
10326
|
-
|
|
10271
|
+
billingAggregationId: string;
|
|
10327
10272
|
/**
|
|
10328
|
-
*
|
|
10273
|
+
* Current active aggregation id.
|
|
10329
10274
|
*/
|
|
10330
|
-
|
|
10275
|
+
billingInvoiceId: string;
|
|
10331
10276
|
/**
|
|
10332
|
-
*
|
|
10277
|
+
* Default payment method.
|
|
10333
10278
|
*/
|
|
10334
|
-
|
|
10279
|
+
paymentMethodId: string;
|
|
10335
10280
|
/**
|
|
10336
|
-
*
|
|
10281
|
+
* Default payment method.
|
|
10337
10282
|
*/
|
|
10338
|
-
|
|
10283
|
+
billingAddressId: string;
|
|
10339
10284
|
/**
|
|
10340
|
-
*
|
|
10285
|
+
* Backup payment method.
|
|
10341
10286
|
*/
|
|
10342
|
-
|
|
10287
|
+
backupPaymentMethodId: string;
|
|
10343
10288
|
/**
|
|
10344
|
-
*
|
|
10289
|
+
* Team status.
|
|
10345
10290
|
*/
|
|
10346
|
-
|
|
10291
|
+
status: string;
|
|
10347
10292
|
/**
|
|
10348
|
-
*
|
|
10293
|
+
* Remarks on team status.
|
|
10349
10294
|
*/
|
|
10350
|
-
|
|
10295
|
+
remarks: string;
|
|
10351
10296
|
/**
|
|
10352
|
-
*
|
|
10297
|
+
* Organization agreements
|
|
10353
10298
|
*/
|
|
10354
|
-
|
|
10299
|
+
agreementBAA: string;
|
|
10355
10300
|
/**
|
|
10356
|
-
*
|
|
10301
|
+
* Program manager's name.
|
|
10357
10302
|
*/
|
|
10358
|
-
|
|
10303
|
+
programManagerName: string;
|
|
10359
10304
|
/**
|
|
10360
|
-
*
|
|
10305
|
+
* Program manager's calendar link.
|
|
10361
10306
|
*/
|
|
10362
|
-
|
|
10307
|
+
programManagerCalendar: string;
|
|
10363
10308
|
/**
|
|
10364
|
-
*
|
|
10309
|
+
* Program's discord channel name.
|
|
10365
10310
|
*/
|
|
10366
|
-
|
|
10311
|
+
programDiscordChannelName: string;
|
|
10367
10312
|
/**
|
|
10368
|
-
*
|
|
10313
|
+
* Program's discord channel URL.
|
|
10369
10314
|
*/
|
|
10370
|
-
|
|
10315
|
+
programDiscordChannelUrl: string;
|
|
10371
10316
|
/**
|
|
10372
|
-
*
|
|
10317
|
+
* Billing limits reached
|
|
10373
10318
|
*/
|
|
10374
|
-
|
|
10319
|
+
billingLimits?: BillingLimits;
|
|
10375
10320
|
/**
|
|
10376
|
-
*
|
|
10321
|
+
* Billing plan selected for downgrade.
|
|
10377
10322
|
*/
|
|
10378
|
-
|
|
10323
|
+
billingPlanDowngrade: string;
|
|
10379
10324
|
/**
|
|
10380
|
-
*
|
|
10325
|
+
* Tax Id
|
|
10381
10326
|
*/
|
|
10382
|
-
|
|
10327
|
+
billingTaxId: string;
|
|
10383
10328
|
/**
|
|
10384
|
-
*
|
|
10329
|
+
* Marked for deletion
|
|
10385
10330
|
*/
|
|
10386
|
-
|
|
10331
|
+
markedForDeletion: boolean;
|
|
10387
10332
|
/**
|
|
10388
|
-
*
|
|
10333
|
+
* Product with which the organization is associated (appwrite or imagine)
|
|
10389
10334
|
*/
|
|
10390
|
-
|
|
10335
|
+
platform: string;
|
|
10391
10336
|
/**
|
|
10392
|
-
*
|
|
10337
|
+
* Selected projects
|
|
10393
10338
|
*/
|
|
10394
|
-
|
|
10339
|
+
projects: string[];
|
|
10340
|
+
};
|
|
10341
|
+
/**
|
|
10342
|
+
* PaymentAuthentication
|
|
10343
|
+
*/
|
|
10344
|
+
export type PaymentAuthentication = {
|
|
10395
10345
|
/**
|
|
10396
|
-
*
|
|
10346
|
+
* Message for the end user to show on Console.
|
|
10397
10347
|
*/
|
|
10398
|
-
|
|
10348
|
+
message: string;
|
|
10399
10349
|
/**
|
|
10400
|
-
*
|
|
10350
|
+
* Stripe client secret to use for validation.
|
|
10401
10351
|
*/
|
|
10402
|
-
|
|
10352
|
+
clientSecret: string;
|
|
10403
10353
|
/**
|
|
10404
|
-
*
|
|
10354
|
+
* Organization ID for which the payment authentication is needed.
|
|
10405
10355
|
*/
|
|
10406
|
-
|
|
10356
|
+
organizationId: string;
|
|
10407
10357
|
/**
|
|
10408
|
-
*
|
|
10358
|
+
* Invoice ID against which the payment needs to be validated.
|
|
10409
10359
|
*/
|
|
10410
|
-
|
|
10360
|
+
invoiceId: string;
|
|
10411
10361
|
/**
|
|
10412
|
-
*
|
|
10362
|
+
* Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.
|
|
10413
10363
|
*/
|
|
10414
|
-
|
|
10364
|
+
addonId: string;
|
|
10365
|
+
};
|
|
10366
|
+
/**
|
|
10367
|
+
* paymentMethod
|
|
10368
|
+
*/
|
|
10369
|
+
export type PaymentMethod = {
|
|
10415
10370
|
/**
|
|
10416
|
-
*
|
|
10371
|
+
* Payment Method ID.
|
|
10417
10372
|
*/
|
|
10418
|
-
|
|
10373
|
+
$id: string;
|
|
10419
10374
|
/**
|
|
10420
|
-
*
|
|
10375
|
+
* Payment method creation time in ISO 8601 format.
|
|
10421
10376
|
*/
|
|
10422
|
-
|
|
10377
|
+
$createdAt: string;
|
|
10423
10378
|
/**
|
|
10424
|
-
*
|
|
10379
|
+
* Payment method update date in ISO 8601 format.
|
|
10425
10380
|
*/
|
|
10426
|
-
|
|
10381
|
+
$updatedAt: string;
|
|
10427
10382
|
/**
|
|
10428
|
-
*
|
|
10383
|
+
* Payment method permissions. [Learn more about permissions](/docs/permissions).
|
|
10429
10384
|
*/
|
|
10430
|
-
|
|
10385
|
+
$permissions: string[];
|
|
10431
10386
|
/**
|
|
10432
|
-
*
|
|
10387
|
+
* Payment method ID from the payment provider
|
|
10433
10388
|
*/
|
|
10434
|
-
|
|
10389
|
+
providerMethodId: string;
|
|
10435
10390
|
/**
|
|
10436
|
-
*
|
|
10391
|
+
* Client secret hash for payment setup
|
|
10437
10392
|
*/
|
|
10438
|
-
|
|
10393
|
+
clientSecret: string;
|
|
10439
10394
|
/**
|
|
10440
|
-
*
|
|
10395
|
+
* User ID from the payment provider.
|
|
10441
10396
|
*/
|
|
10442
|
-
|
|
10397
|
+
providerUserId: string;
|
|
10443
10398
|
/**
|
|
10444
|
-
*
|
|
10399
|
+
* ID of the Team.
|
|
10445
10400
|
*/
|
|
10446
|
-
|
|
10447
|
-
};
|
|
10448
|
-
/**
|
|
10449
|
-
* UsageOrganizationProject
|
|
10450
|
-
*/
|
|
10451
|
-
export type UsageOrganizationProject = {
|
|
10401
|
+
userId: string;
|
|
10452
10402
|
/**
|
|
10453
|
-
*
|
|
10403
|
+
* Expiry month of the payment method.
|
|
10454
10404
|
*/
|
|
10455
|
-
|
|
10405
|
+
expiryMonth: number;
|
|
10456
10406
|
/**
|
|
10457
|
-
*
|
|
10407
|
+
* Expiry year of the payment method.
|
|
10458
10408
|
*/
|
|
10459
|
-
|
|
10409
|
+
expiryYear: number;
|
|
10460
10410
|
/**
|
|
10461
|
-
*
|
|
10411
|
+
* Last 4 digit of the payment method
|
|
10462
10412
|
*/
|
|
10463
|
-
|
|
10413
|
+
last4: string;
|
|
10464
10414
|
/**
|
|
10465
|
-
*
|
|
10415
|
+
* Payment method brand
|
|
10466
10416
|
*/
|
|
10467
|
-
|
|
10417
|
+
brand: string;
|
|
10468
10418
|
/**
|
|
10469
|
-
*
|
|
10419
|
+
* Name of the owner
|
|
10470
10420
|
*/
|
|
10471
|
-
|
|
10421
|
+
name: string;
|
|
10472
10422
|
/**
|
|
10473
|
-
*
|
|
10423
|
+
* Mandate ID of the payment method
|
|
10474
10424
|
*/
|
|
10475
|
-
|
|
10425
|
+
mandateId: string;
|
|
10476
10426
|
/**
|
|
10477
|
-
*
|
|
10427
|
+
* Country of the payment method
|
|
10478
10428
|
*/
|
|
10479
|
-
|
|
10429
|
+
country: string;
|
|
10480
10430
|
/**
|
|
10481
|
-
*
|
|
10431
|
+
* State of the payment method
|
|
10482
10432
|
*/
|
|
10483
|
-
|
|
10433
|
+
state: string;
|
|
10484
10434
|
/**
|
|
10485
|
-
*
|
|
10435
|
+
* Last payment error associated with the payment method.
|
|
10486
10436
|
*/
|
|
10487
|
-
|
|
10437
|
+
lastError: string;
|
|
10488
10438
|
/**
|
|
10489
|
-
*
|
|
10439
|
+
* True when it's the default payment method.
|
|
10490
10440
|
*/
|
|
10491
|
-
|
|
10441
|
+
default: boolean;
|
|
10492
10442
|
/**
|
|
10493
|
-
*
|
|
10443
|
+
* True when payment method has expired.
|
|
10494
10444
|
*/
|
|
10495
|
-
|
|
10445
|
+
expired: boolean;
|
|
10496
10446
|
/**
|
|
10497
|
-
*
|
|
10447
|
+
* True when payment method has failed to process multiple times.
|
|
10498
10448
|
*/
|
|
10499
|
-
|
|
10449
|
+
failed: boolean;
|
|
10450
|
+
};
|
|
10451
|
+
/**
|
|
10452
|
+
* PlanChangeEstimationDetails
|
|
10453
|
+
*/
|
|
10454
|
+
export type PlanChangeEstimationDetails = {
|
|
10500
10455
|
/**
|
|
10501
|
-
*
|
|
10456
|
+
* Currency code
|
|
10502
10457
|
*/
|
|
10503
|
-
|
|
10458
|
+
currency: string;
|
|
10504
10459
|
/**
|
|
10505
|
-
*
|
|
10460
|
+
* Gross amount after all discounts and credits
|
|
10506
10461
|
*/
|
|
10507
|
-
|
|
10462
|
+
grossAmount: number;
|
|
10508
10463
|
/**
|
|
10509
|
-
*
|
|
10464
|
+
* Credits applied from coupon
|
|
10510
10465
|
*/
|
|
10511
|
-
|
|
10466
|
+
credits: number;
|
|
10512
10467
|
/**
|
|
10513
|
-
*
|
|
10468
|
+
* Organization's existing credits applied
|
|
10514
10469
|
*/
|
|
10515
|
-
|
|
10470
|
+
organizationCredits: number;
|
|
10516
10471
|
/**
|
|
10517
|
-
*
|
|
10472
|
+
* Discount amount from prorated invoices
|
|
10518
10473
|
*/
|
|
10519
|
-
|
|
10474
|
+
discount: number;
|
|
10520
10475
|
/**
|
|
10521
|
-
*
|
|
10476
|
+
* Total amount before discounts and credits
|
|
10522
10477
|
*/
|
|
10523
|
-
|
|
10478
|
+
amount: number;
|
|
10524
10479
|
/**
|
|
10525
|
-
*
|
|
10480
|
+
* Next invoice date
|
|
10526
10481
|
*/
|
|
10527
|
-
|
|
10482
|
+
nextInvoiceDate: string;
|
|
10528
10483
|
/**
|
|
10529
|
-
*
|
|
10484
|
+
* Line items breakdown
|
|
10530
10485
|
*/
|
|
10531
|
-
|
|
10486
|
+
items: object;
|
|
10532
10487
|
/**
|
|
10533
|
-
*
|
|
10488
|
+
* Applied discounts breakdown
|
|
10534
10489
|
*/
|
|
10535
|
-
|
|
10490
|
+
discounts: object;
|
|
10536
10491
|
};
|
|
10537
10492
|
/**
|
|
10538
|
-
*
|
|
10493
|
+
* PlanChangeLimits
|
|
10539
10494
|
*/
|
|
10540
|
-
export type
|
|
10495
|
+
export type PlanChangeLimits = {
|
|
10541
10496
|
/**
|
|
10542
|
-
*
|
|
10497
|
+
* Total number of projects in the organization
|
|
10543
10498
|
*/
|
|
10544
|
-
|
|
10499
|
+
totalProjects: number;
|
|
10545
10500
|
/**
|
|
10546
|
-
*
|
|
10501
|
+
* Number of projects exceeding target plan limits
|
|
10547
10502
|
*/
|
|
10548
|
-
|
|
10503
|
+
nonCompliantProjects: number;
|
|
10549
10504
|
/**
|
|
10550
|
-
*
|
|
10505
|
+
* Whether the plan change is allowed
|
|
10551
10506
|
*/
|
|
10552
|
-
|
|
10507
|
+
canChangePlan: boolean;
|
|
10508
|
+
/**
|
|
10509
|
+
* Project compliance details
|
|
10510
|
+
*/
|
|
10511
|
+
projects: PlanChangeProjectCompliance[];
|
|
10512
|
+
/**
|
|
10513
|
+
* Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.
|
|
10514
|
+
*/
|
|
10515
|
+
unsupportedAddons: string[];
|
|
10516
|
+
};
|
|
10517
|
+
/**
|
|
10518
|
+
* PlanChangeProjectCompliance
|
|
10519
|
+
*/
|
|
10520
|
+
export type PlanChangeProjectCompliance = {
|
|
10521
|
+
/**
|
|
10522
|
+
* Project ID
|
|
10523
|
+
*/
|
|
10524
|
+
$id: string;
|
|
10553
10525
|
/**
|
|
10554
|
-
*
|
|
10526
|
+
* Project name
|
|
10555
10527
|
*/
|
|
10556
|
-
|
|
10528
|
+
name: string;
|
|
10557
10529
|
/**
|
|
10558
|
-
*
|
|
10530
|
+
* Whether the project complies with target plan limits
|
|
10559
10531
|
*/
|
|
10560
|
-
|
|
10532
|
+
isCompliant: boolean;
|
|
10561
10533
|
/**
|
|
10562
|
-
*
|
|
10534
|
+
* Resource compliance details
|
|
10563
10535
|
*/
|
|
10564
|
-
|
|
10536
|
+
resources: PlanChangeResourceCompliance[];
|
|
10565
10537
|
/**
|
|
10566
|
-
*
|
|
10538
|
+
* Failure reason when compliance could not be evaluated. Present only when the project DB or Regions API was unreachable; in that case `isCompliant` is false (fail closed) and `resources` is empty.
|
|
10567
10539
|
*/
|
|
10568
|
-
|
|
10540
|
+
error?: string;
|
|
10541
|
+
};
|
|
10542
|
+
/**
|
|
10543
|
+
* PlanChangeResourceCompliance
|
|
10544
|
+
*/
|
|
10545
|
+
export type PlanChangeResourceCompliance = {
|
|
10569
10546
|
/**
|
|
10570
|
-
*
|
|
10547
|
+
* Resource type
|
|
10571
10548
|
*/
|
|
10572
|
-
|
|
10549
|
+
type: string;
|
|
10573
10550
|
/**
|
|
10574
|
-
*
|
|
10551
|
+
* Current usage count
|
|
10575
10552
|
*/
|
|
10576
|
-
|
|
10553
|
+
currentUsage: number;
|
|
10577
10554
|
/**
|
|
10578
|
-
*
|
|
10555
|
+
* Allowed limit in target plan
|
|
10579
10556
|
*/
|
|
10580
|
-
|
|
10557
|
+
limit: number;
|
|
10581
10558
|
/**
|
|
10582
|
-
*
|
|
10559
|
+
* Compliance status
|
|
10583
10560
|
*/
|
|
10584
|
-
|
|
10561
|
+
status: string;
|
|
10585
10562
|
/**
|
|
10586
|
-
*
|
|
10563
|
+
* Number of resources exceeding the limit
|
|
10587
10564
|
*/
|
|
10588
|
-
|
|
10565
|
+
excess: number;
|
|
10589
10566
|
/**
|
|
10590
|
-
*
|
|
10567
|
+
* Suggestion for resolving the compliance issue
|
|
10591
10568
|
*/
|
|
10592
|
-
|
|
10569
|
+
resolutionHint: string;
|
|
10593
10570
|
};
|
|
10594
10571
|
/**
|
|
10595
|
-
*
|
|
10572
|
+
* backup
|
|
10596
10573
|
*/
|
|
10597
|
-
export type
|
|
10574
|
+
export type BackupPolicy = {
|
|
10598
10575
|
/**
|
|
10599
|
-
*
|
|
10576
|
+
* Backup policy ID.
|
|
10600
10577
|
*/
|
|
10601
10578
|
$id: string;
|
|
10602
10579
|
/**
|
|
10603
|
-
*
|
|
10580
|
+
* Backup policy name.
|
|
10581
|
+
*/
|
|
10582
|
+
name: string;
|
|
10583
|
+
/**
|
|
10584
|
+
* Policy creation date in ISO 8601 format.
|
|
10604
10585
|
*/
|
|
10605
10586
|
$createdAt: string;
|
|
10606
10587
|
/**
|
|
10607
|
-
*
|
|
10588
|
+
* Policy update date in ISO 8601 format.
|
|
10608
10589
|
*/
|
|
10609
10590
|
$updatedAt: string;
|
|
10610
10591
|
/**
|
|
10611
|
-
*
|
|
10592
|
+
* The services that are backed up by this policy.
|
|
10612
10593
|
*/
|
|
10613
|
-
|
|
10594
|
+
services: string[];
|
|
10614
10595
|
/**
|
|
10615
|
-
*
|
|
10596
|
+
* The resources that are backed up by this policy.
|
|
10616
10597
|
*/
|
|
10617
|
-
|
|
10598
|
+
resources: string[];
|
|
10618
10599
|
/**
|
|
10619
|
-
*
|
|
10600
|
+
* The resource ID to backup. Set only if this policy should backup a single resource.
|
|
10620
10601
|
*/
|
|
10621
|
-
|
|
10602
|
+
resourceId?: string;
|
|
10622
10603
|
/**
|
|
10623
|
-
*
|
|
10604
|
+
* The resource type to backup. Set only if this policy should backup a single resource.
|
|
10624
10605
|
*/
|
|
10625
|
-
|
|
10606
|
+
resourceType?: string;
|
|
10626
10607
|
/**
|
|
10627
|
-
*
|
|
10608
|
+
* How many days to keep the backup before it will be automatically deleted.
|
|
10628
10609
|
*/
|
|
10629
|
-
|
|
10610
|
+
retention: number;
|
|
10630
10611
|
/**
|
|
10631
|
-
*
|
|
10612
|
+
* Policy backup schedule in CRON format.
|
|
10632
10613
|
*/
|
|
10633
|
-
|
|
10614
|
+
schedule: string;
|
|
10634
10615
|
/**
|
|
10635
|
-
*
|
|
10616
|
+
* Is this policy enabled.
|
|
10636
10617
|
*/
|
|
10637
|
-
|
|
10618
|
+
enabled: boolean;
|
|
10638
10619
|
};
|
|
10639
10620
|
/**
|
|
10640
|
-
*
|
|
10621
|
+
* Program
|
|
10641
10622
|
*/
|
|
10642
|
-
export type
|
|
10623
|
+
export type Program = {
|
|
10643
10624
|
/**
|
|
10644
|
-
*
|
|
10625
|
+
* Program ID
|
|
10645
10626
|
*/
|
|
10646
10627
|
$id: string;
|
|
10647
10628
|
/**
|
|
10648
|
-
*
|
|
10629
|
+
* Program title
|
|
10649
10630
|
*/
|
|
10650
|
-
|
|
10631
|
+
title: string;
|
|
10651
10632
|
/**
|
|
10652
|
-
*
|
|
10633
|
+
* Program description
|
|
10653
10634
|
*/
|
|
10654
|
-
|
|
10635
|
+
description: string;
|
|
10655
10636
|
/**
|
|
10656
|
-
*
|
|
10637
|
+
* Program tag for highlighting on console
|
|
10657
10638
|
*/
|
|
10658
|
-
|
|
10639
|
+
tag: string;
|
|
10659
10640
|
/**
|
|
10660
|
-
*
|
|
10641
|
+
* Program icon for highlighting on console
|
|
10661
10642
|
*/
|
|
10662
|
-
|
|
10643
|
+
icon: string;
|
|
10663
10644
|
/**
|
|
10664
|
-
*
|
|
10645
|
+
* URL for more information on this program
|
|
10665
10646
|
*/
|
|
10666
|
-
|
|
10647
|
+
url: string;
|
|
10667
10648
|
/**
|
|
10668
|
-
*
|
|
10649
|
+
* Whether this program is active
|
|
10669
10650
|
*/
|
|
10670
|
-
|
|
10651
|
+
active: boolean;
|
|
10671
10652
|
/**
|
|
10672
|
-
*
|
|
10653
|
+
* Whether this program is external
|
|
10673
10654
|
*/
|
|
10674
|
-
|
|
10655
|
+
external: boolean;
|
|
10675
10656
|
/**
|
|
10676
|
-
*
|
|
10657
|
+
* Billing plan ID that this is program is associated with.
|
|
10677
10658
|
*/
|
|
10678
|
-
|
|
10659
|
+
billingPlanId: string;
|
|
10660
|
+
};
|
|
10661
|
+
/**
|
|
10662
|
+
* Region
|
|
10663
|
+
*/
|
|
10664
|
+
export type ConsoleRegion = {
|
|
10679
10665
|
/**
|
|
10680
|
-
*
|
|
10666
|
+
* Region ID
|
|
10681
10667
|
*/
|
|
10682
|
-
|
|
10668
|
+
$id: string;
|
|
10683
10669
|
/**
|
|
10684
|
-
*
|
|
10670
|
+
* Region name
|
|
10685
10671
|
*/
|
|
10686
|
-
|
|
10672
|
+
name: string;
|
|
10687
10673
|
/**
|
|
10688
|
-
*
|
|
10674
|
+
* Does the organization have access to this region.
|
|
10689
10675
|
*/
|
|
10690
|
-
|
|
10676
|
+
available: boolean;
|
|
10677
|
+
/**
|
|
10678
|
+
* Does the backend support this region.
|
|
10679
|
+
*/
|
|
10680
|
+
disabled: boolean;
|
|
10681
|
+
/**
|
|
10682
|
+
* Is this the region default.
|
|
10683
|
+
*/
|
|
10684
|
+
default: boolean;
|
|
10685
|
+
/**
|
|
10686
|
+
* Region flag code.
|
|
10687
|
+
*/
|
|
10688
|
+
flag: string;
|
|
10691
10689
|
};
|
|
10692
10690
|
/**
|
|
10693
|
-
*
|
|
10691
|
+
* Restoration
|
|
10694
10692
|
*/
|
|
10695
|
-
export type
|
|
10693
|
+
export type BackupRestoration = {
|
|
10696
10694
|
/**
|
|
10697
|
-
*
|
|
10695
|
+
* Restoration ID.
|
|
10698
10696
|
*/
|
|
10699
|
-
|
|
10697
|
+
$id: string;
|
|
10700
10698
|
/**
|
|
10701
|
-
*
|
|
10699
|
+
* Restoration creation time in ISO 8601 format.
|
|
10702
10700
|
*/
|
|
10703
|
-
|
|
10701
|
+
$createdAt: string;
|
|
10704
10702
|
/**
|
|
10705
|
-
*
|
|
10703
|
+
* Restoration update date in ISO 8601 format.
|
|
10706
10704
|
*/
|
|
10707
|
-
|
|
10705
|
+
$updatedAt: string;
|
|
10708
10706
|
/**
|
|
10709
|
-
*
|
|
10707
|
+
* Backup archive ID.
|
|
10710
10708
|
*/
|
|
10711
|
-
|
|
10709
|
+
archiveId: string;
|
|
10712
10710
|
/**
|
|
10713
|
-
*
|
|
10711
|
+
* Backup policy ID.
|
|
10714
10712
|
*/
|
|
10715
|
-
|
|
10713
|
+
policyId: string;
|
|
10716
10714
|
/**
|
|
10717
|
-
*
|
|
10715
|
+
* The status of the restoration. Possible values: pending, downloading, processing, completed, failed.
|
|
10718
10716
|
*/
|
|
10719
|
-
|
|
10720
|
-
};
|
|
10721
|
-
/**
|
|
10722
|
-
* usageBillingPlan
|
|
10723
|
-
*/
|
|
10724
|
-
export type UsageBillingPlan = {
|
|
10717
|
+
status: string;
|
|
10725
10718
|
/**
|
|
10726
|
-
*
|
|
10719
|
+
* The backup start time.
|
|
10727
10720
|
*/
|
|
10728
|
-
|
|
10721
|
+
startedAt: string;
|
|
10729
10722
|
/**
|
|
10730
|
-
*
|
|
10723
|
+
* Migration ID.
|
|
10731
10724
|
*/
|
|
10732
|
-
|
|
10725
|
+
migrationId: string;
|
|
10733
10726
|
/**
|
|
10734
|
-
*
|
|
10727
|
+
* The services that are backed up by this policy.
|
|
10735
10728
|
*/
|
|
10736
|
-
|
|
10729
|
+
services: string[];
|
|
10737
10730
|
/**
|
|
10738
|
-
*
|
|
10731
|
+
* The resources that are backed up by this policy.
|
|
10739
10732
|
*/
|
|
10740
|
-
|
|
10733
|
+
resources: string[];
|
|
10741
10734
|
/**
|
|
10742
|
-
*
|
|
10735
|
+
* Optional data in key-value object.
|
|
10743
10736
|
*/
|
|
10744
|
-
|
|
10737
|
+
options: string;
|
|
10738
|
+
};
|
|
10739
|
+
/**
|
|
10740
|
+
* Review
|
|
10741
|
+
*/
|
|
10742
|
+
export type Review = {
|
|
10745
10743
|
/**
|
|
10746
|
-
*
|
|
10744
|
+
* Name of user
|
|
10747
10745
|
*/
|
|
10748
|
-
|
|
10746
|
+
name: string;
|
|
10749
10747
|
/**
|
|
10750
|
-
*
|
|
10748
|
+
* Reviewer image
|
|
10751
10749
|
*/
|
|
10752
|
-
|
|
10750
|
+
image: string;
|
|
10753
10751
|
/**
|
|
10754
|
-
*
|
|
10752
|
+
* Reviewer description
|
|
10755
10753
|
*/
|
|
10756
|
-
|
|
10754
|
+
description: string;
|
|
10757
10755
|
/**
|
|
10758
|
-
*
|
|
10756
|
+
* Review
|
|
10759
10757
|
*/
|
|
10760
|
-
|
|
10758
|
+
review: string;
|
|
10759
|
+
};
|
|
10760
|
+
/**
|
|
10761
|
+
* Roles
|
|
10762
|
+
*/
|
|
10763
|
+
export type Roles = {
|
|
10761
10764
|
/**
|
|
10762
|
-
*
|
|
10765
|
+
* Array of scopes accessible to current user.
|
|
10763
10766
|
*/
|
|
10764
|
-
|
|
10767
|
+
scopes: string[];
|
|
10765
10768
|
/**
|
|
10766
|
-
*
|
|
10769
|
+
* Array of roles assigned to current user.
|
|
10767
10770
|
*/
|
|
10768
|
-
|
|
10771
|
+
roles: string[];
|
|
10769
10772
|
};
|
|
10770
10773
|
/**
|
|
10771
|
-
*
|
|
10774
|
+
* usageBillingPlan
|
|
10772
10775
|
*/
|
|
10773
|
-
export type
|
|
10774
|
-
/**
|
|
10775
|
-
* Total amount
|
|
10776
|
-
*/
|
|
10777
|
-
amount: number;
|
|
10776
|
+
export type UsageBillingPlan = {
|
|
10778
10777
|
/**
|
|
10779
|
-
*
|
|
10778
|
+
* Bandwidth additional resources
|
|
10780
10779
|
*/
|
|
10781
|
-
|
|
10780
|
+
bandwidth: AdditionalResource;
|
|
10782
10781
|
/**
|
|
10783
|
-
*
|
|
10782
|
+
* Executions additional resources
|
|
10784
10783
|
*/
|
|
10785
|
-
|
|
10784
|
+
executions: AdditionalResource;
|
|
10786
10785
|
/**
|
|
10787
|
-
*
|
|
10786
|
+
* Member additional resources
|
|
10788
10787
|
*/
|
|
10789
|
-
|
|
10788
|
+
member: AdditionalResource;
|
|
10790
10789
|
/**
|
|
10791
|
-
*
|
|
10790
|
+
* Realtime additional resources
|
|
10792
10791
|
*/
|
|
10793
|
-
|
|
10792
|
+
realtime: AdditionalResource;
|
|
10794
10793
|
/**
|
|
10795
|
-
*
|
|
10794
|
+
* Realtime messages additional resources
|
|
10796
10795
|
*/
|
|
10797
|
-
|
|
10796
|
+
realtimeMessages: AdditionalResource;
|
|
10798
10797
|
/**
|
|
10799
|
-
*
|
|
10798
|
+
* Realtime bandwidth additional resources
|
|
10800
10799
|
*/
|
|
10801
|
-
|
|
10800
|
+
realtimeBandwidth: AdditionalResource;
|
|
10802
10801
|
/**
|
|
10803
|
-
*
|
|
10802
|
+
* Storage additional resources
|
|
10804
10803
|
*/
|
|
10805
|
-
|
|
10806
|
-
};
|
|
10807
|
-
/**
|
|
10808
|
-
* EstimationUpdatePlan
|
|
10809
|
-
*/
|
|
10810
|
-
export type EstimationUpdatePlan = {
|
|
10804
|
+
storage: AdditionalResource;
|
|
10811
10805
|
/**
|
|
10812
|
-
*
|
|
10806
|
+
* User additional resources
|
|
10813
10807
|
*/
|
|
10814
|
-
|
|
10808
|
+
users: AdditionalResource;
|
|
10815
10809
|
/**
|
|
10816
|
-
*
|
|
10810
|
+
* GBHour additional resources
|
|
10817
10811
|
*/
|
|
10818
|
-
|
|
10812
|
+
GBHours: AdditionalResource;
|
|
10819
10813
|
/**
|
|
10820
|
-
*
|
|
10814
|
+
* Image transformation additional resources
|
|
10821
10815
|
*/
|
|
10822
|
-
|
|
10816
|
+
imageTransformations: AdditionalResource;
|
|
10823
10817
|
/**
|
|
10824
|
-
* Credits
|
|
10818
|
+
* Credits additional resources
|
|
10825
10819
|
*/
|
|
10826
|
-
credits:
|
|
10820
|
+
credits: AdditionalResource;
|
|
10821
|
+
};
|
|
10822
|
+
/**
|
|
10823
|
+
* usageEvent
|
|
10824
|
+
*/
|
|
10825
|
+
export type UsageEvent = {
|
|
10827
10826
|
/**
|
|
10828
|
-
*
|
|
10827
|
+
* The metric key.
|
|
10829
10828
|
*/
|
|
10830
|
-
|
|
10829
|
+
metric: string;
|
|
10831
10830
|
/**
|
|
10832
|
-
*
|
|
10831
|
+
* The metric value.
|
|
10833
10832
|
*/
|
|
10834
|
-
|
|
10833
|
+
value: number;
|
|
10835
10834
|
/**
|
|
10836
|
-
*
|
|
10835
|
+
* The event timestamp.
|
|
10837
10836
|
*/
|
|
10838
|
-
|
|
10837
|
+
time: string;
|
|
10839
10838
|
/**
|
|
10840
|
-
*
|
|
10839
|
+
* The API endpoint path.
|
|
10841
10840
|
*/
|
|
10842
|
-
|
|
10841
|
+
path: string;
|
|
10843
10842
|
/**
|
|
10844
|
-
*
|
|
10843
|
+
* The HTTP method.
|
|
10845
10844
|
*/
|
|
10846
|
-
|
|
10847
|
-
};
|
|
10848
|
-
/**
|
|
10849
|
-
* EstimationPlanChange
|
|
10850
|
-
*/
|
|
10851
|
-
export type EstimationPlanChange = {
|
|
10845
|
+
method: string;
|
|
10852
10846
|
/**
|
|
10853
|
-
*
|
|
10847
|
+
* HTTP status code. Stored as string to preserve unset state (empty string = not available).
|
|
10854
10848
|
*/
|
|
10855
|
-
|
|
10849
|
+
status: string;
|
|
10856
10850
|
/**
|
|
10857
|
-
*
|
|
10851
|
+
* The resource type.
|
|
10858
10852
|
*/
|
|
10859
|
-
|
|
10853
|
+
resourceType: string;
|
|
10860
10854
|
/**
|
|
10861
|
-
*
|
|
10855
|
+
* The resource ID.
|
|
10862
10856
|
*/
|
|
10863
|
-
|
|
10857
|
+
resourceId: string;
|
|
10864
10858
|
/**
|
|
10865
|
-
*
|
|
10859
|
+
* Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format.
|
|
10866
10860
|
*/
|
|
10867
|
-
|
|
10861
|
+
countryCode: string;
|
|
10868
10862
|
/**
|
|
10869
|
-
*
|
|
10863
|
+
* The user agent string.
|
|
10870
10864
|
*/
|
|
10871
|
-
|
|
10865
|
+
userAgent: string;
|
|
10872
10866
|
};
|
|
10873
10867
|
/**
|
|
10874
|
-
*
|
|
10868
|
+
* usageGauge
|
|
10875
10869
|
*/
|
|
10876
|
-
export type
|
|
10877
|
-
/**
|
|
10878
|
-
* Currency code
|
|
10879
|
-
*/
|
|
10880
|
-
currency: string;
|
|
10870
|
+
export type UsageGauge = {
|
|
10881
10871
|
/**
|
|
10882
|
-
*
|
|
10872
|
+
* The metric key.
|
|
10883
10873
|
*/
|
|
10884
|
-
|
|
10874
|
+
metric: string;
|
|
10885
10875
|
/**
|
|
10886
|
-
*
|
|
10876
|
+
* The current snapshot value.
|
|
10887
10877
|
*/
|
|
10888
|
-
|
|
10878
|
+
value: number;
|
|
10889
10879
|
/**
|
|
10890
|
-
*
|
|
10880
|
+
* The snapshot timestamp.
|
|
10891
10881
|
*/
|
|
10892
|
-
|
|
10882
|
+
time: string;
|
|
10893
10883
|
/**
|
|
10894
|
-
*
|
|
10884
|
+
* The resource type.
|
|
10895
10885
|
*/
|
|
10896
|
-
|
|
10886
|
+
resourceType: string;
|
|
10897
10887
|
/**
|
|
10898
|
-
*
|
|
10888
|
+
* The resource ID.
|
|
10899
10889
|
*/
|
|
10900
|
-
|
|
10890
|
+
resourceId: string;
|
|
10891
|
+
};
|
|
10892
|
+
/**
|
|
10893
|
+
* Organization
|
|
10894
|
+
*/
|
|
10895
|
+
export type UsageOrganization = {
|
|
10901
10896
|
/**
|
|
10902
|
-
*
|
|
10897
|
+
* Aggregated stats for number of requests.
|
|
10903
10898
|
*/
|
|
10904
|
-
|
|
10899
|
+
bandwidth: Metric[];
|
|
10905
10900
|
/**
|
|
10906
|
-
*
|
|
10901
|
+
* Aggregated stats for consumed bandwidth.
|
|
10907
10902
|
*/
|
|
10908
|
-
|
|
10903
|
+
users: Metric[];
|
|
10909
10904
|
/**
|
|
10910
|
-
*
|
|
10905
|
+
* Aggregated stats for function executions.
|
|
10911
10906
|
*/
|
|
10912
|
-
|
|
10913
|
-
};
|
|
10914
|
-
/**
|
|
10915
|
-
* PlanChangeLimits
|
|
10916
|
-
*/
|
|
10917
|
-
export type PlanChangeLimits = {
|
|
10907
|
+
executions: Metric[];
|
|
10918
10908
|
/**
|
|
10919
|
-
*
|
|
10909
|
+
* Aggregated stats for database reads.
|
|
10920
10910
|
*/
|
|
10921
|
-
|
|
10911
|
+
databasesReads: Metric[];
|
|
10922
10912
|
/**
|
|
10923
|
-
*
|
|
10913
|
+
* Aggregated stats for database writes.
|
|
10924
10914
|
*/
|
|
10925
|
-
|
|
10915
|
+
databasesWrites: Metric[];
|
|
10926
10916
|
/**
|
|
10927
|
-
*
|
|
10917
|
+
* Aggregated stats for file transformations.
|
|
10928
10918
|
*/
|
|
10929
|
-
|
|
10919
|
+
imageTransformations: Metric[];
|
|
10930
10920
|
/**
|
|
10931
|
-
*
|
|
10921
|
+
* Aggregated stats for total file transformations.
|
|
10932
10922
|
*/
|
|
10933
|
-
|
|
10923
|
+
imageTransformationsTotal: number;
|
|
10934
10924
|
/**
|
|
10935
|
-
*
|
|
10925
|
+
* Aggregated stats for file transformations.
|
|
10936
10926
|
*/
|
|
10937
|
-
|
|
10938
|
-
};
|
|
10939
|
-
/**
|
|
10940
|
-
* PlanChangeProjectCompliance
|
|
10941
|
-
*/
|
|
10942
|
-
export type PlanChangeProjectCompliance = {
|
|
10927
|
+
screenshotsGenerated: Metric[];
|
|
10943
10928
|
/**
|
|
10944
|
-
*
|
|
10929
|
+
* Aggregated stats for total file transformations.
|
|
10945
10930
|
*/
|
|
10946
|
-
|
|
10931
|
+
screenshotsGeneratedTotal: number;
|
|
10947
10932
|
/**
|
|
10948
|
-
*
|
|
10933
|
+
* Aggregated stats for imagine credits.
|
|
10949
10934
|
*/
|
|
10950
|
-
|
|
10935
|
+
imagineCredits: Metric[];
|
|
10951
10936
|
/**
|
|
10952
|
-
*
|
|
10937
|
+
* Aggregated stats for total imagine credits.
|
|
10953
10938
|
*/
|
|
10954
|
-
|
|
10939
|
+
imagineCreditsTotal: number;
|
|
10955
10940
|
/**
|
|
10956
|
-
*
|
|
10941
|
+
* Aggregated stats for total users.
|
|
10957
10942
|
*/
|
|
10958
|
-
|
|
10943
|
+
usersTotal: number;
|
|
10959
10944
|
/**
|
|
10960
|
-
*
|
|
10945
|
+
* Aggregated stats for total executions.
|
|
10961
10946
|
*/
|
|
10962
|
-
|
|
10963
|
-
};
|
|
10964
|
-
/**
|
|
10965
|
-
* PlanChangeResourceCompliance
|
|
10966
|
-
*/
|
|
10967
|
-
export type PlanChangeResourceCompliance = {
|
|
10947
|
+
executionsTotal: number;
|
|
10968
10948
|
/**
|
|
10969
|
-
*
|
|
10949
|
+
* Aggregated stats for function executions in mb seconds.
|
|
10970
10950
|
*/
|
|
10971
|
-
|
|
10951
|
+
executionsMBSecondsTotal: number;
|
|
10972
10952
|
/**
|
|
10973
|
-
*
|
|
10953
|
+
* Aggregated stats for function builds in mb seconds.
|
|
10974
10954
|
*/
|
|
10975
|
-
|
|
10955
|
+
buildsMBSecondsTotal: number;
|
|
10976
10956
|
/**
|
|
10977
|
-
*
|
|
10957
|
+
* Aggregated stats for total file storage.
|
|
10978
10958
|
*/
|
|
10979
|
-
|
|
10959
|
+
filesStorageTotal: number;
|
|
10980
10960
|
/**
|
|
10981
|
-
*
|
|
10961
|
+
* Aggregated stats for total builds storage.
|
|
10982
10962
|
*/
|
|
10983
|
-
|
|
10963
|
+
buildsStorageTotal: number;
|
|
10984
10964
|
/**
|
|
10985
|
-
*
|
|
10965
|
+
* Aggregated stats for total deployments storage.
|
|
10986
10966
|
*/
|
|
10987
|
-
|
|
10967
|
+
deploymentsStorageTotal: number;
|
|
10988
10968
|
/**
|
|
10989
|
-
*
|
|
10969
|
+
* Aggregated stats for total databases storage.
|
|
10990
10970
|
*/
|
|
10991
|
-
|
|
10992
|
-
};
|
|
10993
|
-
/**
|
|
10994
|
-
* EstimationDeleteOrganization
|
|
10995
|
-
*/
|
|
10996
|
-
export type EstimationDeleteOrganization = {
|
|
10971
|
+
databasesStorageTotal: number;
|
|
10997
10972
|
/**
|
|
10998
|
-
*
|
|
10973
|
+
* Aggregated stats for total databases reads.
|
|
10999
10974
|
*/
|
|
11000
|
-
|
|
11001
|
-
};
|
|
11002
|
-
/**
|
|
11003
|
-
* EstimationItem
|
|
11004
|
-
*/
|
|
11005
|
-
export type EstimationItem = {
|
|
10975
|
+
databasesReadsTotal: number;
|
|
11006
10976
|
/**
|
|
11007
|
-
*
|
|
10977
|
+
* Aggregated stats for total databases writes.
|
|
11008
10978
|
*/
|
|
11009
|
-
|
|
10979
|
+
databasesWritesTotal: number;
|
|
11010
10980
|
/**
|
|
11011
|
-
*
|
|
10981
|
+
* Aggregated stats for total backups storage.
|
|
11012
10982
|
*/
|
|
11013
|
-
|
|
11014
|
-
};
|
|
11015
|
-
/**
|
|
11016
|
-
* DomainPrice
|
|
11017
|
-
*/
|
|
11018
|
-
export type DomainPrice = {
|
|
10983
|
+
backupsStorageTotal: number;
|
|
11019
10984
|
/**
|
|
11020
|
-
*
|
|
10985
|
+
* Aggregated stats for total storage.
|
|
11021
10986
|
*/
|
|
11022
|
-
|
|
10987
|
+
storageTotal: number;
|
|
11023
10988
|
/**
|
|
11024
|
-
*
|
|
10989
|
+
* Aggregated stats for total auth phone.
|
|
11025
10990
|
*/
|
|
11026
|
-
|
|
10991
|
+
authPhoneTotal: number;
|
|
11027
10992
|
/**
|
|
11028
|
-
*
|
|
10993
|
+
* Aggregated stats for total auth phone estimation.
|
|
11029
10994
|
*/
|
|
11030
|
-
|
|
10995
|
+
authPhoneEstimate: number;
|
|
11031
10996
|
/**
|
|
11032
|
-
*
|
|
10997
|
+
* Aggregated stats for each projects.
|
|
11033
10998
|
*/
|
|
11034
|
-
|
|
10999
|
+
projects: UsageOrganizationProject[];
|
|
11035
11000
|
/**
|
|
11036
|
-
*
|
|
11001
|
+
* Aggregated stats for realtime connections.
|
|
11037
11002
|
*/
|
|
11038
|
-
|
|
11003
|
+
realtimeConnections: Metric[];
|
|
11039
11004
|
/**
|
|
11040
|
-
*
|
|
11005
|
+
* Aggregated stats for total realtime connections.
|
|
11041
11006
|
*/
|
|
11042
|
-
|
|
11043
|
-
};
|
|
11044
|
-
/**
|
|
11045
|
-
* DomainSuggestion
|
|
11046
|
-
*/
|
|
11047
|
-
export type DomainSuggestion = {
|
|
11007
|
+
realtimeConnectionsTotal: number;
|
|
11048
11008
|
/**
|
|
11049
|
-
*
|
|
11009
|
+
* Aggregated stats for realtime messages.
|
|
11050
11010
|
*/
|
|
11051
|
-
|
|
11011
|
+
realtimeMessages: Metric[];
|
|
11052
11012
|
/**
|
|
11053
|
-
*
|
|
11013
|
+
* Aggregated stats for total realtime messages.
|
|
11054
11014
|
*/
|
|
11055
|
-
|
|
11015
|
+
realtimeMessagesTotal: number;
|
|
11056
11016
|
/**
|
|
11057
|
-
*
|
|
11017
|
+
* Aggregated stats for realtime bandwidth.
|
|
11058
11018
|
*/
|
|
11059
|
-
|
|
11019
|
+
realtimeBandwidth: Metric[];
|
|
11060
11020
|
/**
|
|
11061
|
-
*
|
|
11021
|
+
* Aggregated stats for total realtime bandwidth.
|
|
11062
11022
|
*/
|
|
11063
|
-
|
|
11023
|
+
realtimeBandwidthTotal: number;
|
|
11064
11024
|
};
|
|
11065
11025
|
/**
|
|
11066
|
-
*
|
|
11026
|
+
* OrganizationProject
|
|
11067
11027
|
*/
|
|
11068
|
-
export type
|
|
11028
|
+
export type UsageOrganizationProject = {
|
|
11069
11029
|
/**
|
|
11070
|
-
*
|
|
11030
|
+
* projectId
|
|
11071
11031
|
*/
|
|
11072
|
-
|
|
11032
|
+
projectId: string;
|
|
11073
11033
|
/**
|
|
11074
|
-
*
|
|
11034
|
+
* Aggregated stats for number of requests.
|
|
11075
11035
|
*/
|
|
11076
|
-
|
|
11036
|
+
bandwidth: Metric[];
|
|
11077
11037
|
/**
|
|
11078
|
-
*
|
|
11038
|
+
* Aggregated stats for consumed bandwidth.
|
|
11079
11039
|
*/
|
|
11080
|
-
|
|
11040
|
+
users: Metric[];
|
|
11081
11041
|
/**
|
|
11082
|
-
*
|
|
11042
|
+
* Aggregated stats for function executions.
|
|
11083
11043
|
*/
|
|
11084
|
-
|
|
11044
|
+
executions: number;
|
|
11085
11045
|
/**
|
|
11086
|
-
*
|
|
11046
|
+
* Aggregated stats for database reads.
|
|
11087
11047
|
*/
|
|
11088
|
-
|
|
11048
|
+
databasesReads: Metric[];
|
|
11089
11049
|
/**
|
|
11090
|
-
*
|
|
11050
|
+
* Aggregated stats for database writes.
|
|
11091
11051
|
*/
|
|
11092
|
-
|
|
11052
|
+
databasesWrites: Metric[];
|
|
11093
11053
|
/**
|
|
11094
|
-
*
|
|
11054
|
+
* Aggregated stats for function executions in mb seconds.
|
|
11095
11055
|
*/
|
|
11096
|
-
|
|
11056
|
+
executionsMBSeconds: number;
|
|
11097
11057
|
/**
|
|
11098
|
-
*
|
|
11058
|
+
* Aggregated stats for function builds in mb seconds.
|
|
11099
11059
|
*/
|
|
11100
|
-
|
|
11060
|
+
buildsMBSeconds: number;
|
|
11101
11061
|
/**
|
|
11102
|
-
*
|
|
11062
|
+
* Aggregated stats for number of documents.
|
|
11103
11063
|
*/
|
|
11104
|
-
|
|
11064
|
+
storage: number;
|
|
11105
11065
|
/**
|
|
11106
|
-
*
|
|
11066
|
+
* Aggregated stats for phone authentication.
|
|
11107
11067
|
*/
|
|
11108
|
-
|
|
11109
|
-
};
|
|
11110
|
-
/**
|
|
11111
|
-
* AddonPrice
|
|
11112
|
-
*/
|
|
11113
|
-
export type AddonPrice = {
|
|
11068
|
+
authPhoneTotal: number;
|
|
11114
11069
|
/**
|
|
11115
|
-
*
|
|
11070
|
+
* Aggregated stats for phone authentication estimated cost.
|
|
11116
11071
|
*/
|
|
11117
|
-
|
|
11072
|
+
authPhoneEstimate: number;
|
|
11118
11073
|
/**
|
|
11119
|
-
*
|
|
11074
|
+
* Aggregated stats for total databases reads.
|
|
11120
11075
|
*/
|
|
11121
|
-
|
|
11076
|
+
databasesReadsTotal: number;
|
|
11122
11077
|
/**
|
|
11123
|
-
*
|
|
11078
|
+
* Aggregated stats for total databases writes.
|
|
11124
11079
|
*/
|
|
11125
|
-
|
|
11080
|
+
databasesWritesTotal: number;
|
|
11126
11081
|
/**
|
|
11127
|
-
*
|
|
11082
|
+
* Aggregated stats for file transformations.
|
|
11128
11083
|
*/
|
|
11129
|
-
|
|
11084
|
+
imageTransformations: Metric[];
|
|
11130
11085
|
/**
|
|
11131
|
-
*
|
|
11086
|
+
* Aggregated stats for total file transformations.
|
|
11132
11087
|
*/
|
|
11133
|
-
|
|
11088
|
+
imageTransformationsTotal: number;
|
|
11134
11089
|
/**
|
|
11135
|
-
*
|
|
11090
|
+
* Aggregated stats for file transformations.
|
|
11136
11091
|
*/
|
|
11137
|
-
|
|
11092
|
+
screenshotsGenerated: Metric[];
|
|
11138
11093
|
/**
|
|
11139
|
-
*
|
|
11094
|
+
* Aggregated stats for total file transformations.
|
|
11140
11095
|
*/
|
|
11141
|
-
|
|
11096
|
+
screenshotsGeneratedTotal: number;
|
|
11142
11097
|
/**
|
|
11143
|
-
*
|
|
11098
|
+
* Aggregated stats for imagine credits.
|
|
11144
11099
|
*/
|
|
11145
|
-
|
|
11146
|
-
};
|
|
11147
|
-
/**
|
|
11148
|
-
* domainTransferOut
|
|
11149
|
-
*/
|
|
11150
|
-
export type DomainTransferOut = {
|
|
11100
|
+
imagineCredits: number;
|
|
11151
11101
|
/**
|
|
11152
|
-
*
|
|
11102
|
+
* Aggregated stats for realtime connections.
|
|
11153
11103
|
*/
|
|
11154
|
-
|
|
11104
|
+
realtimeConnections: number;
|
|
11105
|
+
/**
|
|
11106
|
+
* Aggregated stats for realtime messages.
|
|
11107
|
+
*/
|
|
11108
|
+
realtimeMessages: number;
|
|
11109
|
+
/**
|
|
11110
|
+
* Aggregated stats for realtime bandwidth.
|
|
11111
|
+
*/
|
|
11112
|
+
realtimeBandwidth: number;
|
|
11155
11113
|
};
|
|
11156
11114
|
/**
|
|
11157
|
-
*
|
|
11115
|
+
* Resource
|
|
11158
11116
|
*/
|
|
11159
|
-
export type
|
|
11117
|
+
export type UsageResources = {
|
|
11160
11118
|
/**
|
|
11161
|
-
*
|
|
11119
|
+
* Invoice name
|
|
11162
11120
|
*/
|
|
11163
|
-
|
|
11121
|
+
name: string;
|
|
11164
11122
|
/**
|
|
11165
|
-
*
|
|
11123
|
+
* Invoice value
|
|
11166
11124
|
*/
|
|
11167
|
-
|
|
11125
|
+
value: number;
|
|
11168
11126
|
/**
|
|
11169
|
-
*
|
|
11127
|
+
* Invoice amount
|
|
11170
11128
|
*/
|
|
11171
|
-
|
|
11172
|
-
};
|
|
11173
|
-
/**
|
|
11174
|
-
* Addons list
|
|
11175
|
-
*/
|
|
11176
|
-
export type AddonList = {
|
|
11129
|
+
amount: number;
|
|
11177
11130
|
/**
|
|
11178
|
-
*
|
|
11131
|
+
* Invoice rate
|
|
11179
11132
|
*/
|
|
11180
|
-
|
|
11133
|
+
rate: number;
|
|
11181
11134
|
/**
|
|
11182
|
-
*
|
|
11135
|
+
* Invoice description
|
|
11183
11136
|
*/
|
|
11184
|
-
|
|
11137
|
+
desc: string;
|
|
11138
|
+
/**
|
|
11139
|
+
* Resource ID
|
|
11140
|
+
*/
|
|
11141
|
+
resourceId: string;
|
|
11185
11142
|
};
|
|
11186
11143
|
/**
|
|
11187
11144
|
* Activity event list
|
|
@@ -11196,6 +11153,19 @@ export declare namespace Models {
|
|
|
11196
11153
|
*/
|
|
11197
11154
|
events: ActivityEvent[];
|
|
11198
11155
|
};
|
|
11156
|
+
/**
|
|
11157
|
+
* Addons list
|
|
11158
|
+
*/
|
|
11159
|
+
export type AddonList = {
|
|
11160
|
+
/**
|
|
11161
|
+
* Total number of addons that matched your query.
|
|
11162
|
+
*/
|
|
11163
|
+
total: number;
|
|
11164
|
+
/**
|
|
11165
|
+
* List of addons.
|
|
11166
|
+
*/
|
|
11167
|
+
addons: Addon[];
|
|
11168
|
+
};
|
|
11199
11169
|
/**
|
|
11200
11170
|
* Aggregation team list
|
|
11201
11171
|
*/
|
|
@@ -11249,30 +11219,30 @@ export declare namespace Models {
|
|
|
11249
11219
|
restorations: BackupRestoration[];
|
|
11250
11220
|
};
|
|
11251
11221
|
/**
|
|
11252
|
-
* Billing
|
|
11222
|
+
* Billing address list
|
|
11253
11223
|
*/
|
|
11254
|
-
export type
|
|
11224
|
+
export type BillingAddressList = {
|
|
11255
11225
|
/**
|
|
11256
|
-
* Total number of
|
|
11226
|
+
* Total number of billingAddresses that matched your query.
|
|
11257
11227
|
*/
|
|
11258
11228
|
total: number;
|
|
11259
11229
|
/**
|
|
11260
|
-
* List of
|
|
11230
|
+
* List of billingAddresses.
|
|
11261
11231
|
*/
|
|
11262
|
-
|
|
11232
|
+
billingAddresses: BillingAddress[];
|
|
11263
11233
|
};
|
|
11264
11234
|
/**
|
|
11265
|
-
* Billing
|
|
11235
|
+
* Billing invoices list
|
|
11266
11236
|
*/
|
|
11267
|
-
export type
|
|
11237
|
+
export type InvoiceList = {
|
|
11268
11238
|
/**
|
|
11269
|
-
* Total number of
|
|
11239
|
+
* Total number of invoices that matched your query.
|
|
11270
11240
|
*/
|
|
11271
11241
|
total: number;
|
|
11272
11242
|
/**
|
|
11273
|
-
* List of
|
|
11243
|
+
* List of invoices.
|
|
11274
11244
|
*/
|
|
11275
|
-
|
|
11245
|
+
invoices: Invoice[];
|
|
11276
11246
|
};
|
|
11277
11247
|
/**
|
|
11278
11248
|
* Billing plan list
|
|
@@ -11288,95 +11258,121 @@ export declare namespace Models {
|
|
|
11288
11258
|
plans: BillingPlan[];
|
|
11289
11259
|
};
|
|
11290
11260
|
/**
|
|
11291
|
-
*
|
|
11261
|
+
* Blocks list
|
|
11292
11262
|
*/
|
|
11293
|
-
export type
|
|
11263
|
+
export type BlockList = {
|
|
11294
11264
|
/**
|
|
11295
|
-
* Total number of
|
|
11265
|
+
* Total number of blocks that matched your query.
|
|
11296
11266
|
*/
|
|
11297
11267
|
total: number;
|
|
11298
11268
|
/**
|
|
11299
|
-
* List of
|
|
11269
|
+
* List of blocks.
|
|
11300
11270
|
*/
|
|
11301
|
-
|
|
11271
|
+
blocks: Block[];
|
|
11302
11272
|
};
|
|
11303
11273
|
/**
|
|
11304
|
-
*
|
|
11274
|
+
* DNS records list
|
|
11305
11275
|
*/
|
|
11306
|
-
export type
|
|
11276
|
+
export type DnsRecordsList = {
|
|
11307
11277
|
/**
|
|
11308
|
-
* Total number of
|
|
11278
|
+
* Total number of dnsRecords that matched your query.
|
|
11309
11279
|
*/
|
|
11310
11280
|
total: number;
|
|
11311
11281
|
/**
|
|
11312
|
-
* List of
|
|
11282
|
+
* List of dnsRecords.
|
|
11313
11283
|
*/
|
|
11314
|
-
|
|
11284
|
+
dnsRecords: DnsRecord[];
|
|
11315
11285
|
};
|
|
11316
11286
|
/**
|
|
11317
|
-
*
|
|
11287
|
+
* Domain suggestions list
|
|
11318
11288
|
*/
|
|
11319
|
-
export type
|
|
11289
|
+
export type DomainSuggestionsList = {
|
|
11320
11290
|
/**
|
|
11321
|
-
* Total number of
|
|
11291
|
+
* Total number of suggestions that matched your query.
|
|
11322
11292
|
*/
|
|
11323
11293
|
total: number;
|
|
11324
11294
|
/**
|
|
11325
|
-
* List of
|
|
11295
|
+
* List of suggestions.
|
|
11326
11296
|
*/
|
|
11327
|
-
|
|
11297
|
+
suggestions: DomainSuggestion[];
|
|
11328
11298
|
};
|
|
11329
11299
|
/**
|
|
11330
|
-
*
|
|
11300
|
+
* Domains list
|
|
11331
11301
|
*/
|
|
11332
|
-
export type
|
|
11302
|
+
export type DomainsList = {
|
|
11333
11303
|
/**
|
|
11334
|
-
* Total number of
|
|
11304
|
+
* Total number of domains that matched your query.
|
|
11335
11305
|
*/
|
|
11336
11306
|
total: number;
|
|
11337
11307
|
/**
|
|
11338
|
-
* List of
|
|
11308
|
+
* List of domains.
|
|
11339
11309
|
*/
|
|
11340
|
-
|
|
11310
|
+
domains: Domain[];
|
|
11341
11311
|
};
|
|
11342
11312
|
/**
|
|
11343
|
-
*
|
|
11313
|
+
* Organizations list
|
|
11344
11314
|
*/
|
|
11345
|
-
export type
|
|
11315
|
+
export type OrganizationList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
|
|
11346
11316
|
/**
|
|
11347
|
-
* Total number of
|
|
11317
|
+
* Total number of teams that matched your query.
|
|
11348
11318
|
*/
|
|
11349
11319
|
total: number;
|
|
11350
11320
|
/**
|
|
11351
|
-
* List of
|
|
11321
|
+
* List of teams.
|
|
11352
11322
|
*/
|
|
11353
|
-
|
|
11323
|
+
teams: Organization<Preferences>[];
|
|
11354
11324
|
};
|
|
11355
11325
|
/**
|
|
11356
|
-
*
|
|
11326
|
+
* Payment methods list
|
|
11357
11327
|
*/
|
|
11358
|
-
export type
|
|
11328
|
+
export type PaymentMethodList = {
|
|
11359
11329
|
/**
|
|
11360
|
-
* Total number of
|
|
11330
|
+
* Total number of paymentMethods that matched your query.
|
|
11361
11331
|
*/
|
|
11362
11332
|
total: number;
|
|
11363
11333
|
/**
|
|
11364
|
-
* List of
|
|
11334
|
+
* List of paymentMethods.
|
|
11365
11335
|
*/
|
|
11366
|
-
|
|
11336
|
+
paymentMethods: PaymentMethod[];
|
|
11367
11337
|
};
|
|
11368
11338
|
/**
|
|
11369
|
-
*
|
|
11339
|
+
* Regions list
|
|
11370
11340
|
*/
|
|
11371
|
-
export type
|
|
11341
|
+
export type ConsoleRegionList = {
|
|
11372
11342
|
/**
|
|
11373
|
-
* Total number of
|
|
11343
|
+
* Total number of regions that matched your query.
|
|
11374
11344
|
*/
|
|
11375
11345
|
total: number;
|
|
11376
11346
|
/**
|
|
11377
|
-
* List of
|
|
11347
|
+
* List of regions.
|
|
11378
11348
|
*/
|
|
11379
|
-
|
|
11349
|
+
regions: ConsoleRegion[];
|
|
11350
|
+
};
|
|
11351
|
+
/**
|
|
11352
|
+
* Usage events list
|
|
11353
|
+
*/
|
|
11354
|
+
export type UsageEventList = {
|
|
11355
|
+
/**
|
|
11356
|
+
* Total number of events that matched your query.
|
|
11357
|
+
*/
|
|
11358
|
+
total: number;
|
|
11359
|
+
/**
|
|
11360
|
+
* List of events.
|
|
11361
|
+
*/
|
|
11362
|
+
events: UsageEvent[];
|
|
11363
|
+
};
|
|
11364
|
+
/**
|
|
11365
|
+
* Usage gauges list
|
|
11366
|
+
*/
|
|
11367
|
+
export type UsageGaugeList = {
|
|
11368
|
+
/**
|
|
11369
|
+
* Total number of gauges that matched your query.
|
|
11370
|
+
*/
|
|
11371
|
+
total: number;
|
|
11372
|
+
/**
|
|
11373
|
+
* List of gauges.
|
|
11374
|
+
*/
|
|
11375
|
+
gauges: UsageGauge[];
|
|
11380
11376
|
};
|
|
11381
11377
|
export {};
|
|
11382
11378
|
}
|