@appwrite.io/console 15.2.0 → 15.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/cjs/sdk.js +12031 -9316
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +12028 -9316
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +12031 -9316
- package/package.json +4 -4
- package/types/client.d.ts +11 -0
- package/types/enums/addon.d.ts +2 -0
- package/types/enums/block-mode.d.ts +4 -0
- package/types/enums/database-status.d.ts +5 -0
- package/types/enums/health-queue-name.d.ts +2 -1
- package/types/enums/o-auth-2-oidc-prompt.d.ts +6 -0
- package/types/enums/organization-key-scopes.d.ts +4 -0
- package/types/enums/project-key-scopes.d.ts +4 -0
- package/types/enums/project-o-auth-2-oidc-prompt.d.ts +6 -0
- package/types/enums/query-suggestion-resource.d.ts +3 -0
- package/types/index.d.ts +8 -1
- package/types/models.d.ts +526 -392
- package/types/query.d.ts +24 -0
- package/types/services/account.d.ts +4 -4
- package/types/services/backups.d.ts +10 -1
- package/types/services/console.d.ts +35 -0
- package/types/services/databases.d.ts +0 -78
- package/types/services/documents-db.d.ts +4 -71
- package/types/services/domains.d.ts +26 -2
- package/types/services/functions.d.ts +4 -4
- package/types/services/health.d.ts +33 -16
- package/types/services/locale.d.ts +2 -2
- package/types/services/manager.d.ts +5 -1
- package/types/services/messaging.d.ts +0 -100
- package/types/services/mongo.d.ts +792 -0
- package/types/services/mysql.d.ts +882 -0
- package/types/services/notifications.d.ts +51 -0
- package/types/services/oauth-2.d.ts +117 -9
- package/types/services/organization.d.ts +158 -6
- package/types/services/organizations.d.ts +21 -0
- package/types/services/{compute.d.ts → postgresql.d.ts} +193 -322
- package/types/services/project.d.ts +14 -7
- package/types/services/projects.d.ts +186 -0
- package/types/services/tables-db.d.ts +89 -57
- package/types/services/usage.d.ts +16 -22
- package/types/services/users.d.ts +2 -2
- package/types/services/vectors-db.d.ts +8 -73
|
@@ -3,6 +3,7 @@ import type { Models } from '../models';
|
|
|
3
3
|
import { ProjectAuthMethodId } from '../enums/project-auth-method-id';
|
|
4
4
|
import { ProjectKeyScopes } from '../enums/project-key-scopes';
|
|
5
5
|
import { ProjectOAuth2GooglePrompt } from '../enums/project-o-auth-2-google-prompt';
|
|
6
|
+
import { ProjectOAuth2OidcPrompt } from '../enums/project-o-auth-2-oidc-prompt';
|
|
6
7
|
import { ProjectOAuthProviderId } from '../enums/project-o-auth-provider-id';
|
|
7
8
|
import { ProjectPolicyId } from '../enums/project-policy-id';
|
|
8
9
|
import { ProjectProtocolId } from '../enums/project-protocol-id';
|
|
@@ -79,7 +80,7 @@ export declare class Project {
|
|
|
79
80
|
*
|
|
80
81
|
* @param {string} params.keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
81
82
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
82
|
-
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of
|
|
83
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 200 scopes are allowed.
|
|
83
84
|
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
84
85
|
* @throws {AppwriteException}
|
|
85
86
|
* @returns {Promise<Models.Key>}
|
|
@@ -97,7 +98,7 @@ export declare class Project {
|
|
|
97
98
|
*
|
|
98
99
|
* @param {string} keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
99
100
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
100
|
-
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of
|
|
101
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 200 scopes are allowed.
|
|
101
102
|
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
102
103
|
* @throws {AppwriteException}
|
|
103
104
|
* @returns {Promise<Models.Key>}
|
|
@@ -109,7 +110,7 @@ export declare class Project {
|
|
|
109
110
|
*
|
|
110
111
|
* You can also create a standard API key if you need a longer-lived key instead.
|
|
111
112
|
*
|
|
112
|
-
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of
|
|
113
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 200 scopes are allowed.
|
|
113
114
|
* @param {number} params.duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
114
115
|
* @throws {AppwriteException}
|
|
115
116
|
* @returns {Promise<Models.EphemeralKey>}
|
|
@@ -123,7 +124,7 @@ export declare class Project {
|
|
|
123
124
|
*
|
|
124
125
|
* You can also create a standard API key if you need a longer-lived key instead.
|
|
125
126
|
*
|
|
126
|
-
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of
|
|
127
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 200 scopes are allowed.
|
|
127
128
|
* @param {number} duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
128
129
|
* @throws {AppwriteException}
|
|
129
130
|
* @returns {Promise<Models.EphemeralKey>}
|
|
@@ -154,7 +155,7 @@ export declare class Project {
|
|
|
154
155
|
*
|
|
155
156
|
* @param {string} params.keyId - Key ID.
|
|
156
157
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
157
|
-
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of
|
|
158
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 200 scopes are allowed.
|
|
158
159
|
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
159
160
|
* @throws {AppwriteException}
|
|
160
161
|
* @returns {Promise<Models.Key>}
|
|
@@ -170,7 +171,7 @@ export declare class Project {
|
|
|
170
171
|
*
|
|
171
172
|
* @param {string} keyId - Key ID.
|
|
172
173
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
173
|
-
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of
|
|
174
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 200 scopes are allowed.
|
|
174
175
|
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
175
176
|
* @throws {AppwriteException}
|
|
176
177
|
* @returns {Promise<Models.Key>}
|
|
@@ -1035,6 +1036,8 @@ export declare class Project {
|
|
|
1035
1036
|
* @param {string} params.authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1036
1037
|
* @param {string} params.tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1037
1038
|
* @param {string} params.userInfoURL - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1039
|
+
* @param {ProjectOAuth2OidcPrompt[]} params.prompt - Array of OpenID Connect prompt values controlling the authentication and consent screens. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
1040
|
+
* @param {number} params.maxAge - Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds, otherwise they are prompted to re-authenticate.
|
|
1038
1041
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1039
1042
|
* @throws {AppwriteException}
|
|
1040
1043
|
* @returns {Promise<Models.OAuth2Oidc>}
|
|
@@ -1046,6 +1049,8 @@ export declare class Project {
|
|
|
1046
1049
|
authorizationURL?: string;
|
|
1047
1050
|
tokenURL?: string;
|
|
1048
1051
|
userInfoURL?: string;
|
|
1052
|
+
prompt?: ProjectOAuth2OidcPrompt[];
|
|
1053
|
+
maxAge?: number;
|
|
1049
1054
|
enabled?: boolean;
|
|
1050
1055
|
}): Promise<Models.OAuth2Oidc>;
|
|
1051
1056
|
/**
|
|
@@ -1057,12 +1062,14 @@ export declare class Project {
|
|
|
1057
1062
|
* @param {string} authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1058
1063
|
* @param {string} tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1059
1064
|
* @param {string} userInfoURL - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1065
|
+
* @param {ProjectOAuth2OidcPrompt[]} prompt - Array of OpenID Connect prompt values controlling the authentication and consent screens. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
1066
|
+
* @param {number} maxAge - Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds, otherwise they are prompted to re-authenticate.
|
|
1060
1067
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1061
1068
|
* @throws {AppwriteException}
|
|
1062
1069
|
* @returns {Promise<Models.OAuth2Oidc>}
|
|
1063
1070
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1064
1071
|
*/
|
|
1065
|
-
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string, tokenURL?: string, userInfoURL?: string, enabled?: boolean): Promise<Models.OAuth2Oidc>;
|
|
1072
|
+
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string, tokenURL?: string, userInfoURL?: string, prompt?: ProjectOAuth2OidcPrompt[], maxAge?: number, enabled?: boolean): Promise<Models.OAuth2Oidc>;
|
|
1066
1073
|
/**
|
|
1067
1074
|
* Update the project OAuth2 Okta configuration.
|
|
1068
1075
|
*
|
|
@@ -5,6 +5,144 @@ import { Status } from '../enums/status';
|
|
|
5
5
|
export declare class Projects {
|
|
6
6
|
client: Client;
|
|
7
7
|
constructor(client: Client);
|
|
8
|
+
/**
|
|
9
|
+
* List all billing addons for a project.
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* @param {string} params.projectId - Project ID
|
|
13
|
+
* @throws {AppwriteException}
|
|
14
|
+
* @returns {Promise<Models.AddonList>}
|
|
15
|
+
*/
|
|
16
|
+
listAddons(params: {
|
|
17
|
+
projectId: string;
|
|
18
|
+
}): Promise<Models.AddonList>;
|
|
19
|
+
/**
|
|
20
|
+
* List all billing addons for a project.
|
|
21
|
+
*
|
|
22
|
+
*
|
|
23
|
+
* @param {string} projectId - Project ID
|
|
24
|
+
* @throws {AppwriteException}
|
|
25
|
+
* @returns {Promise<Models.AddonList>}
|
|
26
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
27
|
+
*/
|
|
28
|
+
listAddons(projectId: string): Promise<Models.AddonList>;
|
|
29
|
+
/**
|
|
30
|
+
* Create a Premium Geo DB addon for a project.
|
|
31
|
+
*
|
|
32
|
+
*
|
|
33
|
+
* @param {string} params.projectId - Project ID
|
|
34
|
+
* @throws {AppwriteException}
|
|
35
|
+
* @returns {Promise<Models.Addon>}
|
|
36
|
+
*/
|
|
37
|
+
createPremiumGeoDBAddon(params: {
|
|
38
|
+
projectId: string;
|
|
39
|
+
}): Promise<Models.Addon>;
|
|
40
|
+
/**
|
|
41
|
+
* Create a Premium Geo DB addon for a project.
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @param {string} projectId - Project ID
|
|
45
|
+
* @throws {AppwriteException}
|
|
46
|
+
* @returns {Promise<Models.Addon>}
|
|
47
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
48
|
+
*/
|
|
49
|
+
createPremiumGeoDBAddon(projectId: string): Promise<Models.Addon>;
|
|
50
|
+
/**
|
|
51
|
+
* Get the details of a billing addon for a project.
|
|
52
|
+
*
|
|
53
|
+
*
|
|
54
|
+
* @param {string} params.projectId - Project ID
|
|
55
|
+
* @param {string} params.addonId - Addon ID
|
|
56
|
+
* @throws {AppwriteException}
|
|
57
|
+
* @returns {Promise<Models.Addon>}
|
|
58
|
+
*/
|
|
59
|
+
getAddon(params: {
|
|
60
|
+
projectId: string;
|
|
61
|
+
addonId: string;
|
|
62
|
+
}): Promise<Models.Addon>;
|
|
63
|
+
/**
|
|
64
|
+
* Get the details of a billing addon for a project.
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
* @param {string} projectId - Project ID
|
|
68
|
+
* @param {string} addonId - Addon ID
|
|
69
|
+
* @throws {AppwriteException}
|
|
70
|
+
* @returns {Promise<Models.Addon>}
|
|
71
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
72
|
+
*/
|
|
73
|
+
getAddon(projectId: string, addonId: string): Promise<Models.Addon>;
|
|
74
|
+
/**
|
|
75
|
+
* Delete a billing addon for a project.
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @param {string} params.projectId - Project ID
|
|
79
|
+
* @param {string} params.addonId - Addon ID
|
|
80
|
+
* @throws {AppwriteException}
|
|
81
|
+
* @returns {Promise<{}>}
|
|
82
|
+
*/
|
|
83
|
+
deleteAddon(params: {
|
|
84
|
+
projectId: string;
|
|
85
|
+
addonId: string;
|
|
86
|
+
}): Promise<{}>;
|
|
87
|
+
/**
|
|
88
|
+
* Delete a billing addon for a project.
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @param {string} projectId - Project ID
|
|
92
|
+
* @param {string} addonId - Addon ID
|
|
93
|
+
* @throws {AppwriteException}
|
|
94
|
+
* @returns {Promise<{}>}
|
|
95
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
96
|
+
*/
|
|
97
|
+
deleteAddon(projectId: string, addonId: string): Promise<{}>;
|
|
98
|
+
/**
|
|
99
|
+
* Confirm payment for a billing addon for a project.
|
|
100
|
+
*
|
|
101
|
+
*
|
|
102
|
+
* @param {string} params.projectId - Project ID
|
|
103
|
+
* @param {string} params.addonId - Addon ID
|
|
104
|
+
* @throws {AppwriteException}
|
|
105
|
+
* @returns {Promise<Models.Addon>}
|
|
106
|
+
*/
|
|
107
|
+
confirmAddonPayment(params: {
|
|
108
|
+
projectId: string;
|
|
109
|
+
addonId: string;
|
|
110
|
+
}): Promise<Models.Addon>;
|
|
111
|
+
/**
|
|
112
|
+
* Confirm payment for a billing addon for a project.
|
|
113
|
+
*
|
|
114
|
+
*
|
|
115
|
+
* @param {string} projectId - Project ID
|
|
116
|
+
* @param {string} addonId - Addon ID
|
|
117
|
+
* @throws {AppwriteException}
|
|
118
|
+
* @returns {Promise<Models.Addon>}
|
|
119
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
120
|
+
*/
|
|
121
|
+
confirmAddonPayment(projectId: string, addonId: string): Promise<Models.Addon>;
|
|
122
|
+
/**
|
|
123
|
+
* Get the price details for a billing addon for a project, including the prorated amount for the remaining days in the current billing cycle.
|
|
124
|
+
*
|
|
125
|
+
*
|
|
126
|
+
* @param {string} params.projectId - Project ID
|
|
127
|
+
* @param {string} params.addon - Addon key identifier (e.g. premiumGeoDB).
|
|
128
|
+
* @throws {AppwriteException}
|
|
129
|
+
* @returns {Promise<Models.AddonPrice>}
|
|
130
|
+
*/
|
|
131
|
+
getAddonPrice(params: {
|
|
132
|
+
projectId: string;
|
|
133
|
+
addon: string;
|
|
134
|
+
}): Promise<Models.AddonPrice>;
|
|
135
|
+
/**
|
|
136
|
+
* Get the price details for a billing addon for a project, including the prorated amount for the remaining days in the current billing cycle.
|
|
137
|
+
*
|
|
138
|
+
*
|
|
139
|
+
* @param {string} projectId - Project ID
|
|
140
|
+
* @param {string} addon - Addon key identifier (e.g. premiumGeoDB).
|
|
141
|
+
* @throws {AppwriteException}
|
|
142
|
+
* @returns {Promise<Models.AddonPrice>}
|
|
143
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
144
|
+
*/
|
|
145
|
+
getAddonPrice(projectId: string, addon: string): Promise<Models.AddonPrice>;
|
|
8
146
|
/**
|
|
9
147
|
* Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.
|
|
10
148
|
*
|
|
@@ -226,6 +364,54 @@ export declare class Projects {
|
|
|
226
364
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
227
365
|
*/
|
|
228
366
|
getSchedule(projectId: string, scheduleId: string): Promise<Models.Schedule>;
|
|
367
|
+
/**
|
|
368
|
+
* Get the onboarding stages for the current project, including each stage’s SDK method key and status (for example pending, completed, or skipped).
|
|
369
|
+
*
|
|
370
|
+
*
|
|
371
|
+
* @param {string} params.projectId - Project unique ID.
|
|
372
|
+
* @throws {AppwriteException}
|
|
373
|
+
* @returns {Promise<Models.StageList>}
|
|
374
|
+
*/
|
|
375
|
+
listStages(params: {
|
|
376
|
+
projectId: string;
|
|
377
|
+
}): Promise<Models.StageList>;
|
|
378
|
+
/**
|
|
379
|
+
* Get the onboarding stages for the current project, including each stage’s SDK method key and status (for example pending, completed, or skipped).
|
|
380
|
+
*
|
|
381
|
+
*
|
|
382
|
+
* @param {string} projectId - Project unique ID.
|
|
383
|
+
* @throws {AppwriteException}
|
|
384
|
+
* @returns {Promise<Models.StageList>}
|
|
385
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
386
|
+
*/
|
|
387
|
+
listStages(projectId: string): Promise<Models.StageList>;
|
|
388
|
+
/**
|
|
389
|
+
* Update an onboarding stage for the current project. Use this endpoint to skip a stage or leave it unchanged without performing the related API action.
|
|
390
|
+
*
|
|
391
|
+
*
|
|
392
|
+
* @param {string} params.projectId - Project unique ID.
|
|
393
|
+
* @param {string} params.stageId - SDK method key (namespace.method).
|
|
394
|
+
* @param {boolean} params.skip - Mark the stage as skipped.
|
|
395
|
+
* @throws {AppwriteException}
|
|
396
|
+
* @returns {Promise<Models.Stage>}
|
|
397
|
+
*/
|
|
398
|
+
updateStage(params: {
|
|
399
|
+
projectId: string;
|
|
400
|
+
stageId: string;
|
|
401
|
+
skip?: boolean;
|
|
402
|
+
}): Promise<Models.Stage>;
|
|
403
|
+
/**
|
|
404
|
+
* Update an onboarding stage for the current project. Use this endpoint to skip a stage or leave it unchanged without performing the related API action.
|
|
405
|
+
*
|
|
406
|
+
*
|
|
407
|
+
* @param {string} projectId - Project unique ID.
|
|
408
|
+
* @param {string} stageId - SDK method key (namespace.method).
|
|
409
|
+
* @param {boolean} skip - Mark the stage as skipped.
|
|
410
|
+
* @throws {AppwriteException}
|
|
411
|
+
* @returns {Promise<Models.Stage>}
|
|
412
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
413
|
+
*/
|
|
414
|
+
updateStage(projectId: string, stageId: string, skip?: boolean): Promise<Models.Stage>;
|
|
229
415
|
/**
|
|
230
416
|
* Update the status of a project. Can be used to archive/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.
|
|
231
417
|
*
|
|
@@ -40,7 +40,7 @@ export declare class TablesDB {
|
|
|
40
40
|
* @param {string} params.databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
41
41
|
* @param {string} params.name - Database name. Max length: 128 chars.
|
|
42
42
|
* @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
43
|
-
* @param {string} params.
|
|
43
|
+
* @param {string} params.specification - Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
|
|
44
44
|
* @throws {AppwriteException}
|
|
45
45
|
* @returns {Promise<Models.Database>}
|
|
46
46
|
*/
|
|
@@ -48,7 +48,7 @@ export declare class TablesDB {
|
|
|
48
48
|
databaseId: string;
|
|
49
49
|
name: string;
|
|
50
50
|
enabled?: boolean;
|
|
51
|
-
|
|
51
|
+
specification?: string;
|
|
52
52
|
}): Promise<Models.Database>;
|
|
53
53
|
/**
|
|
54
54
|
* Create a new Database.
|
|
@@ -57,12 +57,12 @@ export declare class TablesDB {
|
|
|
57
57
|
* @param {string} databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
58
58
|
* @param {string} name - Database name. Max length: 128 chars.
|
|
59
59
|
* @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
60
|
-
* @param {string}
|
|
60
|
+
* @param {string} specification - Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
|
|
61
61
|
* @throws {AppwriteException}
|
|
62
62
|
* @returns {Promise<Models.Database>}
|
|
63
63
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
64
64
|
*/
|
|
65
|
-
create(databaseId: string, name: string, enabled?: boolean,
|
|
65
|
+
create(databaseId: string, name: string, enabled?: boolean, specification?: string): Promise<Models.Database>;
|
|
66
66
|
/**
|
|
67
67
|
* List transactions across all databases.
|
|
68
68
|
*
|
|
@@ -268,6 +268,91 @@ export declare class TablesDB {
|
|
|
268
268
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
269
269
|
*/
|
|
270
270
|
delete(databaseId: string): Promise<{}>;
|
|
271
|
+
/**
|
|
272
|
+
* List the dedicated migrations for a TablesDB database. A database has at most one in-flight migration.
|
|
273
|
+
*
|
|
274
|
+
* @param {string} params.databaseId - Database ID.
|
|
275
|
+
* @throws {AppwriteException}
|
|
276
|
+
* @returns {Promise<Models.DatabaseMigrationList>}
|
|
277
|
+
*/
|
|
278
|
+
listMigrations(params: {
|
|
279
|
+
databaseId: string;
|
|
280
|
+
}): Promise<Models.DatabaseMigrationList>;
|
|
281
|
+
/**
|
|
282
|
+
* List the dedicated migrations for a TablesDB database. A database has at most one in-flight migration.
|
|
283
|
+
*
|
|
284
|
+
* @param {string} databaseId - Database ID.
|
|
285
|
+
* @throws {AppwriteException}
|
|
286
|
+
* @returns {Promise<Models.DatabaseMigrationList>}
|
|
287
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
288
|
+
*/
|
|
289
|
+
listMigrations(databaseId: string): Promise<Models.DatabaseMigrationList>;
|
|
290
|
+
/**
|
|
291
|
+
* Start migrating a serverless TablesDB database onto a dedicated MySQL compute. Data is copied to the target while the source stays live, with a brief read-only window during cutover.
|
|
292
|
+
*
|
|
293
|
+
* @param {string} params.databaseId - Database ID.
|
|
294
|
+
* @param {string} params.specification - Dedicated compute specification to provision as the migration target (e.g. s-2vcpu-4gb). The migration always targets a dedicated compute, so `serverless` is not accepted.
|
|
295
|
+
* @throws {AppwriteException}
|
|
296
|
+
* @returns {Promise<Models.DatabaseMigration>}
|
|
297
|
+
*/
|
|
298
|
+
createMigration(params: {
|
|
299
|
+
databaseId: string;
|
|
300
|
+
specification: string;
|
|
301
|
+
}): Promise<Models.DatabaseMigration>;
|
|
302
|
+
/**
|
|
303
|
+
* Start migrating a serverless TablesDB database onto a dedicated MySQL compute. Data is copied to the target while the source stays live, with a brief read-only window during cutover.
|
|
304
|
+
*
|
|
305
|
+
* @param {string} databaseId - Database ID.
|
|
306
|
+
* @param {string} specification - Dedicated compute specification to provision as the migration target (e.g. s-2vcpu-4gb). The migration always targets a dedicated compute, so `serverless` is not accepted.
|
|
307
|
+
* @throws {AppwriteException}
|
|
308
|
+
* @returns {Promise<Models.DatabaseMigration>}
|
|
309
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
310
|
+
*/
|
|
311
|
+
createMigration(databaseId: string, specification: string): Promise<Models.DatabaseMigration>;
|
|
312
|
+
/**
|
|
313
|
+
* Get a single dedicated migration for a TablesDB database by its ID.
|
|
314
|
+
*
|
|
315
|
+
* @param {string} params.databaseId - Database ID.
|
|
316
|
+
* @param {string} params.migrationId - Migration ID.
|
|
317
|
+
* @throws {AppwriteException}
|
|
318
|
+
* @returns {Promise<Models.DatabaseMigration>}
|
|
319
|
+
*/
|
|
320
|
+
getMigration(params: {
|
|
321
|
+
databaseId: string;
|
|
322
|
+
migrationId: string;
|
|
323
|
+
}): Promise<Models.DatabaseMigration>;
|
|
324
|
+
/**
|
|
325
|
+
* Get a single dedicated migration for a TablesDB database by its ID.
|
|
326
|
+
*
|
|
327
|
+
* @param {string} databaseId - Database ID.
|
|
328
|
+
* @param {string} migrationId - Migration ID.
|
|
329
|
+
* @throws {AppwriteException}
|
|
330
|
+
* @returns {Promise<Models.DatabaseMigration>}
|
|
331
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
332
|
+
*/
|
|
333
|
+
getMigration(databaseId: string, migrationId: string): Promise<Models.DatabaseMigration>;
|
|
334
|
+
/**
|
|
335
|
+
* Abort an in-flight TablesDB dedicated migration. Only allowed before cutover; once the migration has cut over it cannot be aborted.
|
|
336
|
+
*
|
|
337
|
+
* @param {string} params.databaseId - Database ID.
|
|
338
|
+
* @param {string} params.migrationId - Migration ID.
|
|
339
|
+
* @throws {AppwriteException}
|
|
340
|
+
* @returns {Promise<{}>}
|
|
341
|
+
*/
|
|
342
|
+
deleteMigration(params: {
|
|
343
|
+
databaseId: string;
|
|
344
|
+
migrationId: string;
|
|
345
|
+
}): Promise<{}>;
|
|
346
|
+
/**
|
|
347
|
+
* Abort an in-flight TablesDB dedicated migration. Only allowed before cutover; once the migration has cut over it cannot be aborted.
|
|
348
|
+
*
|
|
349
|
+
* @param {string} databaseId - Database ID.
|
|
350
|
+
* @param {string} migrationId - Migration ID.
|
|
351
|
+
* @throws {AppwriteException}
|
|
352
|
+
* @returns {Promise<{}>}
|
|
353
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
354
|
+
*/
|
|
355
|
+
deleteMigration(databaseId: string, migrationId: string): Promise<{}>;
|
|
271
356
|
/**
|
|
272
357
|
* Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.
|
|
273
358
|
*
|
|
@@ -1953,31 +2038,6 @@ export declare class TablesDB {
|
|
|
1953
2038
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1954
2039
|
*/
|
|
1955
2040
|
deleteIndex(databaseId: string, tableId: string, key: string): Promise<{}>;
|
|
1956
|
-
/**
|
|
1957
|
-
* Get the table activity logs list by its unique ID.
|
|
1958
|
-
*
|
|
1959
|
-
* @param {string} params.databaseId - Database ID.
|
|
1960
|
-
* @param {string} params.tableId - Table ID.
|
|
1961
|
-
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1962
|
-
* @throws {AppwriteException}
|
|
1963
|
-
* @returns {Promise<Models.LogList>}
|
|
1964
|
-
*/
|
|
1965
|
-
listTableLogs(params: {
|
|
1966
|
-
databaseId: string;
|
|
1967
|
-
tableId: string;
|
|
1968
|
-
queries?: string[];
|
|
1969
|
-
}): Promise<Models.LogList>;
|
|
1970
|
-
/**
|
|
1971
|
-
* Get the table activity logs list by its unique ID.
|
|
1972
|
-
*
|
|
1973
|
-
* @param {string} databaseId - Database ID.
|
|
1974
|
-
* @param {string} tableId - Table ID.
|
|
1975
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1976
|
-
* @throws {AppwriteException}
|
|
1977
|
-
* @returns {Promise<Models.LogList>}
|
|
1978
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1979
|
-
*/
|
|
1980
|
-
listTableLogs(databaseId: string, tableId: string, queries?: string[]): Promise<Models.LogList>;
|
|
1981
2041
|
/**
|
|
1982
2042
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
1983
2043
|
*
|
|
@@ -2290,34 +2350,6 @@ export declare class TablesDB {
|
|
|
2290
2350
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2291
2351
|
*/
|
|
2292
2352
|
deleteRow(databaseId: string, tableId: string, rowId: string, transactionId?: string): Promise<{}>;
|
|
2293
|
-
/**
|
|
2294
|
-
* Get the row activity logs list by its unique ID.
|
|
2295
|
-
*
|
|
2296
|
-
* @param {string} params.databaseId - Database ID.
|
|
2297
|
-
* @param {string} params.tableId - Table ID.
|
|
2298
|
-
* @param {string} params.rowId - Row ID.
|
|
2299
|
-
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
2300
|
-
* @throws {AppwriteException}
|
|
2301
|
-
* @returns {Promise<Models.LogList>}
|
|
2302
|
-
*/
|
|
2303
|
-
listRowLogs(params: {
|
|
2304
|
-
databaseId: string;
|
|
2305
|
-
tableId: string;
|
|
2306
|
-
rowId: string;
|
|
2307
|
-
queries?: string[];
|
|
2308
|
-
}): Promise<Models.LogList>;
|
|
2309
|
-
/**
|
|
2310
|
-
* Get the row activity logs list by its unique ID.
|
|
2311
|
-
*
|
|
2312
|
-
* @param {string} databaseId - Database ID.
|
|
2313
|
-
* @param {string} tableId - Table ID.
|
|
2314
|
-
* @param {string} rowId - Row ID.
|
|
2315
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
2316
|
-
* @throws {AppwriteException}
|
|
2317
|
-
* @returns {Promise<Models.LogList>}
|
|
2318
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2319
|
-
*/
|
|
2320
|
-
listRowLogs(databaseId: string, tableId: string, rowId: string, queries?: string[]): Promise<Models.LogList>;
|
|
2321
2353
|
/**
|
|
2322
2354
|
* Decrement a specific column of a row by a given value.
|
|
2323
2355
|
*
|
|
@@ -10,13 +10,12 @@ export declare class Usage {
|
|
|
10
10
|
* - Omit `interval` for a flat top-N table — one point per dimension combination, no time axis. Useful for "top 10 paths by bandwidth in the last 7 days".
|
|
11
11
|
* - Pass `interval` (`1m`, `15m`, `30m`, `1h`, `1d`) for a time series — one point per (time bucket × dimension combination).
|
|
12
12
|
*
|
|
13
|
-
* `dimensions[]` breaks each point down by one or more attributes (service, path, status, country, …). Pass multiple metrics to render stacked charts in one round-trip. `
|
|
13
|
+
* `dimensions[]` breaks each point down by one or more attributes (service, path, status, country, …). `queries[]` filters the underlying events using the standard Utopia query syntax — `equal("path", ["/v1/storage/files"])`, `equal("resourceType", ["bucket"])`, `equal("resourceId", ["abc123"])`, `startsWith("path", ["/v1/storage"])`, `equal("status", ["200", "201"])`, `isNotNull("resourceId")`. Supported attributes: see `queries[]` param. Supported methods: `equal`, `notEqual`, `contains`, `startsWith`, `endsWith`, `isNull`, `isNotNull`. Pass multiple metrics to render stacked charts in one round-trip. `orderBy=value`+`orderDir=desc`+`limit=N` returns the top-N by aggregated value. When `startAt` is omitted, the default window adapts to `interval` (or 7d when interval is omitted).
|
|
14
14
|
*
|
|
15
15
|
* @param {string[]} params.metrics - One to ten metric names. Single-metric callers pass a one-element array. Example: `metrics[]=executions` or `metrics[]=executions&metrics[]=executions.compute` for stacked charts.
|
|
16
|
-
* @param {string} params.
|
|
17
|
-
* @param {string} params.resourceId - Resource id filter.
|
|
16
|
+
* @param {string[]} params.queries - Up to 10 filter queries in Utopia syntax. Allowed attributes: path, method, status, service, resourceType, resourceId, teamId, country, region, hostname, ip, osName, clientType, clientName, deviceName. Allowed methods: equal, notEqual, contains, startsWith, endsWith, isNull, isNotNull. Example: `queries[]=equal("resourceType", ["bucket"])`.
|
|
18
17
|
* @param {string} params.interval - Time interval size. Omit (null) for a flat aggregate over the whole window. Allowed: 1m, 15m, 30m, 1h, 1d.
|
|
19
|
-
* @param {string[]} params.dimensions - Break-down dimensions (max 10). Allowed: path, method, status, service,
|
|
18
|
+
* @param {string[]} params.dimensions - Break-down dimensions (max 10). Allowed: path, method, status, service, resourceType, country, region, hostname, ip, osName, clientType, clientName, deviceName, teamId, resourceId.
|
|
20
19
|
* @param {string} params.startAt - Range start in ISO 8601. Defaults adapt to interval (7d for the no-interval aggregate).
|
|
21
20
|
* @param {string} params.endAt - Range end in ISO 8601. Defaults to the current time.
|
|
22
21
|
* @param {string} params.orderBy - Column to order by. Allowed: time, value. Default time when an interval is set; otherwise value.
|
|
@@ -28,8 +27,7 @@ export declare class Usage {
|
|
|
28
27
|
*/
|
|
29
28
|
listEvents(params: {
|
|
30
29
|
metrics: string[];
|
|
31
|
-
|
|
32
|
-
resourceId?: string;
|
|
30
|
+
queries?: string[];
|
|
33
31
|
interval?: string;
|
|
34
32
|
dimensions?: string[];
|
|
35
33
|
startAt?: string;
|
|
@@ -46,13 +44,12 @@ export declare class Usage {
|
|
|
46
44
|
* - Omit `interval` for a flat top-N table — one point per dimension combination, no time axis. Useful for "top 10 paths by bandwidth in the last 7 days".
|
|
47
45
|
* - Pass `interval` (`1m`, `15m`, `30m`, `1h`, `1d`) for a time series — one point per (time bucket × dimension combination).
|
|
48
46
|
*
|
|
49
|
-
* `dimensions[]` breaks each point down by one or more attributes (service, path, status, country, …). Pass multiple metrics to render stacked charts in one round-trip. `
|
|
47
|
+
* `dimensions[]` breaks each point down by one or more attributes (service, path, status, country, …). `queries[]` filters the underlying events using the standard Utopia query syntax — `equal("path", ["/v1/storage/files"])`, `equal("resourceType", ["bucket"])`, `equal("resourceId", ["abc123"])`, `startsWith("path", ["/v1/storage"])`, `equal("status", ["200", "201"])`, `isNotNull("resourceId")`. Supported attributes: see `queries[]` param. Supported methods: `equal`, `notEqual`, `contains`, `startsWith`, `endsWith`, `isNull`, `isNotNull`. Pass multiple metrics to render stacked charts in one round-trip. `orderBy=value`+`orderDir=desc`+`limit=N` returns the top-N by aggregated value. When `startAt` is omitted, the default window adapts to `interval` (or 7d when interval is omitted).
|
|
50
48
|
*
|
|
51
49
|
* @param {string[]} metrics - One to ten metric names. Single-metric callers pass a one-element array. Example: `metrics[]=executions` or `metrics[]=executions&metrics[]=executions.compute` for stacked charts.
|
|
52
|
-
* @param {string}
|
|
53
|
-
* @param {string} resourceId - Resource id filter.
|
|
50
|
+
* @param {string[]} queries - Up to 10 filter queries in Utopia syntax. Allowed attributes: path, method, status, service, resourceType, resourceId, teamId, country, region, hostname, ip, osName, clientType, clientName, deviceName. Allowed methods: equal, notEqual, contains, startsWith, endsWith, isNull, isNotNull. Example: `queries[]=equal("resourceType", ["bucket"])`.
|
|
54
51
|
* @param {string} interval - Time interval size. Omit (null) for a flat aggregate over the whole window. Allowed: 1m, 15m, 30m, 1h, 1d.
|
|
55
|
-
* @param {string[]} dimensions - Break-down dimensions (max 10). Allowed: path, method, status, service,
|
|
52
|
+
* @param {string[]} dimensions - Break-down dimensions (max 10). Allowed: path, method, status, service, resourceType, country, region, hostname, ip, osName, clientType, clientName, deviceName, teamId, resourceId.
|
|
56
53
|
* @param {string} startAt - Range start in ISO 8601. Defaults adapt to interval (7d for the no-interval aggregate).
|
|
57
54
|
* @param {string} endAt - Range end in ISO 8601. Defaults to the current time.
|
|
58
55
|
* @param {string} orderBy - Column to order by. Allowed: time, value. Default time when an interval is set; otherwise value.
|
|
@@ -63,7 +60,7 @@ export declare class Usage {
|
|
|
63
60
|
* @returns {Promise<Models.UsageEventList>}
|
|
64
61
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
65
62
|
*/
|
|
66
|
-
listEvents(metrics: string[],
|
|
63
|
+
listEvents(metrics: string[], queries?: string[], interval?: string, dimensions?: string[], startAt?: string, endAt?: string, orderBy?: string, orderDir?: string, limit?: number, offset?: number): Promise<Models.UsageEventList>;
|
|
67
64
|
/**
|
|
68
65
|
* Aggregate usage gauge snapshots. Gauges are point-in-time values (storage totals, resource counts, …); each point carries the latest snapshot in its interval via `argMax(value, time)`. `metrics[]` (1-10) is required; the response always contains one entry per requested metric, each with its own `points[]` time series.
|
|
69
66
|
*
|
|
@@ -71,13 +68,12 @@ export declare class Usage {
|
|
|
71
68
|
* - Omit `interval` for a flat top-N table — `argMax(value, time)` per dimension combination over the whole window, no time axis. Useful for "top 10 resources by current storage".
|
|
72
69
|
* - Pass `interval` (`1m`, `15m`, `30m`, `1h`, `1d`) for a time series — one snapshot per (time bucket × dimension combination).
|
|
73
70
|
*
|
|
74
|
-
* `dimensions[]` breaks each point down further. Supported on gauges: `resourceId`, `teamId`, `service`, `
|
|
71
|
+
* `dimensions[]` breaks each point down further. Supported on gauges: `resourceId`, `teamId`, `service`, `resourceType`. `service` and `resourceType` enable per-service / per-resource-type panels (e.g. storage-by-service: group `files.storage`, `deployments.storage`, `builds.storage`, `databases.storage` by `service`). `queries[]` filters the underlying rows using the standard Utopia query syntax — `equal("resourceType", ["bucket"])`, `equal("resourceId", ["abc123"])`, `equal("teamId", ["team_x"])`, `isNotNull("teamId")`. Supported attributes: see `queries[]` param. Supported methods: `equal`, `notEqual`, `isNull`, `isNotNull`. Pass multiple metrics to render stacked charts in one round-trip. `orderBy=value`+`orderDir=desc`+`limit=N` returns the top-N. When `startAt` is omitted, the default window adapts to interval (or 7d when interval is omitted).
|
|
75
72
|
*
|
|
76
73
|
* @param {string[]} params.metrics - One to ten metric names. Single-metric callers pass a one-element array. Example: `metrics[]=files.storage` or `metrics[]=files.storage&metrics[]=deployments.storage` for stacked charts.
|
|
77
|
-
* @param {string} params.
|
|
78
|
-
* @param {string} params.teamId - Team id filter.
|
|
74
|
+
* @param {string[]} params.queries - Up to 10 filter queries in Utopia syntax. Allowed attributes: service, resourceType, resourceId, teamId. Allowed methods: equal, notEqual, isNull, isNotNull. Example: `queries[]=equal("resourceType", ["bucket"])`.
|
|
79
75
|
* @param {string} params.interval - Time interval size. Omit (null) for a flat aggregate over the whole window. Allowed: 1m, 15m, 30m, 1h, 1d.
|
|
80
|
-
* @param {string[]} params.dimensions - Break-down dimensions. Allowed: resourceId, teamId, service,
|
|
76
|
+
* @param {string[]} params.dimensions - Break-down dimensions. Allowed: resourceId, teamId, service, resourceType.
|
|
81
77
|
* @param {string} params.startAt - Range start in ISO 8601. Defaults to endAt - 7d.
|
|
82
78
|
* @param {string} params.endAt - Range end in ISO 8601. Defaults to the current time.
|
|
83
79
|
* @param {string} params.orderBy - Column to order by. Allowed: time, value. Default time.
|
|
@@ -89,8 +85,7 @@ export declare class Usage {
|
|
|
89
85
|
*/
|
|
90
86
|
listGauges(params: {
|
|
91
87
|
metrics: string[];
|
|
92
|
-
|
|
93
|
-
teamId?: string;
|
|
88
|
+
queries?: string[];
|
|
94
89
|
interval?: string;
|
|
95
90
|
dimensions?: string[];
|
|
96
91
|
startAt?: string;
|
|
@@ -107,13 +102,12 @@ export declare class Usage {
|
|
|
107
102
|
* - Omit `interval` for a flat top-N table — `argMax(value, time)` per dimension combination over the whole window, no time axis. Useful for "top 10 resources by current storage".
|
|
108
103
|
* - Pass `interval` (`1m`, `15m`, `30m`, `1h`, `1d`) for a time series — one snapshot per (time bucket × dimension combination).
|
|
109
104
|
*
|
|
110
|
-
* `dimensions[]` breaks each point down further. Supported on gauges: `resourceId`, `teamId`, `service`, `
|
|
105
|
+
* `dimensions[]` breaks each point down further. Supported on gauges: `resourceId`, `teamId`, `service`, `resourceType`. `service` and `resourceType` enable per-service / per-resource-type panels (e.g. storage-by-service: group `files.storage`, `deployments.storage`, `builds.storage`, `databases.storage` by `service`). `queries[]` filters the underlying rows using the standard Utopia query syntax — `equal("resourceType", ["bucket"])`, `equal("resourceId", ["abc123"])`, `equal("teamId", ["team_x"])`, `isNotNull("teamId")`. Supported attributes: see `queries[]` param. Supported methods: `equal`, `notEqual`, `isNull`, `isNotNull`. Pass multiple metrics to render stacked charts in one round-trip. `orderBy=value`+`orderDir=desc`+`limit=N` returns the top-N. When `startAt` is omitted, the default window adapts to interval (or 7d when interval is omitted).
|
|
111
106
|
*
|
|
112
107
|
* @param {string[]} metrics - One to ten metric names. Single-metric callers pass a one-element array. Example: `metrics[]=files.storage` or `metrics[]=files.storage&metrics[]=deployments.storage` for stacked charts.
|
|
113
|
-
* @param {string}
|
|
114
|
-
* @param {string} teamId - Team id filter.
|
|
108
|
+
* @param {string[]} queries - Up to 10 filter queries in Utopia syntax. Allowed attributes: service, resourceType, resourceId, teamId. Allowed methods: equal, notEqual, isNull, isNotNull. Example: `queries[]=equal("resourceType", ["bucket"])`.
|
|
115
109
|
* @param {string} interval - Time interval size. Omit (null) for a flat aggregate over the whole window. Allowed: 1m, 15m, 30m, 1h, 1d.
|
|
116
|
-
* @param {string[]} dimensions - Break-down dimensions. Allowed: resourceId, teamId, service,
|
|
110
|
+
* @param {string[]} dimensions - Break-down dimensions. Allowed: resourceId, teamId, service, resourceType.
|
|
117
111
|
* @param {string} startAt - Range start in ISO 8601. Defaults to endAt - 7d.
|
|
118
112
|
* @param {string} endAt - Range end in ISO 8601. Defaults to the current time.
|
|
119
113
|
* @param {string} orderBy - Column to order by. Allowed: time, value. Default time.
|
|
@@ -124,5 +118,5 @@ export declare class Usage {
|
|
|
124
118
|
* @returns {Promise<Models.UsageGaugeList>}
|
|
125
119
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
126
120
|
*/
|
|
127
|
-
listGauges(metrics: string[],
|
|
121
|
+
listGauges(metrics: string[], queries?: string[], interval?: string, dimensions?: string[], startAt?: string, endAt?: string, orderBy?: string, orderDir?: string, limit?: number, offset?: number): Promise<Models.UsageGaugeList>;
|
|
128
122
|
}
|
|
@@ -10,7 +10,7 @@ export declare class Users {
|
|
|
10
10
|
/**
|
|
11
11
|
* Get a list of all the project's users. You can use the query params to filter your results.
|
|
12
12
|
*
|
|
13
|
-
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator
|
|
13
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator, accessedAt
|
|
14
14
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
15
15
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
16
16
|
* @throws {AppwriteException}
|
|
@@ -24,7 +24,7 @@ export declare class Users {
|
|
|
24
24
|
/**
|
|
25
25
|
* Get a list of all the project's users. You can use the query params to filter your results.
|
|
26
26
|
*
|
|
27
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator
|
|
27
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator, accessedAt
|
|
28
28
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
29
29
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
30
30
|
* @throws {AppwriteException}
|