@appwrite.io/console 2.1.0 → 2.1.1
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/CHANGELOG.md +4 -0
- package/README.md +2 -2
- package/dist/cjs/sdk.js +55 -16
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +51 -16
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +3812 -16
- package/docs/examples/projects/update-labels.md +14 -0
- package/package.json +7 -1
- package/rollup.config.js +40 -24
- package/src/client.ts +20 -10
- package/src/models.ts +432 -424
- package/src/query.ts +14 -11
- package/src/services/account.ts +20 -20
- package/src/services/avatars.ts +117 -117
- package/src/services/backups.ts +18 -18
- package/src/services/console.ts +24 -24
- package/src/services/databases.ts +119 -119
- package/src/services/domains.ts +204 -204
- package/src/services/functions.ts +30 -30
- package/src/services/health.ts +146 -146
- package/src/services/messaging.ts +54 -54
- package/src/services/migrations.ts +36 -36
- package/src/services/organizations.ts +42 -42
- package/src/services/projects.ts +146 -83
- package/src/services/sites.ts +30 -30
- package/src/services/storage.ts +49 -49
- package/src/services/tables-db.ts +119 -119
- package/src/services/users.ts +39 -39
- package/types/client.d.ts +8 -1
- package/types/models.d.ts +432 -424
- package/types/query.d.ts +8 -8
- package/types/services/account.d.ts +11 -11
- package/types/services/avatars.d.ts +82 -82
- package/types/services/backups.d.ts +8 -8
- package/types/services/console.d.ts +14 -14
- package/types/services/databases.d.ts +70 -70
- package/types/services/domains.d.ts +104 -104
- package/types/services/functions.d.ts +15 -15
- package/types/services/health.d.ts +72 -72
- package/types/services/messaging.d.ts +24 -24
- package/types/services/migrations.d.ts +16 -16
- package/types/services/organizations.d.ts +22 -22
- package/types/services/projects.d.ts +60 -38
- package/types/services/sites.d.ts +15 -15
- package/types/services/storage.d.ts +34 -34
- package/types/services/tables-db.d.ts +70 -70
- package/types/services/users.d.ts +24 -24
|
@@ -43,7 +43,7 @@ export declare class Functions {
|
|
|
43
43
|
* @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
44
44
|
* @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
|
|
45
45
|
* @param {string} params.schedule - Schedule CRON syntax.
|
|
46
|
-
* @param {number} params.timeout - Function maximum execution time in seconds.
|
|
46
|
+
* @param {number | bigint} params.timeout - Function maximum execution time in seconds.
|
|
47
47
|
* @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
|
|
48
48
|
* @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
49
49
|
* @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
@@ -65,7 +65,7 @@ export declare class Functions {
|
|
|
65
65
|
execute?: string[];
|
|
66
66
|
events?: string[];
|
|
67
67
|
schedule?: string;
|
|
68
|
-
timeout?: number;
|
|
68
|
+
timeout?: number | bigint;
|
|
69
69
|
enabled?: boolean;
|
|
70
70
|
logging?: boolean;
|
|
71
71
|
entrypoint?: string;
|
|
@@ -87,7 +87,7 @@ export declare class Functions {
|
|
|
87
87
|
* @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
88
88
|
* @param {string[]} events - Events list. Maximum of 100 events are allowed.
|
|
89
89
|
* @param {string} schedule - Schedule CRON syntax.
|
|
90
|
-
* @param {number} timeout - Function maximum execution time in seconds.
|
|
90
|
+
* @param {number | bigint} timeout - Function maximum execution time in seconds.
|
|
91
91
|
* @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
|
|
92
92
|
* @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
93
93
|
* @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
@@ -103,7 +103,7 @@ export declare class Functions {
|
|
|
103
103
|
* @returns {Promise<Models.Function>}
|
|
104
104
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
105
105
|
*/
|
|
106
|
-
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
|
|
106
|
+
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number | bigint, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
|
|
107
107
|
/**
|
|
108
108
|
* Get a list of all runtimes that are currently active on your instance.
|
|
109
109
|
*
|
|
@@ -123,8 +123,8 @@ export declare class Functions {
|
|
|
123
123
|
*
|
|
124
124
|
* @param {string[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
|
|
125
125
|
* @param {string[]} params.useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
|
|
126
|
-
* @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
127
|
-
* @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
126
|
+
* @param {number | bigint} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
127
|
+
* @param {number | bigint} params.offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
128
128
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
129
129
|
* @throws {AppwriteException}
|
|
130
130
|
* @returns {Promise<Models.TemplateFunctionList>}
|
|
@@ -132,8 +132,8 @@ export declare class Functions {
|
|
|
132
132
|
listTemplates(params?: {
|
|
133
133
|
runtimes?: string[];
|
|
134
134
|
useCases?: string[];
|
|
135
|
-
limit?: number;
|
|
136
|
-
offset?: number;
|
|
135
|
+
limit?: number | bigint;
|
|
136
|
+
offset?: number | bigint;
|
|
137
137
|
total?: boolean;
|
|
138
138
|
}): Promise<Models.TemplateFunctionList>;
|
|
139
139
|
/**
|
|
@@ -141,14 +141,14 @@ export declare class Functions {
|
|
|
141
141
|
*
|
|
142
142
|
* @param {string[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
|
|
143
143
|
* @param {string[]} useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
|
|
144
|
-
* @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
145
|
-
* @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
144
|
+
* @param {number | bigint} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
145
|
+
* @param {number | bigint} offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
146
146
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
147
147
|
* @throws {AppwriteException}
|
|
148
148
|
* @returns {Promise<Models.TemplateFunctionList>}
|
|
149
149
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
150
150
|
*/
|
|
151
|
-
listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
|
|
151
|
+
listTemplates(runtimes?: string[], useCases?: string[], limit?: number | bigint, offset?: number | bigint, total?: boolean): Promise<Models.TemplateFunctionList>;
|
|
152
152
|
/**
|
|
153
153
|
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
154
154
|
*
|
|
@@ -215,7 +215,7 @@ export declare class Functions {
|
|
|
215
215
|
* @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
216
216
|
* @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
|
|
217
217
|
* @param {string} params.schedule - Schedule CRON syntax.
|
|
218
|
-
* @param {number} params.timeout - Maximum execution time in seconds.
|
|
218
|
+
* @param {number | bigint} params.timeout - Maximum execution time in seconds.
|
|
219
219
|
* @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
|
|
220
220
|
* @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
221
221
|
* @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
@@ -237,7 +237,7 @@ export declare class Functions {
|
|
|
237
237
|
execute?: string[];
|
|
238
238
|
events?: string[];
|
|
239
239
|
schedule?: string;
|
|
240
|
-
timeout?: number;
|
|
240
|
+
timeout?: number | bigint;
|
|
241
241
|
enabled?: boolean;
|
|
242
242
|
logging?: boolean;
|
|
243
243
|
entrypoint?: string;
|
|
@@ -259,7 +259,7 @@ export declare class Functions {
|
|
|
259
259
|
* @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
260
260
|
* @param {string[]} events - Events list. Maximum of 100 events are allowed.
|
|
261
261
|
* @param {string} schedule - Schedule CRON syntax.
|
|
262
|
-
* @param {number} timeout - Maximum execution time in seconds.
|
|
262
|
+
* @param {number | bigint} timeout - Maximum execution time in seconds.
|
|
263
263
|
* @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
|
|
264
264
|
* @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
265
265
|
* @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
@@ -275,7 +275,7 @@ export declare class Functions {
|
|
|
275
275
|
* @returns {Promise<Models.Function>}
|
|
276
276
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
277
277
|
*/
|
|
278
|
-
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
|
|
278
|
+
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number | bigint, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
|
|
279
279
|
/**
|
|
280
280
|
* Delete a function by its unique ID.
|
|
281
281
|
*
|
|
@@ -61,353 +61,353 @@ export declare class Health {
|
|
|
61
61
|
/**
|
|
62
62
|
* Get billing project aggregation queue.
|
|
63
63
|
*
|
|
64
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
64
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
65
65
|
* @throws {AppwriteException}
|
|
66
66
|
* @returns {Promise<Models.HealthQueue>}
|
|
67
67
|
*/
|
|
68
68
|
getQueueBillingProjectAggregation(params?: {
|
|
69
|
-
threshold?: number;
|
|
69
|
+
threshold?: number | bigint;
|
|
70
70
|
}): Promise<Models.HealthQueue>;
|
|
71
71
|
/**
|
|
72
72
|
* Get billing project aggregation queue.
|
|
73
73
|
*
|
|
74
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
74
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
75
75
|
* @throws {AppwriteException}
|
|
76
76
|
* @returns {Promise<Models.HealthQueue>}
|
|
77
77
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
78
78
|
*/
|
|
79
|
-
getQueueBillingProjectAggregation(threshold?: number): Promise<Models.HealthQueue>;
|
|
79
|
+
getQueueBillingProjectAggregation(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
80
80
|
/**
|
|
81
81
|
* Get billing team aggregation queue.
|
|
82
82
|
*
|
|
83
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
83
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
84
84
|
* @throws {AppwriteException}
|
|
85
85
|
* @returns {Promise<Models.HealthQueue>}
|
|
86
86
|
*/
|
|
87
87
|
getQueueBillingTeamAggregation(params?: {
|
|
88
|
-
threshold?: number;
|
|
88
|
+
threshold?: number | bigint;
|
|
89
89
|
}): Promise<Models.HealthQueue>;
|
|
90
90
|
/**
|
|
91
91
|
* Get billing team aggregation queue.
|
|
92
92
|
*
|
|
93
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
93
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
94
94
|
* @throws {AppwriteException}
|
|
95
95
|
* @returns {Promise<Models.HealthQueue>}
|
|
96
96
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
97
97
|
*/
|
|
98
|
-
getQueueBillingTeamAggregation(threshold?: number): Promise<Models.HealthQueue>;
|
|
98
|
+
getQueueBillingTeamAggregation(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
99
99
|
/**
|
|
100
100
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
101
101
|
*
|
|
102
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
102
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
103
103
|
* @throws {AppwriteException}
|
|
104
104
|
* @returns {Promise<Models.HealthQueue>}
|
|
105
105
|
*/
|
|
106
106
|
getQueueBuilds(params?: {
|
|
107
|
-
threshold?: number;
|
|
107
|
+
threshold?: number | bigint;
|
|
108
108
|
}): Promise<Models.HealthQueue>;
|
|
109
109
|
/**
|
|
110
110
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
111
111
|
*
|
|
112
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
112
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
113
113
|
* @throws {AppwriteException}
|
|
114
114
|
* @returns {Promise<Models.HealthQueue>}
|
|
115
115
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
116
116
|
*/
|
|
117
|
-
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
117
|
+
getQueueBuilds(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
118
118
|
/**
|
|
119
119
|
* Get the priority builds queue size.
|
|
120
120
|
*
|
|
121
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
121
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
122
122
|
* @throws {AppwriteException}
|
|
123
123
|
* @returns {Promise<Models.HealthQueue>}
|
|
124
124
|
*/
|
|
125
125
|
getQueuePriorityBuilds(params?: {
|
|
126
|
-
threshold?: number;
|
|
126
|
+
threshold?: number | bigint;
|
|
127
127
|
}): Promise<Models.HealthQueue>;
|
|
128
128
|
/**
|
|
129
129
|
* Get the priority builds queue size.
|
|
130
130
|
*
|
|
131
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
131
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
132
132
|
* @throws {AppwriteException}
|
|
133
133
|
* @returns {Promise<Models.HealthQueue>}
|
|
134
134
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
135
135
|
*/
|
|
136
|
-
getQueuePriorityBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
136
|
+
getQueuePriorityBuilds(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
137
137
|
/**
|
|
138
138
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
139
139
|
*
|
|
140
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
140
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
141
141
|
* @throws {AppwriteException}
|
|
142
142
|
* @returns {Promise<Models.HealthQueue>}
|
|
143
143
|
*/
|
|
144
144
|
getQueueCertificates(params?: {
|
|
145
|
-
threshold?: number;
|
|
145
|
+
threshold?: number | bigint;
|
|
146
146
|
}): Promise<Models.HealthQueue>;
|
|
147
147
|
/**
|
|
148
148
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
149
149
|
*
|
|
150
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
150
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
151
151
|
* @throws {AppwriteException}
|
|
152
152
|
* @returns {Promise<Models.HealthQueue>}
|
|
153
153
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
154
154
|
*/
|
|
155
|
-
getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
|
|
155
|
+
getQueueCertificates(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
156
156
|
/**
|
|
157
157
|
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
158
158
|
*
|
|
159
159
|
* @param {string} params.name - Queue name for which to check the queue size
|
|
160
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
160
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
161
161
|
* @throws {AppwriteException}
|
|
162
162
|
* @returns {Promise<Models.HealthQueue>}
|
|
163
163
|
*/
|
|
164
164
|
getQueueDatabases(params?: {
|
|
165
165
|
name?: string;
|
|
166
|
-
threshold?: number;
|
|
166
|
+
threshold?: number | bigint;
|
|
167
167
|
}): Promise<Models.HealthQueue>;
|
|
168
168
|
/**
|
|
169
169
|
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
170
170
|
*
|
|
171
171
|
* @param {string} name - Queue name for which to check the queue size
|
|
172
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
172
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
173
173
|
* @throws {AppwriteException}
|
|
174
174
|
* @returns {Promise<Models.HealthQueue>}
|
|
175
175
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
176
176
|
*/
|
|
177
|
-
getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
|
|
177
|
+
getQueueDatabases(name?: string, threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
178
178
|
/**
|
|
179
179
|
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
180
180
|
*
|
|
181
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
181
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
182
182
|
* @throws {AppwriteException}
|
|
183
183
|
* @returns {Promise<Models.HealthQueue>}
|
|
184
184
|
*/
|
|
185
185
|
getQueueDeletes(params?: {
|
|
186
|
-
threshold?: number;
|
|
186
|
+
threshold?: number | bigint;
|
|
187
187
|
}): Promise<Models.HealthQueue>;
|
|
188
188
|
/**
|
|
189
189
|
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
190
190
|
*
|
|
191
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
191
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
192
192
|
* @throws {AppwriteException}
|
|
193
193
|
* @returns {Promise<Models.HealthQueue>}
|
|
194
194
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
195
|
*/
|
|
196
|
-
getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
|
|
196
|
+
getQueueDeletes(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
197
197
|
/**
|
|
198
198
|
* Returns the amount of failed jobs in a given queue.
|
|
199
199
|
*
|
|
200
200
|
*
|
|
201
201
|
* @param {Name} params.name - The name of the queue
|
|
202
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
202
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
203
203
|
* @throws {AppwriteException}
|
|
204
204
|
* @returns {Promise<Models.HealthQueue>}
|
|
205
205
|
*/
|
|
206
206
|
getFailedJobs(params: {
|
|
207
207
|
name: Name;
|
|
208
|
-
threshold?: number;
|
|
208
|
+
threshold?: number | bigint;
|
|
209
209
|
}): Promise<Models.HealthQueue>;
|
|
210
210
|
/**
|
|
211
211
|
* Returns the amount of failed jobs in a given queue.
|
|
212
212
|
*
|
|
213
213
|
*
|
|
214
214
|
* @param {Name} name - The name of the queue
|
|
215
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
215
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
216
216
|
* @throws {AppwriteException}
|
|
217
217
|
* @returns {Promise<Models.HealthQueue>}
|
|
218
218
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
219
219
|
*/
|
|
220
|
-
getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
|
|
220
|
+
getFailedJobs(name: Name, threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
221
221
|
/**
|
|
222
222
|
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
223
223
|
*
|
|
224
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
224
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
225
225
|
* @throws {AppwriteException}
|
|
226
226
|
* @returns {Promise<Models.HealthQueue>}
|
|
227
227
|
*/
|
|
228
228
|
getQueueFunctions(params?: {
|
|
229
|
-
threshold?: number;
|
|
229
|
+
threshold?: number | bigint;
|
|
230
230
|
}): Promise<Models.HealthQueue>;
|
|
231
231
|
/**
|
|
232
232
|
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
233
233
|
*
|
|
234
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
234
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
235
235
|
* @throws {AppwriteException}
|
|
236
236
|
* @returns {Promise<Models.HealthQueue>}
|
|
237
237
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
238
238
|
*/
|
|
239
|
-
getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
|
|
239
|
+
getQueueFunctions(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
240
240
|
/**
|
|
241
241
|
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
242
242
|
*
|
|
243
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
243
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
244
244
|
* @throws {AppwriteException}
|
|
245
245
|
* @returns {Promise<Models.HealthQueue>}
|
|
246
246
|
*/
|
|
247
247
|
getQueueLogs(params?: {
|
|
248
|
-
threshold?: number;
|
|
248
|
+
threshold?: number | bigint;
|
|
249
249
|
}): Promise<Models.HealthQueue>;
|
|
250
250
|
/**
|
|
251
251
|
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
252
252
|
*
|
|
253
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
253
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
254
254
|
* @throws {AppwriteException}
|
|
255
255
|
* @returns {Promise<Models.HealthQueue>}
|
|
256
256
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
257
257
|
*/
|
|
258
|
-
getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
|
|
258
|
+
getQueueLogs(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
259
259
|
/**
|
|
260
260
|
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
261
261
|
*
|
|
262
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
262
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
263
263
|
* @throws {AppwriteException}
|
|
264
264
|
* @returns {Promise<Models.HealthQueue>}
|
|
265
265
|
*/
|
|
266
266
|
getQueueMails(params?: {
|
|
267
|
-
threshold?: number;
|
|
267
|
+
threshold?: number | bigint;
|
|
268
268
|
}): Promise<Models.HealthQueue>;
|
|
269
269
|
/**
|
|
270
270
|
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
271
271
|
*
|
|
272
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
272
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
273
273
|
* @throws {AppwriteException}
|
|
274
274
|
* @returns {Promise<Models.HealthQueue>}
|
|
275
275
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
276
276
|
*/
|
|
277
|
-
getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
|
|
277
|
+
getQueueMails(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
278
278
|
/**
|
|
279
279
|
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
280
280
|
*
|
|
281
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
281
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
282
282
|
* @throws {AppwriteException}
|
|
283
283
|
* @returns {Promise<Models.HealthQueue>}
|
|
284
284
|
*/
|
|
285
285
|
getQueueMessaging(params?: {
|
|
286
|
-
threshold?: number;
|
|
286
|
+
threshold?: number | bigint;
|
|
287
287
|
}): Promise<Models.HealthQueue>;
|
|
288
288
|
/**
|
|
289
289
|
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
290
290
|
*
|
|
291
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
291
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
292
292
|
* @throws {AppwriteException}
|
|
293
293
|
* @returns {Promise<Models.HealthQueue>}
|
|
294
294
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
295
295
|
*/
|
|
296
|
-
getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
|
|
296
|
+
getQueueMessaging(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
297
297
|
/**
|
|
298
298
|
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
299
299
|
*
|
|
300
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
300
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
301
301
|
* @throws {AppwriteException}
|
|
302
302
|
* @returns {Promise<Models.HealthQueue>}
|
|
303
303
|
*/
|
|
304
304
|
getQueueMigrations(params?: {
|
|
305
|
-
threshold?: number;
|
|
305
|
+
threshold?: number | bigint;
|
|
306
306
|
}): Promise<Models.HealthQueue>;
|
|
307
307
|
/**
|
|
308
308
|
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
309
309
|
*
|
|
310
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
310
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
311
311
|
* @throws {AppwriteException}
|
|
312
312
|
* @returns {Promise<Models.HealthQueue>}
|
|
313
313
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
314
314
|
*/
|
|
315
|
-
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
315
|
+
getQueueMigrations(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
316
316
|
/**
|
|
317
317
|
* Get region manager queue.
|
|
318
318
|
*
|
|
319
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
319
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
320
320
|
* @throws {AppwriteException}
|
|
321
321
|
* @returns {Promise<Models.HealthQueue>}
|
|
322
322
|
*/
|
|
323
323
|
getQueueRegionManager(params?: {
|
|
324
|
-
threshold?: number;
|
|
324
|
+
threshold?: number | bigint;
|
|
325
325
|
}): Promise<Models.HealthQueue>;
|
|
326
326
|
/**
|
|
327
327
|
* Get region manager queue.
|
|
328
328
|
*
|
|
329
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
329
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
330
330
|
* @throws {AppwriteException}
|
|
331
331
|
* @returns {Promise<Models.HealthQueue>}
|
|
332
332
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
333
333
|
*/
|
|
334
|
-
getQueueRegionManager(threshold?: number): Promise<Models.HealthQueue>;
|
|
334
|
+
getQueueRegionManager(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
335
335
|
/**
|
|
336
336
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
337
337
|
*
|
|
338
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
338
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
339
339
|
* @throws {AppwriteException}
|
|
340
340
|
* @returns {Promise<Models.HealthQueue>}
|
|
341
341
|
*/
|
|
342
342
|
getQueueStatsResources(params?: {
|
|
343
|
-
threshold?: number;
|
|
343
|
+
threshold?: number | bigint;
|
|
344
344
|
}): Promise<Models.HealthQueue>;
|
|
345
345
|
/**
|
|
346
346
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
347
347
|
*
|
|
348
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
348
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
349
349
|
* @throws {AppwriteException}
|
|
350
350
|
* @returns {Promise<Models.HealthQueue>}
|
|
351
351
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
352
352
|
*/
|
|
353
|
-
getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
|
|
353
|
+
getQueueStatsResources(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
354
354
|
/**
|
|
355
355
|
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
356
356
|
*
|
|
357
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
357
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
358
358
|
* @throws {AppwriteException}
|
|
359
359
|
* @returns {Promise<Models.HealthQueue>}
|
|
360
360
|
*/
|
|
361
361
|
getQueueUsage(params?: {
|
|
362
|
-
threshold?: number;
|
|
362
|
+
threshold?: number | bigint;
|
|
363
363
|
}): Promise<Models.HealthQueue>;
|
|
364
364
|
/**
|
|
365
365
|
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
366
366
|
*
|
|
367
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
367
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
368
368
|
* @throws {AppwriteException}
|
|
369
369
|
* @returns {Promise<Models.HealthQueue>}
|
|
370
370
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
371
371
|
*/
|
|
372
|
-
getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
|
|
372
|
+
getQueueUsage(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
373
373
|
/**
|
|
374
374
|
* Get threats queue.
|
|
375
375
|
*
|
|
376
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
376
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
377
377
|
* @throws {AppwriteException}
|
|
378
378
|
* @returns {Promise<Models.HealthQueue>}
|
|
379
379
|
*/
|
|
380
380
|
getQueueThreats(params?: {
|
|
381
|
-
threshold?: number;
|
|
381
|
+
threshold?: number | bigint;
|
|
382
382
|
}): Promise<Models.HealthQueue>;
|
|
383
383
|
/**
|
|
384
384
|
* Get threats queue.
|
|
385
385
|
*
|
|
386
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
386
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
387
387
|
* @throws {AppwriteException}
|
|
388
388
|
* @returns {Promise<Models.HealthQueue>}
|
|
389
389
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
390
390
|
*/
|
|
391
|
-
getQueueThreats(threshold?: number): Promise<Models.HealthQueue>;
|
|
391
|
+
getQueueThreats(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
392
392
|
/**
|
|
393
393
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
394
394
|
*
|
|
395
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
395
|
+
* @param {number | bigint} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
396
396
|
* @throws {AppwriteException}
|
|
397
397
|
* @returns {Promise<Models.HealthQueue>}
|
|
398
398
|
*/
|
|
399
399
|
getQueueWebhooks(params?: {
|
|
400
|
-
threshold?: number;
|
|
400
|
+
threshold?: number | bigint;
|
|
401
401
|
}): Promise<Models.HealthQueue>;
|
|
402
402
|
/**
|
|
403
403
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
404
404
|
*
|
|
405
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
405
|
+
* @param {number | bigint} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
406
406
|
* @throws {AppwriteException}
|
|
407
407
|
* @returns {Promise<Models.HealthQueue>}
|
|
408
408
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
409
409
|
*/
|
|
410
|
-
getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
|
|
410
|
+
getQueueWebhooks(threshold?: number | bigint): Promise<Models.HealthQueue>;
|
|
411
411
|
/**
|
|
412
412
|
* Check the Appwrite storage device is up and connection is successful.
|
|
413
413
|
*
|