node-appwrite 22.1.2 → 23.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 +2 -2
- package/dist/client.d.mts +33 -0
- package/dist/client.d.ts +33 -0
- package/dist/client.js +52 -4
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +52 -4
- package/dist/client.mjs.map +1 -1
- package/dist/enums/backup-services.d.mts +3 -0
- package/dist/enums/backup-services.d.ts +3 -0
- package/dist/enums/backup-services.js +3 -0
- package/dist/enums/backup-services.js.map +1 -1
- package/dist/enums/backup-services.mjs +3 -0
- package/dist/enums/backup-services.mjs.map +1 -1
- package/dist/enums/database-type.d.mts +3 -1
- package/dist/enums/database-type.d.ts +3 -1
- package/dist/enums/database-type.js +2 -0
- package/dist/enums/database-type.js.map +1 -1
- package/dist/enums/database-type.mjs +2 -0
- package/dist/enums/database-type.mjs.map +1 -1
- package/dist/enums/databases-index-type.d.mts +8 -0
- package/dist/enums/databases-index-type.d.ts +8 -0
- package/dist/enums/databases-index-type.js +13 -0
- package/dist/enums/databases-index-type.js.map +1 -0
- package/dist/enums/databases-index-type.mjs +12 -0
- package/dist/enums/databases-index-type.mjs.map +1 -0
- package/dist/enums/scopes.d.mts +4 -0
- package/dist/enums/scopes.d.ts +4 -0
- package/dist/enums/scopes.js +4 -0
- package/dist/enums/scopes.js.map +1 -1
- package/dist/enums/scopes.mjs +4 -0
- package/dist/enums/scopes.mjs.map +1 -1
- package/dist/enums/{index-type.d.mts → tables-db-index-type.d.mts} +2 -2
- package/dist/enums/{index-type.d.ts → tables-db-index-type.d.ts} +2 -2
- package/dist/enums/tables-db-index-type.js +13 -0
- package/dist/enums/tables-db-index-type.js.map +1 -0
- package/dist/enums/tables-db-index-type.mjs +12 -0
- package/dist/enums/tables-db-index-type.mjs.map +1 -0
- package/dist/enums/template-reference-type.d.mts +1 -1
- package/dist/enums/template-reference-type.d.ts +1 -1
- package/dist/enums/template-reference-type.js +1 -1
- package/dist/enums/template-reference-type.js.map +1 -1
- package/dist/enums/template-reference-type.mjs +1 -1
- package/dist/enums/template-reference-type.mjs.map +1 -1
- package/dist/index.d.mts +4 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.js +18 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +4 -1
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +109 -11
- package/dist/models.d.ts +109 -11
- package/dist/services/databases.d.mts +45 -42
- package/dist/services/databases.d.ts +45 -42
- package/dist/services/databases.js +52 -47
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +52 -47
- package/dist/services/databases.mjs.map +1 -1
- package/dist/services/functions.d.mts +20 -8
- package/dist/services/functions.d.ts +20 -8
- package/dist/services/functions.js +28 -8
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs +28 -8
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/health.d.mts +23 -94
- package/dist/services/health.d.ts +23 -94
- package/dist/services/health.js +28 -119
- package/dist/services/health.js.map +1 -1
- package/dist/services/health.mjs +28 -119
- package/dist/services/health.mjs.map +1 -1
- package/dist/services/messaging.d.mts +2 -2
- package/dist/services/messaging.d.ts +2 -2
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/project.d.mts +136 -0
- package/dist/services/project.d.ts +136 -0
- package/dist/services/project.js +183 -0
- package/dist/services/project.js.map +1 -0
- package/dist/services/project.mjs +182 -0
- package/dist/services/project.mjs.map +1 -0
- package/dist/services/sites.d.mts +30 -12
- package/dist/services/sites.d.ts +30 -12
- package/dist/services/sites.js +60 -33
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs +60 -33
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/tables-db.d.mts +9 -6
- package/dist/services/tables-db.d.ts +9 -6
- package/dist/services/tables-db.js +6 -1
- package/dist/services/tables-db.js.map +1 -1
- package/dist/services/tables-db.mjs +6 -1
- package/dist/services/tables-db.mjs.map +1 -1
- package/dist/services/teams.d.mts +4 -4
- package/dist/services/teams.d.ts +4 -4
- package/dist/services/teams.js.map +1 -1
- package/dist/services/teams.mjs.map +1 -1
- package/dist/services/users.d.mts +26 -2
- package/dist/services/users.d.ts +26 -2
- package/dist/services/users.js +34 -0
- package/dist/services/users.js.map +1 -1
- package/dist/services/users.mjs +34 -0
- package/dist/services/users.mjs.map +1 -1
- package/dist/services/webhooks.d.mts +179 -0
- package/dist/services/webhooks.d.ts +179 -0
- package/dist/services/webhooks.js +261 -0
- package/dist/services/webhooks.js.map +1 -0
- package/dist/services/webhooks.mjs +260 -0
- package/dist/services/webhooks.mjs.map +1 -0
- package/package.json +5 -3
- package/dist/enums/index-type.js +0 -13
- package/dist/enums/index-type.js.map +0 -1
- package/dist/enums/index-type.mjs +0 -12
- package/dist/enums/index-type.mjs.map +0 -1
|
@@ -57,76 +57,62 @@ declare class Health {
|
|
|
57
57
|
*/
|
|
58
58
|
getCertificate(domain?: string): Promise<Models.HealthCertificate>;
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
|
|
61
61
|
*
|
|
62
|
-
* @throws {AppwriteException}
|
|
63
|
-
* @returns {Promise<Models.HealthStatusList>}
|
|
64
|
-
*/
|
|
65
|
-
getDB(): Promise<Models.HealthStatusList>;
|
|
66
|
-
/**
|
|
67
|
-
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
68
62
|
*
|
|
63
|
+
* @param {number} params.threshold - Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
|
|
64
|
+
* @param {number} params.inactivityDays - Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
|
|
69
65
|
* @throws {AppwriteException}
|
|
70
|
-
* @returns {Promise<Models.
|
|
71
|
-
*/
|
|
72
|
-
getPubSub(): Promise<Models.HealthStatusList>;
|
|
73
|
-
/**
|
|
74
|
-
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
75
|
-
*
|
|
76
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
77
|
-
* @throws {AppwriteException}
|
|
78
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
66
|
+
* @returns {Promise<Models.HealthStatus>}
|
|
79
67
|
*/
|
|
80
|
-
|
|
68
|
+
getConsolePausing(params?: {
|
|
81
69
|
threshold?: number;
|
|
82
|
-
|
|
70
|
+
inactivityDays?: number;
|
|
71
|
+
}): Promise<Models.HealthStatus>;
|
|
83
72
|
/**
|
|
84
|
-
* Get
|
|
73
|
+
* Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
|
|
85
74
|
*
|
|
86
|
-
*
|
|
75
|
+
*
|
|
76
|
+
* @param {number} threshold - Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
|
|
77
|
+
* @param {number} inactivityDays - Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
|
|
87
78
|
* @throws {AppwriteException}
|
|
88
|
-
* @returns {Promise<Models.
|
|
79
|
+
* @returns {Promise<Models.HealthStatus>}
|
|
89
80
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
90
81
|
*/
|
|
91
|
-
|
|
82
|
+
getConsolePausing(threshold?: number, inactivityDays?: number): Promise<Models.HealthStatus>;
|
|
92
83
|
/**
|
|
93
|
-
*
|
|
84
|
+
* Check the Appwrite database servers are up and connection is successful.
|
|
94
85
|
*
|
|
95
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
96
86
|
* @throws {AppwriteException}
|
|
97
|
-
* @returns {Promise<Models.
|
|
87
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
98
88
|
*/
|
|
99
|
-
|
|
100
|
-
threshold?: number;
|
|
101
|
-
}): Promise<Models.HealthQueue>;
|
|
89
|
+
getDB(): Promise<Models.HealthStatusList>;
|
|
102
90
|
/**
|
|
103
|
-
*
|
|
91
|
+
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
104
92
|
*
|
|
105
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
106
93
|
* @throws {AppwriteException}
|
|
107
|
-
* @returns {Promise<Models.
|
|
108
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
94
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
109
95
|
*/
|
|
110
|
-
|
|
96
|
+
getPubSub(): Promise<Models.HealthStatusList>;
|
|
111
97
|
/**
|
|
112
|
-
* Get
|
|
98
|
+
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
113
99
|
*
|
|
114
100
|
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
115
101
|
* @throws {AppwriteException}
|
|
116
102
|
* @returns {Promise<Models.HealthQueue>}
|
|
117
103
|
*/
|
|
118
|
-
|
|
104
|
+
getQueueAudits(params?: {
|
|
119
105
|
threshold?: number;
|
|
120
106
|
}): Promise<Models.HealthQueue>;
|
|
121
107
|
/**
|
|
122
|
-
* Get
|
|
108
|
+
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
123
109
|
*
|
|
124
110
|
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
125
111
|
* @throws {AppwriteException}
|
|
126
112
|
* @returns {Promise<Models.HealthQueue>}
|
|
127
113
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
128
114
|
*/
|
|
129
|
-
|
|
115
|
+
getQueueAudits(threshold?: number): Promise<Models.HealthQueue>;
|
|
130
116
|
/**
|
|
131
117
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
132
118
|
*
|
|
@@ -146,25 +132,6 @@ declare class Health {
|
|
|
146
132
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
147
133
|
*/
|
|
148
134
|
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
149
|
-
/**
|
|
150
|
-
* Get the priority builds queue size.
|
|
151
|
-
*
|
|
152
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
153
|
-
* @throws {AppwriteException}
|
|
154
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
155
|
-
*/
|
|
156
|
-
getQueuePriorityBuilds(params?: {
|
|
157
|
-
threshold?: number;
|
|
158
|
-
}): Promise<Models.HealthQueue>;
|
|
159
|
-
/**
|
|
160
|
-
* Get the priority builds queue size.
|
|
161
|
-
*
|
|
162
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
163
|
-
* @throws {AppwriteException}
|
|
164
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
165
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
166
|
-
*/
|
|
167
|
-
getQueuePriorityBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
168
135
|
/**
|
|
169
136
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
170
137
|
*
|
|
@@ -344,25 +311,6 @@ declare class Health {
|
|
|
344
311
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
345
312
|
*/
|
|
346
313
|
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
347
|
-
/**
|
|
348
|
-
* Get region manager queue.
|
|
349
|
-
*
|
|
350
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
351
|
-
* @throws {AppwriteException}
|
|
352
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
353
|
-
*/
|
|
354
|
-
getQueueRegionManager(params?: {
|
|
355
|
-
threshold?: number;
|
|
356
|
-
}): Promise<Models.HealthQueue>;
|
|
357
|
-
/**
|
|
358
|
-
* Get region manager queue.
|
|
359
|
-
*
|
|
360
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
361
|
-
* @throws {AppwriteException}
|
|
362
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
363
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
364
|
-
*/
|
|
365
|
-
getQueueRegionManager(threshold?: number): Promise<Models.HealthQueue>;
|
|
366
314
|
/**
|
|
367
315
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
368
316
|
*
|
|
@@ -401,25 +349,6 @@ declare class Health {
|
|
|
401
349
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
402
350
|
*/
|
|
403
351
|
getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
|
|
404
|
-
/**
|
|
405
|
-
* Get threats queue.
|
|
406
|
-
*
|
|
407
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
408
|
-
* @throws {AppwriteException}
|
|
409
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
410
|
-
*/
|
|
411
|
-
getQueueThreats(params?: {
|
|
412
|
-
threshold?: number;
|
|
413
|
-
}): Promise<Models.HealthQueue>;
|
|
414
|
-
/**
|
|
415
|
-
* Get threats queue.
|
|
416
|
-
*
|
|
417
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
418
|
-
* @throws {AppwriteException}
|
|
419
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
420
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
421
|
-
*/
|
|
422
|
-
getQueueThreats(threshold?: number): Promise<Models.HealthQueue>;
|
|
423
352
|
/**
|
|
424
353
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
425
354
|
*
|
|
@@ -57,76 +57,62 @@ declare class Health {
|
|
|
57
57
|
*/
|
|
58
58
|
getCertificate(domain?: string): Promise<Models.HealthCertificate>;
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
|
|
61
61
|
*
|
|
62
|
-
* @throws {AppwriteException}
|
|
63
|
-
* @returns {Promise<Models.HealthStatusList>}
|
|
64
|
-
*/
|
|
65
|
-
getDB(): Promise<Models.HealthStatusList>;
|
|
66
|
-
/**
|
|
67
|
-
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
68
62
|
*
|
|
63
|
+
* @param {number} params.threshold - Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
|
|
64
|
+
* @param {number} params.inactivityDays - Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
|
|
69
65
|
* @throws {AppwriteException}
|
|
70
|
-
* @returns {Promise<Models.
|
|
71
|
-
*/
|
|
72
|
-
getPubSub(): Promise<Models.HealthStatusList>;
|
|
73
|
-
/**
|
|
74
|
-
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
75
|
-
*
|
|
76
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
77
|
-
* @throws {AppwriteException}
|
|
78
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
66
|
+
* @returns {Promise<Models.HealthStatus>}
|
|
79
67
|
*/
|
|
80
|
-
|
|
68
|
+
getConsolePausing(params?: {
|
|
81
69
|
threshold?: number;
|
|
82
|
-
|
|
70
|
+
inactivityDays?: number;
|
|
71
|
+
}): Promise<Models.HealthStatus>;
|
|
83
72
|
/**
|
|
84
|
-
* Get
|
|
73
|
+
* Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
|
|
85
74
|
*
|
|
86
|
-
*
|
|
75
|
+
*
|
|
76
|
+
* @param {number} threshold - Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
|
|
77
|
+
* @param {number} inactivityDays - Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
|
|
87
78
|
* @throws {AppwriteException}
|
|
88
|
-
* @returns {Promise<Models.
|
|
79
|
+
* @returns {Promise<Models.HealthStatus>}
|
|
89
80
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
90
81
|
*/
|
|
91
|
-
|
|
82
|
+
getConsolePausing(threshold?: number, inactivityDays?: number): Promise<Models.HealthStatus>;
|
|
92
83
|
/**
|
|
93
|
-
*
|
|
84
|
+
* Check the Appwrite database servers are up and connection is successful.
|
|
94
85
|
*
|
|
95
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
96
86
|
* @throws {AppwriteException}
|
|
97
|
-
* @returns {Promise<Models.
|
|
87
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
98
88
|
*/
|
|
99
|
-
|
|
100
|
-
threshold?: number;
|
|
101
|
-
}): Promise<Models.HealthQueue>;
|
|
89
|
+
getDB(): Promise<Models.HealthStatusList>;
|
|
102
90
|
/**
|
|
103
|
-
*
|
|
91
|
+
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
104
92
|
*
|
|
105
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
106
93
|
* @throws {AppwriteException}
|
|
107
|
-
* @returns {Promise<Models.
|
|
108
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
94
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
109
95
|
*/
|
|
110
|
-
|
|
96
|
+
getPubSub(): Promise<Models.HealthStatusList>;
|
|
111
97
|
/**
|
|
112
|
-
* Get
|
|
98
|
+
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
113
99
|
*
|
|
114
100
|
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
115
101
|
* @throws {AppwriteException}
|
|
116
102
|
* @returns {Promise<Models.HealthQueue>}
|
|
117
103
|
*/
|
|
118
|
-
|
|
104
|
+
getQueueAudits(params?: {
|
|
119
105
|
threshold?: number;
|
|
120
106
|
}): Promise<Models.HealthQueue>;
|
|
121
107
|
/**
|
|
122
|
-
* Get
|
|
108
|
+
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
123
109
|
*
|
|
124
110
|
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
125
111
|
* @throws {AppwriteException}
|
|
126
112
|
* @returns {Promise<Models.HealthQueue>}
|
|
127
113
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
128
114
|
*/
|
|
129
|
-
|
|
115
|
+
getQueueAudits(threshold?: number): Promise<Models.HealthQueue>;
|
|
130
116
|
/**
|
|
131
117
|
* Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
|
|
132
118
|
*
|
|
@@ -146,25 +132,6 @@ declare class Health {
|
|
|
146
132
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
147
133
|
*/
|
|
148
134
|
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
149
|
-
/**
|
|
150
|
-
* Get the priority builds queue size.
|
|
151
|
-
*
|
|
152
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
153
|
-
* @throws {AppwriteException}
|
|
154
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
155
|
-
*/
|
|
156
|
-
getQueuePriorityBuilds(params?: {
|
|
157
|
-
threshold?: number;
|
|
158
|
-
}): Promise<Models.HealthQueue>;
|
|
159
|
-
/**
|
|
160
|
-
* Get the priority builds queue size.
|
|
161
|
-
*
|
|
162
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
|
|
163
|
-
* @throws {AppwriteException}
|
|
164
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
165
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
166
|
-
*/
|
|
167
|
-
getQueuePriorityBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
168
135
|
/**
|
|
169
136
|
* Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
|
|
170
137
|
*
|
|
@@ -344,25 +311,6 @@ declare class Health {
|
|
|
344
311
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
345
312
|
*/
|
|
346
313
|
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
347
|
-
/**
|
|
348
|
-
* Get region manager queue.
|
|
349
|
-
*
|
|
350
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
351
|
-
* @throws {AppwriteException}
|
|
352
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
353
|
-
*/
|
|
354
|
-
getQueueRegionManager(params?: {
|
|
355
|
-
threshold?: number;
|
|
356
|
-
}): Promise<Models.HealthQueue>;
|
|
357
|
-
/**
|
|
358
|
-
* Get region manager queue.
|
|
359
|
-
*
|
|
360
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
361
|
-
* @throws {AppwriteException}
|
|
362
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
363
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
364
|
-
*/
|
|
365
|
-
getQueueRegionManager(threshold?: number): Promise<Models.HealthQueue>;
|
|
366
314
|
/**
|
|
367
315
|
* Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
|
|
368
316
|
*
|
|
@@ -401,25 +349,6 @@ declare class Health {
|
|
|
401
349
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
402
350
|
*/
|
|
403
351
|
getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
|
|
404
|
-
/**
|
|
405
|
-
* Get threats queue.
|
|
406
|
-
*
|
|
407
|
-
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
408
|
-
* @throws {AppwriteException}
|
|
409
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
410
|
-
*/
|
|
411
|
-
getQueueThreats(params?: {
|
|
412
|
-
threshold?: number;
|
|
413
|
-
}): Promise<Models.HealthQueue>;
|
|
414
|
-
/**
|
|
415
|
-
* Get threats queue.
|
|
416
|
-
*
|
|
417
|
-
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
|
|
418
|
-
* @throws {AppwriteException}
|
|
419
|
-
* @returns {Promise<Models.HealthQueue>}
|
|
420
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
421
|
-
*/
|
|
422
|
-
getQueueThreats(threshold?: number): Promise<Models.HealthQueue>;
|
|
423
352
|
/**
|
|
424
353
|
* Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
|
|
425
354
|
*
|
package/dist/services/health.js
CHANGED
|
@@ -84,57 +84,26 @@ class Health {
|
|
|
84
84
|
payload
|
|
85
85
|
);
|
|
86
86
|
}
|
|
87
|
-
|
|
88
|
-
* Check the Appwrite database servers are up and connection is successful.
|
|
89
|
-
*
|
|
90
|
-
* @throws {AppwriteException}
|
|
91
|
-
* @returns {Promise<Models.HealthStatusList>}
|
|
92
|
-
*/
|
|
93
|
-
getDB() {
|
|
94
|
-
const apiPath = "/health/db";
|
|
95
|
-
const payload = {};
|
|
96
|
-
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
97
|
-
const apiHeaders = {};
|
|
98
|
-
return this.client.call(
|
|
99
|
-
"get",
|
|
100
|
-
uri,
|
|
101
|
-
apiHeaders,
|
|
102
|
-
payload
|
|
103
|
-
);
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
107
|
-
*
|
|
108
|
-
* @throws {AppwriteException}
|
|
109
|
-
* @returns {Promise<Models.HealthStatusList>}
|
|
110
|
-
*/
|
|
111
|
-
getPubSub() {
|
|
112
|
-
const apiPath = "/health/pubsub";
|
|
113
|
-
const payload = {};
|
|
114
|
-
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
115
|
-
const apiHeaders = {};
|
|
116
|
-
return this.client.call(
|
|
117
|
-
"get",
|
|
118
|
-
uri,
|
|
119
|
-
apiHeaders,
|
|
120
|
-
payload
|
|
121
|
-
);
|
|
122
|
-
}
|
|
123
|
-
getQueueAudits(paramsOrFirst) {
|
|
87
|
+
getConsolePausing(paramsOrFirst, ...rest) {
|
|
124
88
|
let params;
|
|
125
89
|
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|
|
126
90
|
params = paramsOrFirst || {};
|
|
127
91
|
} else {
|
|
128
92
|
params = {
|
|
129
|
-
threshold: paramsOrFirst
|
|
93
|
+
threshold: paramsOrFirst,
|
|
94
|
+
inactivityDays: rest[0]
|
|
130
95
|
};
|
|
131
96
|
}
|
|
132
97
|
const threshold = params.threshold;
|
|
133
|
-
const
|
|
98
|
+
const inactivityDays = params.inactivityDays;
|
|
99
|
+
const apiPath = "/health/console-pausing";
|
|
134
100
|
const payload = {};
|
|
135
101
|
if (typeof threshold !== "undefined") {
|
|
136
102
|
payload["threshold"] = threshold;
|
|
137
103
|
}
|
|
104
|
+
if (typeof inactivityDays !== "undefined") {
|
|
105
|
+
payload["inactivityDays"] = inactivityDays;
|
|
106
|
+
}
|
|
138
107
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
139
108
|
const apiHeaders = {};
|
|
140
109
|
return this.client.call(
|
|
@@ -144,21 +113,15 @@ class Health {
|
|
|
144
113
|
payload
|
|
145
114
|
);
|
|
146
115
|
}
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
}
|
|
156
|
-
const threshold = params.threshold;
|
|
157
|
-
const apiPath = "/health/queue/billing-project-aggregation";
|
|
116
|
+
/**
|
|
117
|
+
* Check the Appwrite database servers are up and connection is successful.
|
|
118
|
+
*
|
|
119
|
+
* @throws {AppwriteException}
|
|
120
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
121
|
+
*/
|
|
122
|
+
getDB() {
|
|
123
|
+
const apiPath = "/health/db";
|
|
158
124
|
const payload = {};
|
|
159
|
-
if (typeof threshold !== "undefined") {
|
|
160
|
-
payload["threshold"] = threshold;
|
|
161
|
-
}
|
|
162
125
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
163
126
|
const apiHeaders = {};
|
|
164
127
|
return this.client.call(
|
|
@@ -168,21 +131,15 @@ class Health {
|
|
|
168
131
|
payload
|
|
169
132
|
);
|
|
170
133
|
}
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
}
|
|
180
|
-
const threshold = params.threshold;
|
|
181
|
-
const apiPath = "/health/queue/billing-team-aggregation";
|
|
134
|
+
/**
|
|
135
|
+
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
136
|
+
*
|
|
137
|
+
* @throws {AppwriteException}
|
|
138
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
139
|
+
*/
|
|
140
|
+
getPubSub() {
|
|
141
|
+
const apiPath = "/health/pubsub";
|
|
182
142
|
const payload = {};
|
|
183
|
-
if (typeof threshold !== "undefined") {
|
|
184
|
-
payload["threshold"] = threshold;
|
|
185
|
-
}
|
|
186
143
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
187
144
|
const apiHeaders = {};
|
|
188
145
|
return this.client.call(
|
|
@@ -192,7 +149,7 @@ class Health {
|
|
|
192
149
|
payload
|
|
193
150
|
);
|
|
194
151
|
}
|
|
195
|
-
|
|
152
|
+
getQueueAudits(paramsOrFirst) {
|
|
196
153
|
let params;
|
|
197
154
|
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|
|
198
155
|
params = paramsOrFirst || {};
|
|
@@ -202,7 +159,7 @@ class Health {
|
|
|
202
159
|
};
|
|
203
160
|
}
|
|
204
161
|
const threshold = params.threshold;
|
|
205
|
-
const apiPath = "/health/queue/
|
|
162
|
+
const apiPath = "/health/queue/audits";
|
|
206
163
|
const payload = {};
|
|
207
164
|
if (typeof threshold !== "undefined") {
|
|
208
165
|
payload["threshold"] = threshold;
|
|
@@ -216,7 +173,7 @@ class Health {
|
|
|
216
173
|
payload
|
|
217
174
|
);
|
|
218
175
|
}
|
|
219
|
-
|
|
176
|
+
getQueueBuilds(paramsOrFirst) {
|
|
220
177
|
let params;
|
|
221
178
|
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|
|
222
179
|
params = paramsOrFirst || {};
|
|
@@ -226,7 +183,7 @@ class Health {
|
|
|
226
183
|
};
|
|
227
184
|
}
|
|
228
185
|
const threshold = params.threshold;
|
|
229
|
-
const apiPath = "/health/queue/builds
|
|
186
|
+
const apiPath = "/health/queue/builds";
|
|
230
187
|
const payload = {};
|
|
231
188
|
if (typeof threshold !== "undefined") {
|
|
232
189
|
payload["threshold"] = threshold;
|
|
@@ -466,30 +423,6 @@ class Health {
|
|
|
466
423
|
payload
|
|
467
424
|
);
|
|
468
425
|
}
|
|
469
|
-
getQueueRegionManager(paramsOrFirst) {
|
|
470
|
-
let params;
|
|
471
|
-
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|
|
472
|
-
params = paramsOrFirst || {};
|
|
473
|
-
} else {
|
|
474
|
-
params = {
|
|
475
|
-
threshold: paramsOrFirst
|
|
476
|
-
};
|
|
477
|
-
}
|
|
478
|
-
const threshold = params.threshold;
|
|
479
|
-
const apiPath = "/health/queue/region-manager";
|
|
480
|
-
const payload = {};
|
|
481
|
-
if (typeof threshold !== "undefined") {
|
|
482
|
-
payload["threshold"] = threshold;
|
|
483
|
-
}
|
|
484
|
-
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
485
|
-
const apiHeaders = {};
|
|
486
|
-
return this.client.call(
|
|
487
|
-
"get",
|
|
488
|
-
uri,
|
|
489
|
-
apiHeaders,
|
|
490
|
-
payload
|
|
491
|
-
);
|
|
492
|
-
}
|
|
493
426
|
getQueueStatsResources(paramsOrFirst) {
|
|
494
427
|
let params;
|
|
495
428
|
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|
|
@@ -538,30 +471,6 @@ class Health {
|
|
|
538
471
|
payload
|
|
539
472
|
);
|
|
540
473
|
}
|
|
541
|
-
getQueueThreats(paramsOrFirst) {
|
|
542
|
-
let params;
|
|
543
|
-
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|
|
544
|
-
params = paramsOrFirst || {};
|
|
545
|
-
} else {
|
|
546
|
-
params = {
|
|
547
|
-
threshold: paramsOrFirst
|
|
548
|
-
};
|
|
549
|
-
}
|
|
550
|
-
const threshold = params.threshold;
|
|
551
|
-
const apiPath = "/health/queue/threats";
|
|
552
|
-
const payload = {};
|
|
553
|
-
if (typeof threshold !== "undefined") {
|
|
554
|
-
payload["threshold"] = threshold;
|
|
555
|
-
}
|
|
556
|
-
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
557
|
-
const apiHeaders = {};
|
|
558
|
-
return this.client.call(
|
|
559
|
-
"get",
|
|
560
|
-
uri,
|
|
561
|
-
apiHeaders,
|
|
562
|
-
payload
|
|
563
|
-
);
|
|
564
|
-
}
|
|
565
474
|
getQueueWebhooks(paramsOrFirst) {
|
|
566
475
|
let params;
|
|
567
476
|
if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
|