@appwrite.io/console 2.1.1 → 2.1.2
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 +1 -1
- package/dist/cjs/sdk.js +99 -7
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +100 -8
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +99 -7
- package/docs/examples/domains/list-suggestions.md +18 -0
- package/docs/examples/health/get-queue-audits.md +13 -0
- package/docs/examples/organizations/create.md +2 -2
- package/docs/examples/organizations/estimation-create-organization.md +2 -2
- package/docs/examples/organizations/estimation-update-plan.md +2 -2
- package/docs/examples/organizations/update-plan.md +2 -2
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/enums/billing-plan.ts +17 -0
- package/src/enums/filter-type.ts +4 -0
- package/src/enums/name.ts +1 -0
- package/src/enums/o-auth-provider.ts +0 -2
- package/src/index.ts +2 -0
- package/src/models.ts +437 -375
- 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 +89 -89
- package/src/services/domains.ts +295 -204
- package/src/services/functions.ts +30 -30
- package/src/services/health.ts +201 -152
- package/src/services/messaging.ts +54 -54
- package/src/services/migrations.ts +36 -36
- package/src/services/organizations.ts +67 -66
- package/src/services/projects.ts +81 -81
- package/src/services/sites.ts +30 -30
- package/src/services/storage.ts +45 -45
- package/src/services/tables-db.ts +89 -89
- package/src/services/users.ts +39 -39
- package/types/enums/billing-plan.d.ts +17 -0
- package/types/enums/filter-type.d.ts +4 -0
- package/types/enums/name.d.ts +1 -0
- package/types/enums/o-auth-provider.d.ts +0 -2
- package/types/index.d.ts +2 -0
- package/types/models.d.ts +434 -375
- 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 +50 -50
- package/types/services/domains.d.ts +139 -104
- package/types/services/functions.d.ts +15 -15
- package/types/services/health.d.ts +95 -78
- package/types/services/messaging.d.ts +24 -24
- package/types/services/migrations.d.ts +16 -16
- package/types/services/organizations.d.ts +37 -36
- package/types/services/projects.d.ts +36 -36
- package/types/services/sites.d.ts +15 -15
- package/types/services/storage.d.ts +30 -30
- package/types/services/tables-db.d.ts +50 -50
- 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
|
|
46
|
+
* @param {number} 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;
|
|
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
|
|
90
|
+
* @param {number} 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
|
|
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>;
|
|
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
|
|
127
|
-
* @param {number
|
|
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.
|
|
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;
|
|
136
|
+
offset?: number;
|
|
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
|
|
145
|
-
* @param {number
|
|
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.
|
|
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
|
|
151
|
+
listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number, 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
|
|
218
|
+
* @param {number} 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;
|
|
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
|
|
262
|
+
* @param {number} 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
|
|
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>;
|
|
279
279
|
/**
|
|
280
280
|
* Delete a function by its unique ID.
|
|
281
281
|
*
|
|
@@ -22,9 +22,9 @@ export declare class Health {
|
|
|
22
22
|
* Check the Appwrite in-memory cache servers are up and connection is successful.
|
|
23
23
|
*
|
|
24
24
|
* @throws {AppwriteException}
|
|
25
|
-
* @returns {Promise<Models.
|
|
25
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
26
26
|
*/
|
|
27
|
-
getCache(): Promise<Models.
|
|
27
|
+
getCache(): Promise<Models.HealthStatusList>;
|
|
28
28
|
/**
|
|
29
29
|
* Get the SSL certificate for a domain
|
|
30
30
|
*
|
|
@@ -48,366 +48,383 @@ export declare class Health {
|
|
|
48
48
|
* Check the Appwrite database servers are up and connection is successful.
|
|
49
49
|
*
|
|
50
50
|
* @throws {AppwriteException}
|
|
51
|
-
* @returns {Promise<Models.
|
|
51
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
52
52
|
*/
|
|
53
|
-
getDB(): Promise<Models.
|
|
53
|
+
getDB(): Promise<Models.HealthStatusList>;
|
|
54
54
|
/**
|
|
55
55
|
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
56
56
|
*
|
|
57
57
|
* @throws {AppwriteException}
|
|
58
|
-
* @returns {Promise<Models.
|
|
58
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
59
|
+
*/
|
|
60
|
+
getPubSub(): Promise<Models.HealthStatusList>;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
64
|
+
* @throws {AppwriteException}
|
|
65
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
66
|
+
*/
|
|
67
|
+
getQueueAudits(params?: {
|
|
68
|
+
threshold?: number;
|
|
69
|
+
}): Promise<Models.HealthQueue>;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
73
|
+
* @throws {AppwriteException}
|
|
74
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
75
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
59
76
|
*/
|
|
60
|
-
|
|
77
|
+
getQueueAudits(threshold?: number): Promise<Models.HealthQueue>;
|
|
61
78
|
/**
|
|
62
79
|
* Get billing project aggregation queue.
|
|
63
80
|
*
|
|
64
|
-
* @param {number
|
|
81
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
65
82
|
* @throws {AppwriteException}
|
|
66
83
|
* @returns {Promise<Models.HealthQueue>}
|
|
67
84
|
*/
|
|
68
85
|
getQueueBillingProjectAggregation(params?: {
|
|
69
|
-
threshold?: number
|
|
86
|
+
threshold?: number;
|
|
70
87
|
}): Promise<Models.HealthQueue>;
|
|
71
88
|
/**
|
|
72
89
|
* Get billing project aggregation queue.
|
|
73
90
|
*
|
|
74
|
-
* @param {number
|
|
91
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
75
92
|
* @throws {AppwriteException}
|
|
76
93
|
* @returns {Promise<Models.HealthQueue>}
|
|
77
94
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
78
95
|
*/
|
|
79
|
-
getQueueBillingProjectAggregation(threshold?: number
|
|
96
|
+
getQueueBillingProjectAggregation(threshold?: number): Promise<Models.HealthQueue>;
|
|
80
97
|
/**
|
|
81
98
|
* Get billing team aggregation queue.
|
|
82
99
|
*
|
|
83
|
-
* @param {number
|
|
100
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
84
101
|
* @throws {AppwriteException}
|
|
85
102
|
* @returns {Promise<Models.HealthQueue>}
|
|
86
103
|
*/
|
|
87
104
|
getQueueBillingTeamAggregation(params?: {
|
|
88
|
-
threshold?: number
|
|
105
|
+
threshold?: number;
|
|
89
106
|
}): Promise<Models.HealthQueue>;
|
|
90
107
|
/**
|
|
91
108
|
* Get billing team aggregation queue.
|
|
92
109
|
*
|
|
93
|
-
* @param {number
|
|
110
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
94
111
|
* @throws {AppwriteException}
|
|
95
112
|
* @returns {Promise<Models.HealthQueue>}
|
|
96
113
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
97
114
|
*/
|
|
98
|
-
getQueueBillingTeamAggregation(threshold?: number
|
|
115
|
+
getQueueBillingTeamAggregation(threshold?: number): Promise<Models.HealthQueue>;
|
|
99
116
|
/**
|
|
100
117
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
101
118
|
*
|
|
102
|
-
* @param {number
|
|
119
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
103
120
|
* @throws {AppwriteException}
|
|
104
121
|
* @returns {Promise<Models.HealthQueue>}
|
|
105
122
|
*/
|
|
106
123
|
getQueueBuilds(params?: {
|
|
107
|
-
threshold?: number
|
|
124
|
+
threshold?: number;
|
|
108
125
|
}): Promise<Models.HealthQueue>;
|
|
109
126
|
/**
|
|
110
127
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
111
128
|
*
|
|
112
|
-
* @param {number
|
|
129
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
113
130
|
* @throws {AppwriteException}
|
|
114
131
|
* @returns {Promise<Models.HealthQueue>}
|
|
115
132
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
116
133
|
*/
|
|
117
|
-
getQueueBuilds(threshold?: number
|
|
134
|
+
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
118
135
|
/**
|
|
119
136
|
* Get the priority builds queue size.
|
|
120
137
|
*
|
|
121
|
-
* @param {number
|
|
138
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
122
139
|
* @throws {AppwriteException}
|
|
123
140
|
* @returns {Promise<Models.HealthQueue>}
|
|
124
141
|
*/
|
|
125
142
|
getQueuePriorityBuilds(params?: {
|
|
126
|
-
threshold?: number
|
|
143
|
+
threshold?: number;
|
|
127
144
|
}): Promise<Models.HealthQueue>;
|
|
128
145
|
/**
|
|
129
146
|
* Get the priority builds queue size.
|
|
130
147
|
*
|
|
131
|
-
* @param {number
|
|
148
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
132
149
|
* @throws {AppwriteException}
|
|
133
150
|
* @returns {Promise<Models.HealthQueue>}
|
|
134
151
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
135
152
|
*/
|
|
136
|
-
getQueuePriorityBuilds(threshold?: number
|
|
153
|
+
getQueuePriorityBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
137
154
|
/**
|
|
138
155
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
139
156
|
*
|
|
140
|
-
* @param {number
|
|
157
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
141
158
|
* @throws {AppwriteException}
|
|
142
159
|
* @returns {Promise<Models.HealthQueue>}
|
|
143
160
|
*/
|
|
144
161
|
getQueueCertificates(params?: {
|
|
145
|
-
threshold?: number
|
|
162
|
+
threshold?: number;
|
|
146
163
|
}): Promise<Models.HealthQueue>;
|
|
147
164
|
/**
|
|
148
165
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
149
166
|
*
|
|
150
|
-
* @param {number
|
|
167
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
151
168
|
* @throws {AppwriteException}
|
|
152
169
|
* @returns {Promise<Models.HealthQueue>}
|
|
153
170
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
154
171
|
*/
|
|
155
|
-
getQueueCertificates(threshold?: number
|
|
172
|
+
getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
|
|
156
173
|
/**
|
|
157
174
|
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
158
175
|
*
|
|
159
176
|
* @param {string} params.name - Queue name for which to check the queue size
|
|
160
|
-
* @param {number
|
|
177
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
161
178
|
* @throws {AppwriteException}
|
|
162
179
|
* @returns {Promise<Models.HealthQueue>}
|
|
163
180
|
*/
|
|
164
181
|
getQueueDatabases(params?: {
|
|
165
182
|
name?: string;
|
|
166
|
-
threshold?: number
|
|
183
|
+
threshold?: number;
|
|
167
184
|
}): Promise<Models.HealthQueue>;
|
|
168
185
|
/**
|
|
169
186
|
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
170
187
|
*
|
|
171
188
|
* @param {string} name - Queue name for which to check the queue size
|
|
172
|
-
* @param {number
|
|
189
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
173
190
|
* @throws {AppwriteException}
|
|
174
191
|
* @returns {Promise<Models.HealthQueue>}
|
|
175
192
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
176
193
|
*/
|
|
177
|
-
getQueueDatabases(name?: string, threshold?: number
|
|
194
|
+
getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
|
|
178
195
|
/**
|
|
179
196
|
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
180
197
|
*
|
|
181
|
-
* @param {number
|
|
198
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
182
199
|
* @throws {AppwriteException}
|
|
183
200
|
* @returns {Promise<Models.HealthQueue>}
|
|
184
201
|
*/
|
|
185
202
|
getQueueDeletes(params?: {
|
|
186
|
-
threshold?: number
|
|
203
|
+
threshold?: number;
|
|
187
204
|
}): Promise<Models.HealthQueue>;
|
|
188
205
|
/**
|
|
189
206
|
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
190
207
|
*
|
|
191
|
-
* @param {number
|
|
208
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
192
209
|
* @throws {AppwriteException}
|
|
193
210
|
* @returns {Promise<Models.HealthQueue>}
|
|
194
211
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
212
|
*/
|
|
196
|
-
getQueueDeletes(threshold?: number
|
|
213
|
+
getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
|
|
197
214
|
/**
|
|
198
215
|
* Returns the amount of failed jobs in a given queue.
|
|
199
216
|
*
|
|
200
217
|
*
|
|
201
218
|
* @param {Name} params.name - The name of the queue
|
|
202
|
-
* @param {number
|
|
219
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
203
220
|
* @throws {AppwriteException}
|
|
204
221
|
* @returns {Promise<Models.HealthQueue>}
|
|
205
222
|
*/
|
|
206
223
|
getFailedJobs(params: {
|
|
207
224
|
name: Name;
|
|
208
|
-
threshold?: number
|
|
225
|
+
threshold?: number;
|
|
209
226
|
}): Promise<Models.HealthQueue>;
|
|
210
227
|
/**
|
|
211
228
|
* Returns the amount of failed jobs in a given queue.
|
|
212
229
|
*
|
|
213
230
|
*
|
|
214
231
|
* @param {Name} name - The name of the queue
|
|
215
|
-
* @param {number
|
|
232
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
216
233
|
* @throws {AppwriteException}
|
|
217
234
|
* @returns {Promise<Models.HealthQueue>}
|
|
218
235
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
219
236
|
*/
|
|
220
|
-
getFailedJobs(name: Name, threshold?: number
|
|
237
|
+
getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
|
|
221
238
|
/**
|
|
222
239
|
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
223
240
|
*
|
|
224
|
-
* @param {number
|
|
241
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
225
242
|
* @throws {AppwriteException}
|
|
226
243
|
* @returns {Promise<Models.HealthQueue>}
|
|
227
244
|
*/
|
|
228
245
|
getQueueFunctions(params?: {
|
|
229
|
-
threshold?: number
|
|
246
|
+
threshold?: number;
|
|
230
247
|
}): Promise<Models.HealthQueue>;
|
|
231
248
|
/**
|
|
232
249
|
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
233
250
|
*
|
|
234
|
-
* @param {number
|
|
251
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
235
252
|
* @throws {AppwriteException}
|
|
236
253
|
* @returns {Promise<Models.HealthQueue>}
|
|
237
254
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
238
255
|
*/
|
|
239
|
-
getQueueFunctions(threshold?: number
|
|
256
|
+
getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
|
|
240
257
|
/**
|
|
241
258
|
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
242
259
|
*
|
|
243
|
-
* @param {number
|
|
260
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
244
261
|
* @throws {AppwriteException}
|
|
245
262
|
* @returns {Promise<Models.HealthQueue>}
|
|
246
263
|
*/
|
|
247
264
|
getQueueLogs(params?: {
|
|
248
|
-
threshold?: number
|
|
265
|
+
threshold?: number;
|
|
249
266
|
}): Promise<Models.HealthQueue>;
|
|
250
267
|
/**
|
|
251
268
|
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
252
269
|
*
|
|
253
|
-
* @param {number
|
|
270
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
254
271
|
* @throws {AppwriteException}
|
|
255
272
|
* @returns {Promise<Models.HealthQueue>}
|
|
256
273
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
257
274
|
*/
|
|
258
|
-
getQueueLogs(threshold?: number
|
|
275
|
+
getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
|
|
259
276
|
/**
|
|
260
277
|
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
261
278
|
*
|
|
262
|
-
* @param {number
|
|
279
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
263
280
|
* @throws {AppwriteException}
|
|
264
281
|
* @returns {Promise<Models.HealthQueue>}
|
|
265
282
|
*/
|
|
266
283
|
getQueueMails(params?: {
|
|
267
|
-
threshold?: number
|
|
284
|
+
threshold?: number;
|
|
268
285
|
}): Promise<Models.HealthQueue>;
|
|
269
286
|
/**
|
|
270
287
|
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
271
288
|
*
|
|
272
|
-
* @param {number
|
|
289
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
273
290
|
* @throws {AppwriteException}
|
|
274
291
|
* @returns {Promise<Models.HealthQueue>}
|
|
275
292
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
276
293
|
*/
|
|
277
|
-
getQueueMails(threshold?: number
|
|
294
|
+
getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
|
|
278
295
|
/**
|
|
279
296
|
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
280
297
|
*
|
|
281
|
-
* @param {number
|
|
298
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
282
299
|
* @throws {AppwriteException}
|
|
283
300
|
* @returns {Promise<Models.HealthQueue>}
|
|
284
301
|
*/
|
|
285
302
|
getQueueMessaging(params?: {
|
|
286
|
-
threshold?: number
|
|
303
|
+
threshold?: number;
|
|
287
304
|
}): Promise<Models.HealthQueue>;
|
|
288
305
|
/**
|
|
289
306
|
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
290
307
|
*
|
|
291
|
-
* @param {number
|
|
308
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
292
309
|
* @throws {AppwriteException}
|
|
293
310
|
* @returns {Promise<Models.HealthQueue>}
|
|
294
311
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
295
312
|
*/
|
|
296
|
-
getQueueMessaging(threshold?: number
|
|
313
|
+
getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
|
|
297
314
|
/**
|
|
298
315
|
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
299
316
|
*
|
|
300
|
-
* @param {number
|
|
317
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
301
318
|
* @throws {AppwriteException}
|
|
302
319
|
* @returns {Promise<Models.HealthQueue>}
|
|
303
320
|
*/
|
|
304
321
|
getQueueMigrations(params?: {
|
|
305
|
-
threshold?: number
|
|
322
|
+
threshold?: number;
|
|
306
323
|
}): Promise<Models.HealthQueue>;
|
|
307
324
|
/**
|
|
308
325
|
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
309
326
|
*
|
|
310
|
-
* @param {number
|
|
327
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
311
328
|
* @throws {AppwriteException}
|
|
312
329
|
* @returns {Promise<Models.HealthQueue>}
|
|
313
330
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
314
331
|
*/
|
|
315
|
-
getQueueMigrations(threshold?: number
|
|
332
|
+
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
316
333
|
/**
|
|
317
334
|
* Get region manager queue.
|
|
318
335
|
*
|
|
319
|
-
* @param {number
|
|
336
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
320
337
|
* @throws {AppwriteException}
|
|
321
338
|
* @returns {Promise<Models.HealthQueue>}
|
|
322
339
|
*/
|
|
323
340
|
getQueueRegionManager(params?: {
|
|
324
|
-
threshold?: number
|
|
341
|
+
threshold?: number;
|
|
325
342
|
}): Promise<Models.HealthQueue>;
|
|
326
343
|
/**
|
|
327
344
|
* Get region manager queue.
|
|
328
345
|
*
|
|
329
|
-
* @param {number
|
|
346
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
330
347
|
* @throws {AppwriteException}
|
|
331
348
|
* @returns {Promise<Models.HealthQueue>}
|
|
332
349
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
333
350
|
*/
|
|
334
|
-
getQueueRegionManager(threshold?: number
|
|
351
|
+
getQueueRegionManager(threshold?: number): Promise<Models.HealthQueue>;
|
|
335
352
|
/**
|
|
336
353
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
337
354
|
*
|
|
338
|
-
* @param {number
|
|
355
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
339
356
|
* @throws {AppwriteException}
|
|
340
357
|
* @returns {Promise<Models.HealthQueue>}
|
|
341
358
|
*/
|
|
342
359
|
getQueueStatsResources(params?: {
|
|
343
|
-
threshold?: number
|
|
360
|
+
threshold?: number;
|
|
344
361
|
}): Promise<Models.HealthQueue>;
|
|
345
362
|
/**
|
|
346
363
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
347
364
|
*
|
|
348
|
-
* @param {number
|
|
365
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
349
366
|
* @throws {AppwriteException}
|
|
350
367
|
* @returns {Promise<Models.HealthQueue>}
|
|
351
368
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
352
369
|
*/
|
|
353
|
-
getQueueStatsResources(threshold?: number
|
|
370
|
+
getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
|
|
354
371
|
/**
|
|
355
372
|
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
356
373
|
*
|
|
357
|
-
* @param {number
|
|
374
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
358
375
|
* @throws {AppwriteException}
|
|
359
376
|
* @returns {Promise<Models.HealthQueue>}
|
|
360
377
|
*/
|
|
361
378
|
getQueueUsage(params?: {
|
|
362
|
-
threshold?: number
|
|
379
|
+
threshold?: number;
|
|
363
380
|
}): Promise<Models.HealthQueue>;
|
|
364
381
|
/**
|
|
365
382
|
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
366
383
|
*
|
|
367
|
-
* @param {number
|
|
384
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
368
385
|
* @throws {AppwriteException}
|
|
369
386
|
* @returns {Promise<Models.HealthQueue>}
|
|
370
387
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
371
388
|
*/
|
|
372
|
-
getQueueUsage(threshold?: number
|
|
389
|
+
getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
|
|
373
390
|
/**
|
|
374
391
|
* Get threats queue.
|
|
375
392
|
*
|
|
376
|
-
* @param {number
|
|
393
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
377
394
|
* @throws {AppwriteException}
|
|
378
395
|
* @returns {Promise<Models.HealthQueue>}
|
|
379
396
|
*/
|
|
380
397
|
getQueueThreats(params?: {
|
|
381
|
-
threshold?: number
|
|
398
|
+
threshold?: number;
|
|
382
399
|
}): Promise<Models.HealthQueue>;
|
|
383
400
|
/**
|
|
384
401
|
* Get threats queue.
|
|
385
402
|
*
|
|
386
|
-
* @param {number
|
|
403
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
387
404
|
* @throws {AppwriteException}
|
|
388
405
|
* @returns {Promise<Models.HealthQueue>}
|
|
389
406
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
390
407
|
*/
|
|
391
|
-
getQueueThreats(threshold?: number
|
|
408
|
+
getQueueThreats(threshold?: number): Promise<Models.HealthQueue>;
|
|
392
409
|
/**
|
|
393
410
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
394
411
|
*
|
|
395
|
-
* @param {number
|
|
412
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
396
413
|
* @throws {AppwriteException}
|
|
397
414
|
* @returns {Promise<Models.HealthQueue>}
|
|
398
415
|
*/
|
|
399
416
|
getQueueWebhooks(params?: {
|
|
400
|
-
threshold?: number
|
|
417
|
+
threshold?: number;
|
|
401
418
|
}): Promise<Models.HealthQueue>;
|
|
402
419
|
/**
|
|
403
420
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
404
421
|
*
|
|
405
|
-
* @param {number
|
|
422
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
406
423
|
* @throws {AppwriteException}
|
|
407
424
|
* @returns {Promise<Models.HealthQueue>}
|
|
408
425
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
409
426
|
*/
|
|
410
|
-
getQueueWebhooks(threshold?: number
|
|
427
|
+
getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
|
|
411
428
|
/**
|
|
412
429
|
* Check the Appwrite storage device is up and connection is successful.
|
|
413
430
|
*
|