node-appwrite 17.2.0 → 18.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -2
- package/dist/client.js +3 -3
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +3 -3
- package/dist/client.mjs.map +1 -1
- package/dist/enums/{v-c-s-deployment-type.js → vcs-deployment-type.js} +1 -1
- package/dist/enums/vcs-deployment-type.js.map +1 -0
- package/dist/enums/{v-c-s-deployment-type.mjs → vcs-deployment-type.mjs} +2 -2
- package/dist/enums/vcs-deployment-type.mjs.map +1 -0
- package/dist/index.d.mts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +7 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -1
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +717 -58
- package/dist/models.d.ts +717 -58
- package/dist/query.d.mts +70 -0
- package/dist/query.d.ts +70 -0
- package/dist/query.js +70 -0
- package/dist/query.js.map +1 -1
- package/dist/query.mjs +70 -0
- package/dist/query.mjs.map +1 -1
- package/dist/services/account.d.mts +625 -70
- package/dist/services/account.d.ts +625 -70
- package/dist/services/account.js +592 -292
- package/dist/services/account.js.map +1 -1
- package/dist/services/account.mjs +592 -292
- package/dist/services/account.mjs.map +1 -1
- package/dist/services/avatars.d.mts +157 -26
- package/dist/services/avatars.d.ts +157 -26
- package/dist/services/avatars.js +104 -93
- package/dist/services/avatars.js.map +1 -1
- package/dist/services/avatars.mjs +104 -93
- package/dist/services/avatars.mjs.map +1 -1
- package/dist/services/databases.d.mts +1224 -248
- package/dist/services/databases.d.ts +1224 -248
- package/dist/services/databases.js +877 -611
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +877 -611
- package/dist/services/databases.mjs.map +1 -1
- package/dist/services/functions.d.mts +530 -107
- package/dist/services/functions.d.ts +530 -107
- package/dist/services/functions.js +393 -276
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs +393 -276
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/graphql.d.mts +24 -2
- package/dist/services/graphql.d.ts +24 -2
- package/dist/services/graphql.js +20 -16
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/graphql.mjs +20 -16
- package/dist/services/graphql.mjs.map +1 -1
- package/dist/services/health.d.mts +175 -16
- package/dist/services/health.d.ts +175 -16
- package/dist/services/health.js +144 -115
- package/dist/services/health.js.map +1 -1
- package/dist/services/health.mjs +144 -115
- package/dist/services/health.mjs.map +1 -1
- package/dist/services/locale.js.map +1 -1
- package/dist/services/locale.mjs.map +1 -1
- package/dist/services/messaging.d.mts +1544 -262
- package/dist/services/messaging.d.ts +1544 -262
- package/dist/services/messaging.js +1417 -592
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs +1417 -592
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/sites.d.mts +495 -99
- package/dist/services/sites.d.ts +495 -99
- package/dist/services/sites.js +371 -258
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs +371 -258
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/storage.d.mts +306 -63
- package/dist/services/storage.d.ts +306 -63
- package/dist/services/storage.js +225 -158
- package/dist/services/storage.js.map +1 -1
- package/dist/services/storage.mjs +225 -158
- package/dist/services/storage.mjs.map +1 -1
- package/dist/services/tables-db.d.mts +1549 -0
- package/dist/services/tables-db.d.ts +1549 -0
- package/dist/services/tables-db.js +2374 -0
- package/dist/services/tables-db.js.map +1 -0
- package/dist/services/tables-db.mjs +2373 -0
- package/dist/services/tables-db.mjs.map +1 -0
- package/dist/services/teams.d.mts +233 -39
- package/dist/services/teams.d.ts +233 -39
- package/dist/services/teams.js +170 -135
- package/dist/services/teams.js.map +1 -1
- package/dist/services/teams.mjs +170 -135
- package/dist/services/teams.mjs.map +1 -1
- package/dist/services/tokens.d.mts +76 -11
- package/dist/services/tokens.d.ts +76 -11
- package/dist/services/tokens.js +60 -45
- package/dist/services/tokens.js.map +1 -1
- package/dist/services/tokens.mjs +60 -45
- package/dist/services/tokens.mjs.map +1 -1
- package/dist/services/users.d.mts +842 -115
- package/dist/services/users.d.ts +842 -115
- package/dist/services/users.js +719 -408
- package/dist/services/users.js.map +1 -1
- package/dist/services/users.mjs +719 -408
- package/dist/services/users.mjs.map +1 -1
- package/package.json +1 -1
- package/dist/enums/v-c-s-deployment-type.js.map +0 -1
- package/dist/enums/v-c-s-deployment-type.mjs.map +0 -1
- /package/dist/enums/{v-c-s-deployment-type.d.mts → vcs-deployment-type.d.mts} +0 -0
- /package/dist/enums/{v-c-s-deployment-type.d.ts → vcs-deployment-type.d.ts} +0 -0
|
@@ -5,14 +5,16 @@ var Graphql = class {
|
|
|
5
5
|
constructor(client) {
|
|
6
6
|
this.client = client;
|
|
7
7
|
}
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
8
|
+
query(paramsOrFirst) {
|
|
9
|
+
let params;
|
|
10
|
+
if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst) && "query" in paramsOrFirst) {
|
|
11
|
+
params = paramsOrFirst || {};
|
|
12
|
+
} else {
|
|
13
|
+
params = {
|
|
14
|
+
query: paramsOrFirst
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
const query = params.query;
|
|
16
18
|
if (typeof query === "undefined") {
|
|
17
19
|
throw new AppwriteException('Missing required parameter: "query"');
|
|
18
20
|
}
|
|
@@ -33,14 +35,16 @@ var Graphql = class {
|
|
|
33
35
|
payload
|
|
34
36
|
);
|
|
35
37
|
}
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
38
|
+
mutation(paramsOrFirst) {
|
|
39
|
+
let params;
|
|
40
|
+
if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst) && "query" in paramsOrFirst) {
|
|
41
|
+
params = paramsOrFirst || {};
|
|
42
|
+
} else {
|
|
43
|
+
params = {
|
|
44
|
+
query: paramsOrFirst
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
const query = params.query;
|
|
44
48
|
if (typeof query === "undefined") {
|
|
45
49
|
throw new AppwriteException('Missing required parameter: "query"');
|
|
46
50
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/services/graphql.ts"],"names":[],"mappings":";AAAA,SAAS,yBAA+D;
|
|
1
|
+
{"version":3,"sources":["../../src/services/graphql.ts"],"names":[],"mappings":";AAAA,SAAS,yBAA+D;AAIjE,IAAM,UAAN,MAAc;AAAA,EAGjB,YAAY,QAAgB;AACxB,SAAK,SAAS;AAAA,EAClB;AAAA,EAmBA,MACI,eACW;AACX,QAAI;AAEJ,QAAK,iBAAiB,OAAO,kBAAkB,YAAY,CAAC,MAAM,QAAQ,aAAa,KAAK,WAAW,eAAgB;AACnH,eAAU,iBAAiB,CAAC;AAAA,IAChC,OAAO;AACH,eAAS;AAAA,QACL,OAAO;AAAA,MACX;AAAA,IACJ;AAEA,UAAM,QAAQ,OAAO;AAErB,QAAI,OAAO,UAAU,aAAa;AAC9B,YAAM,IAAI,kBAAkB,qCAAqC;AAAA,IACrE;AAEA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,iBAAiB;AAAA,MACjB,gBAAgB;AAAA,IACpB;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA,EAmBA,SACI,eACW;AACX,QAAI;AAEJ,QAAK,iBAAiB,OAAO,kBAAkB,YAAY,CAAC,MAAM,QAAQ,aAAa,KAAK,WAAW,eAAgB;AACnH,eAAU,iBAAiB,CAAC;AAAA,IAChC,OAAO;AACH,eAAS;AAAA,QACL,OAAO;AAAA,MACX;AAAA,IACJ;AAEA,UAAM,QAAQ,OAAO;AAErB,QAAI,OAAO,UAAU,aAAa;AAC9B,YAAM,IAAI,kBAAkB,qCAAqC;AAAA,IACrE;AAEA,UAAM,UAAU;AAChB,UAAM,UAAmB,CAAC;AAC1B,QAAI,OAAO,UAAU,aAAa;AAC9B,cAAQ,OAAO,IAAI;AAAA,IACvB;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,iBAAiB;AAAA,MACjB,gBAAgB;AAAA,IACpB;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AACJ","sourcesContent":["import { AppwriteException, Client, type Payload, UploadProgress } from '../client';\nimport type { Models } from '../models';\n\n\nexport class Graphql {\n client: Client;\n\n constructor(client: Client) {\n this.client = client;\n }\n\n /**\n * Execute a GraphQL mutation.\n *\n * @param {object} params.query - The query or queries to execute.\n * @throws {AppwriteException}\n * @returns {Promise<{}>}\n */\n query(params: { query: object }): Promise<{}>;\n /**\n * Execute a GraphQL mutation.\n *\n * @param {object} query - The query or queries to execute.\n * @throws {AppwriteException}\n * @returns {Promise<{}>}\n * @deprecated Use the object parameter style method for a better developer experience.\n */\n query(query: object): Promise<{}>;\n query(\n paramsOrFirst: { query: object } | object \n ): Promise<{}> {\n let params: { query: object };\n \n if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'query' in paramsOrFirst)) {\n params = (paramsOrFirst || {}) as { query: object };\n } else {\n params = {\n query: paramsOrFirst as object \n };\n }\n \n const query = params.query;\n\n if (typeof query === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"query\"');\n }\n\n const apiPath = '/graphql';\n const payload: Payload = {};\n if (typeof query !== 'undefined') {\n payload['query'] = query;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'x-sdk-graphql': 'true',\n 'content-type': 'application/json',\n }\n\n return this.client.call(\n 'post',\n uri,\n apiHeaders,\n payload,\n );\n }\n\n /**\n * Execute a GraphQL mutation.\n *\n * @param {object} params.query - The query or queries to execute.\n * @throws {AppwriteException}\n * @returns {Promise<{}>}\n */\n mutation(params: { query: object }): Promise<{}>;\n /**\n * Execute a GraphQL mutation.\n *\n * @param {object} query - The query or queries to execute.\n * @throws {AppwriteException}\n * @returns {Promise<{}>}\n * @deprecated Use the object parameter style method for a better developer experience.\n */\n mutation(query: object): Promise<{}>;\n mutation(\n paramsOrFirst: { query: object } | object \n ): Promise<{}> {\n let params: { query: object };\n \n if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'query' in paramsOrFirst)) {\n params = (paramsOrFirst || {}) as { query: object };\n } else {\n params = {\n query: paramsOrFirst as object \n };\n }\n \n const query = params.query;\n\n if (typeof query === 'undefined') {\n throw new AppwriteException('Missing required parameter: \"query\"');\n }\n\n const apiPath = '/graphql/mutation';\n const payload: Payload = {};\n if (typeof query !== 'undefined') {\n payload['query'] = query;\n }\n const uri = new URL(this.client.config.endpoint + apiPath);\n\n const apiHeaders: { [header: string]: string } = {\n 'x-sdk-graphql': 'true',\n 'content-type': 'application/json',\n }\n\n return this.client.call(\n 'post',\n uri,\n apiHeaders,\n payload,\n );\n }\n}\n"]}
|
|
@@ -30,10 +30,21 @@ declare class Health {
|
|
|
30
30
|
/**
|
|
31
31
|
* Get the SSL certificate for a domain
|
|
32
32
|
*
|
|
33
|
-
* @param {string} domain
|
|
33
|
+
* @param {string} params.domain - string
|
|
34
34
|
* @throws {AppwriteException}
|
|
35
35
|
* @returns {Promise<Models.HealthCertificate>}
|
|
36
36
|
*/
|
|
37
|
+
getCertificate(params?: {
|
|
38
|
+
domain?: string;
|
|
39
|
+
}): Promise<Models.HealthCertificate>;
|
|
40
|
+
/**
|
|
41
|
+
* Get the SSL certificate for a domain
|
|
42
|
+
*
|
|
43
|
+
* @param {string} domain - string
|
|
44
|
+
* @throws {AppwriteException}
|
|
45
|
+
* @returns {Promise<Models.HealthCertificate>}
|
|
46
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
47
|
+
*/
|
|
37
48
|
getCertificate(domain?: string): Promise<Models.HealthCertificate>;
|
|
38
49
|
/**
|
|
39
50
|
* Check the Appwrite database servers are up and connection is successful.
|
|
@@ -52,108 +63,256 @@ declare class Health {
|
|
|
52
63
|
/**
|
|
53
64
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
54
65
|
*
|
|
55
|
-
* @param {number} threshold
|
|
66
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
67
|
+
* @throws {AppwriteException}
|
|
68
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
69
|
+
*/
|
|
70
|
+
getQueueBuilds(params?: {
|
|
71
|
+
threshold?: number;
|
|
72
|
+
}): Promise<Models.HealthQueue>;
|
|
73
|
+
/**
|
|
74
|
+
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
75
|
+
*
|
|
76
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
56
77
|
* @throws {AppwriteException}
|
|
57
78
|
* @returns {Promise<Models.HealthQueue>}
|
|
79
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
58
80
|
*/
|
|
59
81
|
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
60
82
|
/**
|
|
61
83
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
62
84
|
*
|
|
63
|
-
* @param {number} threshold
|
|
85
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
64
86
|
* @throws {AppwriteException}
|
|
65
87
|
* @returns {Promise<Models.HealthQueue>}
|
|
66
88
|
*/
|
|
89
|
+
getQueueCertificates(params?: {
|
|
90
|
+
threshold?: number;
|
|
91
|
+
}): Promise<Models.HealthQueue>;
|
|
92
|
+
/**
|
|
93
|
+
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
94
|
+
*
|
|
95
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
96
|
+
* @throws {AppwriteException}
|
|
97
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
98
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
99
|
+
*/
|
|
67
100
|
getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
|
|
68
101
|
/**
|
|
69
102
|
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
70
103
|
*
|
|
71
|
-
* @param {string} name
|
|
72
|
-
* @param {number} threshold
|
|
104
|
+
* @param {string} params.name - Queue name for which to check the queue size
|
|
105
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
73
106
|
* @throws {AppwriteException}
|
|
74
107
|
* @returns {Promise<Models.HealthQueue>}
|
|
75
108
|
*/
|
|
109
|
+
getQueueDatabases(params?: {
|
|
110
|
+
name?: string;
|
|
111
|
+
threshold?: number;
|
|
112
|
+
}): Promise<Models.HealthQueue>;
|
|
113
|
+
/**
|
|
114
|
+
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
115
|
+
*
|
|
116
|
+
* @param {string} name - Queue name for which to check the queue size
|
|
117
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
118
|
+
* @throws {AppwriteException}
|
|
119
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
120
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
121
|
+
*/
|
|
76
122
|
getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
|
|
77
123
|
/**
|
|
78
124
|
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
79
125
|
*
|
|
80
|
-
* @param {number} threshold
|
|
126
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
81
127
|
* @throws {AppwriteException}
|
|
82
128
|
* @returns {Promise<Models.HealthQueue>}
|
|
83
129
|
*/
|
|
130
|
+
getQueueDeletes(params?: {
|
|
131
|
+
threshold?: number;
|
|
132
|
+
}): Promise<Models.HealthQueue>;
|
|
133
|
+
/**
|
|
134
|
+
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
135
|
+
*
|
|
136
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
137
|
+
* @throws {AppwriteException}
|
|
138
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
139
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
|
+
*/
|
|
84
141
|
getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
|
|
85
142
|
/**
|
|
86
143
|
* Returns the amount of failed jobs in a given queue.
|
|
87
144
|
*
|
|
88
145
|
*
|
|
89
|
-
* @param {Name} name
|
|
90
|
-
* @param {number} threshold
|
|
146
|
+
* @param {Name} params.name - The name of the queue
|
|
147
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
91
148
|
* @throws {AppwriteException}
|
|
92
149
|
* @returns {Promise<Models.HealthQueue>}
|
|
93
150
|
*/
|
|
151
|
+
getFailedJobs(params: {
|
|
152
|
+
name: Name;
|
|
153
|
+
threshold?: number;
|
|
154
|
+
}): Promise<Models.HealthQueue>;
|
|
155
|
+
/**
|
|
156
|
+
* Returns the amount of failed jobs in a given queue.
|
|
157
|
+
*
|
|
158
|
+
*
|
|
159
|
+
* @param {Name} name - The name of the queue
|
|
160
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
161
|
+
* @throws {AppwriteException}
|
|
162
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
163
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
164
|
+
*/
|
|
94
165
|
getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
|
|
95
166
|
/**
|
|
96
167
|
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
97
168
|
*
|
|
98
|
-
* @param {number} threshold
|
|
169
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
170
|
+
* @throws {AppwriteException}
|
|
171
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
172
|
+
*/
|
|
173
|
+
getQueueFunctions(params?: {
|
|
174
|
+
threshold?: number;
|
|
175
|
+
}): Promise<Models.HealthQueue>;
|
|
176
|
+
/**
|
|
177
|
+
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
178
|
+
*
|
|
179
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
99
180
|
* @throws {AppwriteException}
|
|
100
181
|
* @returns {Promise<Models.HealthQueue>}
|
|
182
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
101
183
|
*/
|
|
102
184
|
getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
|
|
103
185
|
/**
|
|
104
186
|
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
105
187
|
*
|
|
106
|
-
* @param {number} threshold
|
|
188
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
107
189
|
* @throws {AppwriteException}
|
|
108
190
|
* @returns {Promise<Models.HealthQueue>}
|
|
109
191
|
*/
|
|
192
|
+
getQueueLogs(params?: {
|
|
193
|
+
threshold?: number;
|
|
194
|
+
}): Promise<Models.HealthQueue>;
|
|
195
|
+
/**
|
|
196
|
+
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
197
|
+
*
|
|
198
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
199
|
+
* @throws {AppwriteException}
|
|
200
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
201
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
202
|
+
*/
|
|
110
203
|
getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
|
|
111
204
|
/**
|
|
112
205
|
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
113
206
|
*
|
|
114
|
-
* @param {number} threshold
|
|
207
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
115
208
|
* @throws {AppwriteException}
|
|
116
209
|
* @returns {Promise<Models.HealthQueue>}
|
|
117
210
|
*/
|
|
211
|
+
getQueueMails(params?: {
|
|
212
|
+
threshold?: number;
|
|
213
|
+
}): Promise<Models.HealthQueue>;
|
|
214
|
+
/**
|
|
215
|
+
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
216
|
+
*
|
|
217
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
218
|
+
* @throws {AppwriteException}
|
|
219
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
220
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
221
|
+
*/
|
|
118
222
|
getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
|
|
119
223
|
/**
|
|
120
224
|
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
121
225
|
*
|
|
122
|
-
* @param {number} threshold
|
|
226
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
227
|
+
* @throws {AppwriteException}
|
|
228
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
229
|
+
*/
|
|
230
|
+
getQueueMessaging(params?: {
|
|
231
|
+
threshold?: number;
|
|
232
|
+
}): Promise<Models.HealthQueue>;
|
|
233
|
+
/**
|
|
234
|
+
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
235
|
+
*
|
|
236
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
123
237
|
* @throws {AppwriteException}
|
|
124
238
|
* @returns {Promise<Models.HealthQueue>}
|
|
239
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
125
240
|
*/
|
|
126
241
|
getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
|
|
127
242
|
/**
|
|
128
243
|
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
129
244
|
*
|
|
130
|
-
* @param {number} threshold
|
|
245
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
246
|
+
* @throws {AppwriteException}
|
|
247
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
248
|
+
*/
|
|
249
|
+
getQueueMigrations(params?: {
|
|
250
|
+
threshold?: number;
|
|
251
|
+
}): Promise<Models.HealthQueue>;
|
|
252
|
+
/**
|
|
253
|
+
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
254
|
+
*
|
|
255
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
131
256
|
* @throws {AppwriteException}
|
|
132
257
|
* @returns {Promise<Models.HealthQueue>}
|
|
258
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
133
259
|
*/
|
|
134
260
|
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
135
261
|
/**
|
|
136
262
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
137
263
|
*
|
|
138
|
-
* @param {number} threshold
|
|
264
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
139
265
|
* @throws {AppwriteException}
|
|
140
266
|
* @returns {Promise<Models.HealthQueue>}
|
|
141
267
|
*/
|
|
268
|
+
getQueueStatsResources(params?: {
|
|
269
|
+
threshold?: number;
|
|
270
|
+
}): Promise<Models.HealthQueue>;
|
|
271
|
+
/**
|
|
272
|
+
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
273
|
+
*
|
|
274
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
275
|
+
* @throws {AppwriteException}
|
|
276
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
277
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
278
|
+
*/
|
|
142
279
|
getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
|
|
143
280
|
/**
|
|
144
281
|
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
145
282
|
*
|
|
146
|
-
* @param {number} threshold
|
|
283
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
147
284
|
* @throws {AppwriteException}
|
|
148
285
|
* @returns {Promise<Models.HealthQueue>}
|
|
149
286
|
*/
|
|
287
|
+
getQueueUsage(params?: {
|
|
288
|
+
threshold?: number;
|
|
289
|
+
}): Promise<Models.HealthQueue>;
|
|
290
|
+
/**
|
|
291
|
+
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
292
|
+
*
|
|
293
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
294
|
+
* @throws {AppwriteException}
|
|
295
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
296
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
297
|
+
*/
|
|
150
298
|
getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
|
|
151
299
|
/**
|
|
152
300
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
153
301
|
*
|
|
154
|
-
* @param {number} threshold
|
|
302
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
303
|
+
* @throws {AppwriteException}
|
|
304
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
305
|
+
*/
|
|
306
|
+
getQueueWebhooks(params?: {
|
|
307
|
+
threshold?: number;
|
|
308
|
+
}): Promise<Models.HealthQueue>;
|
|
309
|
+
/**
|
|
310
|
+
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
311
|
+
*
|
|
312
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
155
313
|
* @throws {AppwriteException}
|
|
156
314
|
* @returns {Promise<Models.HealthQueue>}
|
|
315
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
157
316
|
*/
|
|
158
317
|
getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
|
|
159
318
|
/**
|
|
@@ -30,10 +30,21 @@ declare class Health {
|
|
|
30
30
|
/**
|
|
31
31
|
* Get the SSL certificate for a domain
|
|
32
32
|
*
|
|
33
|
-
* @param {string} domain
|
|
33
|
+
* @param {string} params.domain - string
|
|
34
34
|
* @throws {AppwriteException}
|
|
35
35
|
* @returns {Promise<Models.HealthCertificate>}
|
|
36
36
|
*/
|
|
37
|
+
getCertificate(params?: {
|
|
38
|
+
domain?: string;
|
|
39
|
+
}): Promise<Models.HealthCertificate>;
|
|
40
|
+
/**
|
|
41
|
+
* Get the SSL certificate for a domain
|
|
42
|
+
*
|
|
43
|
+
* @param {string} domain - string
|
|
44
|
+
* @throws {AppwriteException}
|
|
45
|
+
* @returns {Promise<Models.HealthCertificate>}
|
|
46
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
47
|
+
*/
|
|
37
48
|
getCertificate(domain?: string): Promise<Models.HealthCertificate>;
|
|
38
49
|
/**
|
|
39
50
|
* Check the Appwrite database servers are up and connection is successful.
|
|
@@ -52,108 +63,256 @@ declare class Health {
|
|
|
52
63
|
/**
|
|
53
64
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
54
65
|
*
|
|
55
|
-
* @param {number} threshold
|
|
66
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
67
|
+
* @throws {AppwriteException}
|
|
68
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
69
|
+
*/
|
|
70
|
+
getQueueBuilds(params?: {
|
|
71
|
+
threshold?: number;
|
|
72
|
+
}): Promise<Models.HealthQueue>;
|
|
73
|
+
/**
|
|
74
|
+
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
75
|
+
*
|
|
76
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
56
77
|
* @throws {AppwriteException}
|
|
57
78
|
* @returns {Promise<Models.HealthQueue>}
|
|
79
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
58
80
|
*/
|
|
59
81
|
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
60
82
|
/**
|
|
61
83
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
62
84
|
*
|
|
63
|
-
* @param {number} threshold
|
|
85
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
64
86
|
* @throws {AppwriteException}
|
|
65
87
|
* @returns {Promise<Models.HealthQueue>}
|
|
66
88
|
*/
|
|
89
|
+
getQueueCertificates(params?: {
|
|
90
|
+
threshold?: number;
|
|
91
|
+
}): Promise<Models.HealthQueue>;
|
|
92
|
+
/**
|
|
93
|
+
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
94
|
+
*
|
|
95
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
96
|
+
* @throws {AppwriteException}
|
|
97
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
98
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
99
|
+
*/
|
|
67
100
|
getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
|
|
68
101
|
/**
|
|
69
102
|
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
70
103
|
*
|
|
71
|
-
* @param {string} name
|
|
72
|
-
* @param {number} threshold
|
|
104
|
+
* @param {string} params.name - Queue name for which to check the queue size
|
|
105
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
73
106
|
* @throws {AppwriteException}
|
|
74
107
|
* @returns {Promise<Models.HealthQueue>}
|
|
75
108
|
*/
|
|
109
|
+
getQueueDatabases(params?: {
|
|
110
|
+
name?: string;
|
|
111
|
+
threshold?: number;
|
|
112
|
+
}): Promise<Models.HealthQueue>;
|
|
113
|
+
/**
|
|
114
|
+
* Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
|
|
115
|
+
*
|
|
116
|
+
* @param {string} name - Queue name for which to check the queue size
|
|
117
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
118
|
+
* @throws {AppwriteException}
|
|
119
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
120
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
121
|
+
*/
|
|
76
122
|
getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
|
|
77
123
|
/**
|
|
78
124
|
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
79
125
|
*
|
|
80
|
-
* @param {number} threshold
|
|
126
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
81
127
|
* @throws {AppwriteException}
|
|
82
128
|
* @returns {Promise<Models.HealthQueue>}
|
|
83
129
|
*/
|
|
130
|
+
getQueueDeletes(params?: {
|
|
131
|
+
threshold?: number;
|
|
132
|
+
}): Promise<Models.HealthQueue>;
|
|
133
|
+
/**
|
|
134
|
+
* Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
|
|
135
|
+
*
|
|
136
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
137
|
+
* @throws {AppwriteException}
|
|
138
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
139
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
|
+
*/
|
|
84
141
|
getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
|
|
85
142
|
/**
|
|
86
143
|
* Returns the amount of failed jobs in a given queue.
|
|
87
144
|
*
|
|
88
145
|
*
|
|
89
|
-
* @param {Name} name
|
|
90
|
-
* @param {number} threshold
|
|
146
|
+
* @param {Name} params.name - The name of the queue
|
|
147
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
91
148
|
* @throws {AppwriteException}
|
|
92
149
|
* @returns {Promise<Models.HealthQueue>}
|
|
93
150
|
*/
|
|
151
|
+
getFailedJobs(params: {
|
|
152
|
+
name: Name;
|
|
153
|
+
threshold?: number;
|
|
154
|
+
}): Promise<Models.HealthQueue>;
|
|
155
|
+
/**
|
|
156
|
+
* Returns the amount of failed jobs in a given queue.
|
|
157
|
+
*
|
|
158
|
+
*
|
|
159
|
+
* @param {Name} name - The name of the queue
|
|
160
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
161
|
+
* @throws {AppwriteException}
|
|
162
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
163
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
164
|
+
*/
|
|
94
165
|
getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
|
|
95
166
|
/**
|
|
96
167
|
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
97
168
|
*
|
|
98
|
-
* @param {number} threshold
|
|
169
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
170
|
+
* @throws {AppwriteException}
|
|
171
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
172
|
+
*/
|
|
173
|
+
getQueueFunctions(params?: {
|
|
174
|
+
threshold?: number;
|
|
175
|
+
}): Promise<Models.HealthQueue>;
|
|
176
|
+
/**
|
|
177
|
+
* Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
|
178
|
+
*
|
|
179
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
99
180
|
* @throws {AppwriteException}
|
|
100
181
|
* @returns {Promise<Models.HealthQueue>}
|
|
182
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
101
183
|
*/
|
|
102
184
|
getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
|
|
103
185
|
/**
|
|
104
186
|
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
105
187
|
*
|
|
106
|
-
* @param {number} threshold
|
|
188
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
107
189
|
* @throws {AppwriteException}
|
|
108
190
|
* @returns {Promise<Models.HealthQueue>}
|
|
109
191
|
*/
|
|
192
|
+
getQueueLogs(params?: {
|
|
193
|
+
threshold?: number;
|
|
194
|
+
}): Promise<Models.HealthQueue>;
|
|
195
|
+
/**
|
|
196
|
+
* Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
|
|
197
|
+
*
|
|
198
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
199
|
+
* @throws {AppwriteException}
|
|
200
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
201
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
202
|
+
*/
|
|
110
203
|
getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
|
|
111
204
|
/**
|
|
112
205
|
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
113
206
|
*
|
|
114
|
-
* @param {number} threshold
|
|
207
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
115
208
|
* @throws {AppwriteException}
|
|
116
209
|
* @returns {Promise<Models.HealthQueue>}
|
|
117
210
|
*/
|
|
211
|
+
getQueueMails(params?: {
|
|
212
|
+
threshold?: number;
|
|
213
|
+
}): Promise<Models.HealthQueue>;
|
|
214
|
+
/**
|
|
215
|
+
* Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
|
|
216
|
+
*
|
|
217
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
218
|
+
* @throws {AppwriteException}
|
|
219
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
220
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
221
|
+
*/
|
|
118
222
|
getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
|
|
119
223
|
/**
|
|
120
224
|
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
121
225
|
*
|
|
122
|
-
* @param {number} threshold
|
|
226
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
227
|
+
* @throws {AppwriteException}
|
|
228
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
229
|
+
*/
|
|
230
|
+
getQueueMessaging(params?: {
|
|
231
|
+
threshold?: number;
|
|
232
|
+
}): Promise<Models.HealthQueue>;
|
|
233
|
+
/**
|
|
234
|
+
* Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
|
|
235
|
+
*
|
|
236
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
123
237
|
* @throws {AppwriteException}
|
|
124
238
|
* @returns {Promise<Models.HealthQueue>}
|
|
239
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
125
240
|
*/
|
|
126
241
|
getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
|
|
127
242
|
/**
|
|
128
243
|
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
129
244
|
*
|
|
130
|
-
* @param {number} threshold
|
|
245
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
246
|
+
* @throws {AppwriteException}
|
|
247
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
248
|
+
*/
|
|
249
|
+
getQueueMigrations(params?: {
|
|
250
|
+
threshold?: number;
|
|
251
|
+
}): Promise<Models.HealthQueue>;
|
|
252
|
+
/**
|
|
253
|
+
* Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
|
|
254
|
+
*
|
|
255
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
131
256
|
* @throws {AppwriteException}
|
|
132
257
|
* @returns {Promise<Models.HealthQueue>}
|
|
258
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
133
259
|
*/
|
|
134
260
|
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
135
261
|
/**
|
|
136
262
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
137
263
|
*
|
|
138
|
-
* @param {number} threshold
|
|
264
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
139
265
|
* @throws {AppwriteException}
|
|
140
266
|
* @returns {Promise<Models.HealthQueue>}
|
|
141
267
|
*/
|
|
268
|
+
getQueueStatsResources(params?: {
|
|
269
|
+
threshold?: number;
|
|
270
|
+
}): Promise<Models.HealthQueue>;
|
|
271
|
+
/**
|
|
272
|
+
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
273
|
+
*
|
|
274
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
275
|
+
* @throws {AppwriteException}
|
|
276
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
277
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
278
|
+
*/
|
|
142
279
|
getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
|
|
143
280
|
/**
|
|
144
281
|
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
145
282
|
*
|
|
146
|
-
* @param {number} threshold
|
|
283
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
147
284
|
* @throws {AppwriteException}
|
|
148
285
|
* @returns {Promise<Models.HealthQueue>}
|
|
149
286
|
*/
|
|
287
|
+
getQueueUsage(params?: {
|
|
288
|
+
threshold?: number;
|
|
289
|
+
}): Promise<Models.HealthQueue>;
|
|
290
|
+
/**
|
|
291
|
+
* Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
|
|
292
|
+
*
|
|
293
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
294
|
+
* @throws {AppwriteException}
|
|
295
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
296
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
297
|
+
*/
|
|
150
298
|
getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
|
|
151
299
|
/**
|
|
152
300
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
153
301
|
*
|
|
154
|
-
* @param {number} threshold
|
|
302
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
303
|
+
* @throws {AppwriteException}
|
|
304
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
305
|
+
*/
|
|
306
|
+
getQueueWebhooks(params?: {
|
|
307
|
+
threshold?: number;
|
|
308
|
+
}): Promise<Models.HealthQueue>;
|
|
309
|
+
/**
|
|
310
|
+
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
311
|
+
*
|
|
312
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
155
313
|
* @throws {AppwriteException}
|
|
156
314
|
* @returns {Promise<Models.HealthQueue>}
|
|
315
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
157
316
|
*/
|
|
158
317
|
getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
|
|
159
318
|
/**
|