@appwrite.io/console 2.1.0 → 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.
Files changed (46) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +2 -2
  3. package/dist/cjs/sdk.js +153 -22
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +150 -23
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +3910 -22
  8. package/docs/examples/domains/list-suggestions.md +18 -0
  9. package/docs/examples/health/get-queue-audits.md +13 -0
  10. package/docs/examples/organizations/create.md +2 -2
  11. package/docs/examples/organizations/estimation-create-organization.md +2 -2
  12. package/docs/examples/organizations/estimation-update-plan.md +2 -2
  13. package/docs/examples/organizations/update-plan.md +2 -2
  14. package/docs/examples/projects/update-labels.md +14 -0
  15. package/package.json +7 -1
  16. package/rollup.config.js +40 -24
  17. package/src/client.ts +20 -10
  18. package/src/enums/billing-plan.ts +17 -0
  19. package/src/enums/filter-type.ts +4 -0
  20. package/src/enums/name.ts +1 -0
  21. package/src/enums/o-auth-provider.ts +0 -2
  22. package/src/index.ts +2 -0
  23. package/src/models.ts +129 -59
  24. package/src/query.ts +14 -11
  25. package/src/services/databases.ts +30 -30
  26. package/src/services/domains.ts +91 -0
  27. package/src/services/health.ts +55 -6
  28. package/src/services/organizations.ts +37 -36
  29. package/src/services/projects.ts +65 -2
  30. package/src/services/storage.ts +4 -4
  31. package/src/services/tables-db.ts +30 -30
  32. package/types/client.d.ts +8 -1
  33. package/types/enums/billing-plan.d.ts +17 -0
  34. package/types/enums/filter-type.d.ts +4 -0
  35. package/types/enums/name.d.ts +1 -0
  36. package/types/enums/o-auth-provider.d.ts +0 -2
  37. package/types/index.d.ts +2 -0
  38. package/types/models.d.ts +126 -59
  39. package/types/query.d.ts +8 -8
  40. package/types/services/databases.d.ts +20 -20
  41. package/types/services/domains.d.ts +35 -0
  42. package/types/services/health.d.ts +23 -6
  43. package/types/services/organizations.d.ts +17 -16
  44. package/types/services/projects.d.ts +24 -2
  45. package/types/services/storage.d.ts +4 -4
  46. package/types/services/tables-db.d.ts +20 -20
package/types/models.d.ts CHANGED
@@ -524,6 +524,19 @@ export declare namespace Models {
524
524
  */
525
525
  variables: Variable[];
526
526
  };
527
+ /**
528
+ * Status List
529
+ */
530
+ export type HealthStatusList = {
531
+ /**
532
+ * Total number of statuses that matched your query.
533
+ */
534
+ total: number;
535
+ /**
536
+ * List of statuses.
537
+ */
538
+ statuses: HealthStatus[];
539
+ };
527
540
  /**
528
541
  * Rule List
529
542
  */
@@ -850,11 +863,11 @@ export declare namespace Models {
850
863
  /**
851
864
  * Minimum value to enforce for new documents.
852
865
  */
853
- min?: number;
866
+ min?: number | bigint;
854
867
  /**
855
868
  * Maximum value to enforce for new documents.
856
869
  */
857
- max?: number;
870
+ max?: number | bigint;
858
871
  /**
859
872
  * Default value for attribute when not provided. Cannot be set when attribute is required.
860
873
  */
@@ -1509,11 +1522,11 @@ export declare namespace Models {
1509
1522
  /**
1510
1523
  * Minimum value to enforce for new documents.
1511
1524
  */
1512
- min?: number;
1525
+ min?: number | bigint;
1513
1526
  /**
1514
1527
  * Maximum value to enforce for new documents.
1515
1528
  */
1516
- max?: number;
1529
+ max?: number | bigint;
1517
1530
  /**
1518
1531
  * Default value for column when not provided. Cannot be set when column is required.
1519
1532
  */
@@ -2765,6 +2778,14 @@ export declare namespace Models {
2765
2778
  * Total number of chunks uploaded
2766
2779
  */
2767
2780
  chunksUploaded: number;
2781
+ /**
2782
+ * Whether file contents are encrypted at rest.
2783
+ */
2784
+ encryption: boolean;
2785
+ /**
2786
+ * Compression algorithm used for the file. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
2787
+ */
2788
+ compression: string;
2768
2789
  };
2769
2790
  /**
2770
2791
  * Bucket
@@ -2807,7 +2828,7 @@ export declare namespace Models {
2807
2828
  */
2808
2829
  allowedFileExtensions: string[];
2809
2830
  /**
2810
- * Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
2831
+ * Compression algorithm chosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
2811
2832
  */
2812
2833
  compression: string;
2813
2834
  /**
@@ -2822,6 +2843,10 @@ export declare namespace Models {
2822
2843
  * Image transformations are enabled.
2823
2844
  */
2824
2845
  transformations: boolean;
2846
+ /**
2847
+ * Total size of this bucket in bytes.
2848
+ */
2849
+ totalSize: number;
2825
2850
  };
2826
2851
  /**
2827
2852
  * ResourceToken
@@ -4087,6 +4112,10 @@ export declare namespace Models {
4087
4112
  * Last ping datetime in ISO 8601 format.
4088
4113
  */
4089
4114
  pingedAt: string;
4115
+ /**
4116
+ * Labels for the project.
4117
+ */
4118
+ labels: string[];
4090
4119
  /**
4091
4120
  * Email/Password auth method status
4092
4121
  */
@@ -5129,125 +5158,125 @@ export declare namespace Models {
5129
5158
  */
5130
5159
  range: string;
5131
5160
  /**
5132
- * Total aggregated number of functions deployments.
5161
+ * Total aggregated number of sites.
5162
+ */
5163
+ sitesTotal: number;
5164
+ /**
5165
+ * Aggregated number of sites per period.
5166
+ */
5167
+ sites: Metric[];
5168
+ /**
5169
+ * Total aggregated number of sites deployments.
5133
5170
  */
5134
5171
  deploymentsTotal: number;
5135
5172
  /**
5136
- * Total aggregated sum of functions deployment storage.
5173
+ * Total aggregated sum of sites deployment storage.
5137
5174
  */
5138
5175
  deploymentsStorageTotal: number;
5139
5176
  /**
5140
- * Total aggregated number of functions build.
5177
+ * Total aggregated number of sites build.
5141
5178
  */
5142
5179
  buildsTotal: number;
5143
5180
  /**
5144
- * total aggregated sum of functions build storage.
5181
+ * total aggregated sum of sites build storage.
5145
5182
  */
5146
5183
  buildsStorageTotal: number;
5147
5184
  /**
5148
- * Total aggregated sum of functions build compute time.
5185
+ * Total aggregated sum of sites build compute time.
5149
5186
  */
5150
5187
  buildsTimeTotal: number;
5151
5188
  /**
5152
- * Total aggregated sum of functions build mbSeconds.
5189
+ * Total aggregated sum of sites build mbSeconds.
5153
5190
  */
5154
5191
  buildsMbSecondsTotal: number;
5155
5192
  /**
5156
- * Total aggregated number of functions execution.
5193
+ * Total aggregated number of sites execution.
5157
5194
  */
5158
5195
  executionsTotal: number;
5159
5196
  /**
5160
- * Total aggregated sum of functions execution compute time.
5197
+ * Total aggregated sum of sites execution compute time.
5161
5198
  */
5162
5199
  executionsTimeTotal: number;
5163
5200
  /**
5164
- * Total aggregated sum of functions execution mbSeconds.
5201
+ * Total aggregated sum of sites execution mbSeconds.
5165
5202
  */
5166
5203
  executionsMbSecondsTotal: number;
5167
5204
  /**
5168
- * Aggregated number of functions deployment per period.
5205
+ * Total aggregated number of requests.
5206
+ */
5207
+ requestsTotal: number;
5208
+ /**
5209
+ * Aggregated number of requests per period.
5210
+ */
5211
+ requests: Metric[];
5212
+ /**
5213
+ * Total aggregated inbound bandwidth.
5214
+ */
5215
+ inboundTotal: number;
5216
+ /**
5217
+ * Aggregated number of inbound bandwidth per period.
5218
+ */
5219
+ inbound: Metric[];
5220
+ /**
5221
+ * Total aggregated outbound bandwidth.
5222
+ */
5223
+ outboundTotal: number;
5224
+ /**
5225
+ * Aggregated number of outbound bandwidth per period.
5226
+ */
5227
+ outbound: Metric[];
5228
+ /**
5229
+ * Aggregated number of sites deployment per period.
5169
5230
  */
5170
5231
  deployments: Metric[];
5171
5232
  /**
5172
- * Aggregated number of functions deployment storage per period.
5233
+ * Aggregated number of sites deployment storage per period.
5173
5234
  */
5174
5235
  deploymentsStorage: Metric[];
5175
5236
  /**
5176
- * Total aggregated number of successful function builds.
5237
+ * Total aggregated number of successful site builds.
5177
5238
  */
5178
5239
  buildsSuccessTotal: number;
5179
5240
  /**
5180
- * Total aggregated number of failed function builds.
5241
+ * Total aggregated number of failed site builds.
5181
5242
  */
5182
5243
  buildsFailedTotal: number;
5183
5244
  /**
5184
- * Aggregated number of functions build per period.
5245
+ * Aggregated number of sites build per period.
5185
5246
  */
5186
5247
  builds: Metric[];
5187
5248
  /**
5188
- * Aggregated sum of functions build storage per period.
5249
+ * Aggregated sum of sites build storage per period.
5189
5250
  */
5190
5251
  buildsStorage: Metric[];
5191
5252
  /**
5192
- * Aggregated sum of functions build compute time per period.
5253
+ * Aggregated sum of sites build compute time per period.
5193
5254
  */
5194
5255
  buildsTime: Metric[];
5195
5256
  /**
5196
- * Aggregated sum of functions build mbSeconds per period.
5257
+ * Aggregated sum of sites build mbSeconds per period.
5197
5258
  */
5198
5259
  buildsMbSeconds: Metric[];
5199
5260
  /**
5200
- * Aggregated number of functions execution per period.
5261
+ * Aggregated number of sites execution per period.
5201
5262
  */
5202
5263
  executions: Metric[];
5203
5264
  /**
5204
- * Aggregated number of functions execution compute time per period.
5265
+ * Aggregated number of sites execution compute time per period.
5205
5266
  */
5206
5267
  executionsTime: Metric[];
5207
5268
  /**
5208
- * Aggregated number of functions mbSeconds per period.
5269
+ * Aggregated number of sites mbSeconds per period.
5209
5270
  */
5210
5271
  executionsMbSeconds: Metric[];
5211
5272
  /**
5212
- * Aggregated number of successful function builds per period.
5273
+ * Aggregated number of successful site builds per period.
5213
5274
  */
5214
5275
  buildsSuccess: Metric[];
5215
5276
  /**
5216
- * Aggregated number of failed function builds per period.
5277
+ * Aggregated number of failed site builds per period.
5217
5278
  */
5218
5279
  buildsFailed: Metric[];
5219
- /**
5220
- * Total aggregated number of sites.
5221
- */
5222
- sitesTotal: number;
5223
- /**
5224
- * Aggregated number of sites per period.
5225
- */
5226
- sites: Metric[];
5227
- /**
5228
- * Total aggregated number of requests.
5229
- */
5230
- requestsTotal: number;
5231
- /**
5232
- * Aggregated number of requests per period.
5233
- */
5234
- requests: Metric[];
5235
- /**
5236
- * Total aggregated inbound bandwidth.
5237
- */
5238
- inboundTotal: number;
5239
- /**
5240
- * Aggregated number of inbound bandwidth per period.
5241
- */
5242
- inbound: Metric[];
5243
- /**
5244
- * Total aggregated outbound bandwidth.
5245
- */
5246
- outboundTotal: number;
5247
- /**
5248
- * Aggregated number of outbound bandwidth per period.
5249
- */
5250
- outbound: Metric[];
5251
5280
  };
5252
5281
  /**
5253
5282
  * UsageSite
@@ -6510,6 +6539,10 @@ export declare namespace Models {
6510
6539
  * Function executions
6511
6540
  */
6512
6541
  executions: number;
6542
+ /**
6543
+ * Rolling max executions retained per function/site
6544
+ */
6545
+ executionsRetentionCount: number;
6513
6546
  /**
6514
6547
  * GB hours for functions
6515
6548
  */
@@ -7978,6 +8011,27 @@ export declare namespace Models {
7978
8011
  */
7979
8012
  value: number;
7980
8013
  };
8014
+ /**
8015
+ * DomainSuggestion
8016
+ */
8017
+ export type DomainSuggestion = {
8018
+ /**
8019
+ * Domain suggestion.
8020
+ */
8021
+ domain: string;
8022
+ /**
8023
+ * Is the domain premium?
8024
+ */
8025
+ premium: boolean;
8026
+ /**
8027
+ * Domain price.
8028
+ */
8029
+ price?: number;
8030
+ /**
8031
+ * Is the domain available?
8032
+ */
8033
+ available: boolean;
8034
+ };
7981
8035
  /**
7982
8036
  * Aggregation team list
7983
8037
  */
@@ -8134,5 +8188,18 @@ export declare namespace Models {
8134
8188
  */
8135
8189
  dnsRecords: DnsRecord[];
8136
8190
  };
8191
+ /**
8192
+ * Domain suggestions list
8193
+ */
8194
+ export type DomainSuggestionsList = {
8195
+ /**
8196
+ * Total number of suggestions that matched your query.
8197
+ */
8198
+ total: number;
8199
+ /**
8200
+ * List of suggestions.
8201
+ */
8202
+ suggestions: DomainSuggestion[];
8203
+ };
8137
8204
  export {};
8138
8205
  }
package/types/query.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- declare type QueryTypesSingle = string | number | boolean;
2
- export declare type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
1
+ declare type QueryTypesSingle = string | number | bigint | boolean;
2
+ export declare type QueryTypesList = string[] | number[] | bigint[] | boolean[] | Query[] | any[];
3
3
  export declare type QueryTypes = QueryTypesSingle | QueryTypesList;
4
4
  declare type AttributesTypes = string | string[];
5
5
  /**
@@ -89,11 +89,11 @@ export declare class Query {
89
89
  * Filter resources where attribute is between start and end (inclusive).
90
90
  *
91
91
  * @param {string} attribute
92
- * @param {string | number} start
93
- * @param {string | number} end
92
+ * @param {string | number | bigint} start
93
+ * @param {string | number | bigint} end
94
94
  * @returns {string}
95
95
  */
96
- static between: (attribute: string, start: string | number, end: string | number) => string;
96
+ static between: (attribute: string, start: string | number | bigint, end: string | number | bigint) => string;
97
97
  /**
98
98
  * Filter resources where attribute starts with value.
99
99
  *
@@ -203,11 +203,11 @@ export declare class Query {
203
203
  * Filter resources where attribute is not between start and end (exclusive).
204
204
  *
205
205
  * @param {string} attribute
206
- * @param {string | number} start
207
- * @param {string | number} end
206
+ * @param {string | number | bigint} start
207
+ * @param {string | number | bigint} end
208
208
  * @returns {string}
209
209
  */
210
- static notBetween: (attribute: string, start: string | number, end: string | number) => string;
210
+ static notBetween: (attribute: string, start: string | number | bigint, end: string | number | bigint) => string;
211
211
  /**
212
212
  * Filter resources where attribute does not start with value.
213
213
  *
@@ -840,9 +840,9 @@ export declare class Databases {
840
840
  * @param {string} params.collectionId - Collection ID.
841
841
  * @param {string} params.key - Attribute Key.
842
842
  * @param {boolean} params.required - Is attribute required?
843
- * @param {number} params.min - Minimum value
844
- * @param {number} params.max - Maximum value
845
- * @param {number} params.xdefault - Default value. Cannot be set when attribute is required.
843
+ * @param {number | bigint} params.min - Minimum value
844
+ * @param {number | bigint} params.max - Maximum value
845
+ * @param {number | bigint} params.xdefault - Default value. Cannot be set when attribute is required.
846
846
  * @param {boolean} params.array - Is attribute an array?
847
847
  * @throws {AppwriteException}
848
848
  * @returns {Promise<Models.AttributeInteger>}
@@ -853,9 +853,9 @@ export declare class Databases {
853
853
  collectionId: string;
854
854
  key: string;
855
855
  required: boolean;
856
- min?: number;
857
- max?: number;
858
- xdefault?: number;
856
+ min?: number | bigint;
857
+ max?: number | bigint;
858
+ xdefault?: number | bigint;
859
859
  array?: boolean;
860
860
  }): Promise<Models.AttributeInteger>;
861
861
  /**
@@ -866,15 +866,15 @@ export declare class Databases {
866
866
  * @param {string} collectionId - Collection ID.
867
867
  * @param {string} key - Attribute Key.
868
868
  * @param {boolean} required - Is attribute required?
869
- * @param {number} min - Minimum value
870
- * @param {number} max - Maximum value
871
- * @param {number} xdefault - Default value. Cannot be set when attribute is required.
869
+ * @param {number | bigint} min - Minimum value
870
+ * @param {number | bigint} max - Maximum value
871
+ * @param {number | bigint} xdefault - Default value. Cannot be set when attribute is required.
872
872
  * @param {boolean} array - Is attribute an array?
873
873
  * @throws {AppwriteException}
874
874
  * @returns {Promise<Models.AttributeInteger>}
875
875
  * @deprecated Use the object parameter style method for a better developer experience.
876
876
  */
877
- createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
877
+ createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number | bigint, max?: number | bigint, xdefault?: number | bigint, array?: boolean): Promise<Models.AttributeInteger>;
878
878
  /**
879
879
  * Update an integer attribute. Changing the `default` value will not update already existing documents.
880
880
  *
@@ -883,9 +883,9 @@ export declare class Databases {
883
883
  * @param {string} params.collectionId - Collection ID.
884
884
  * @param {string} params.key - Attribute Key.
885
885
  * @param {boolean} params.required - Is attribute required?
886
- * @param {number} params.xdefault - Default value. Cannot be set when attribute is required.
887
- * @param {number} params.min - Minimum value
888
- * @param {number} params.max - Maximum value
886
+ * @param {number | bigint} params.xdefault - Default value. Cannot be set when attribute is required.
887
+ * @param {number | bigint} params.min - Minimum value
888
+ * @param {number | bigint} params.max - Maximum value
889
889
  * @param {string} params.newKey - New Attribute Key.
890
890
  * @throws {AppwriteException}
891
891
  * @returns {Promise<Models.AttributeInteger>}
@@ -896,9 +896,9 @@ export declare class Databases {
896
896
  collectionId: string;
897
897
  key: string;
898
898
  required: boolean;
899
- xdefault?: number;
900
- min?: number;
901
- max?: number;
899
+ xdefault?: number | bigint;
900
+ min?: number | bigint;
901
+ max?: number | bigint;
902
902
  newKey?: string;
903
903
  }): Promise<Models.AttributeInteger>;
904
904
  /**
@@ -909,15 +909,15 @@ export declare class Databases {
909
909
  * @param {string} collectionId - Collection ID.
910
910
  * @param {string} key - Attribute Key.
911
911
  * @param {boolean} required - Is attribute required?
912
- * @param {number} xdefault - Default value. Cannot be set when attribute is required.
913
- * @param {number} min - Minimum value
914
- * @param {number} max - Maximum value
912
+ * @param {number | bigint} xdefault - Default value. Cannot be set when attribute is required.
913
+ * @param {number | bigint} min - Minimum value
914
+ * @param {number | bigint} max - Maximum value
915
915
  * @param {string} newKey - New Attribute Key.
916
916
  * @throws {AppwriteException}
917
917
  * @returns {Promise<Models.AttributeInteger>}
918
918
  * @deprecated Use the object parameter style method for a better developer experience.
919
919
  */
920
- updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number, min?: number, max?: number, newKey?: string): Promise<Models.AttributeInteger>;
920
+ updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number | bigint, min?: number | bigint, max?: number | bigint, newKey?: string): Promise<Models.AttributeInteger>;
921
921
  /**
922
922
  * Create IP address attribute.
923
923
  *
@@ -1,5 +1,6 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
+ import { FilterType } from '../enums/filter-type';
3
4
  export declare class Domains {
4
5
  client: Client;
5
6
  constructor(client: Client);
@@ -47,6 +48,40 @@ export declare class Domains {
47
48
  * @deprecated Use the object parameter style method for a better developer experience.
48
49
  */
49
50
  create(teamId: string, domain: string): Promise<Models.Domain>;
51
+ /**
52
+ * List domain suggestions.
53
+ *
54
+ * @param {string} params.query - Query to find available domains and suggestions. Max length: 256 chars.
55
+ * @param {string[]} params.tlds - TLDs to suggest.
56
+ * @param {number} params.limit - Maximum number of suggestions to return.
57
+ * @param {FilterType} params.filterType - Filter type: premium, suggestion.
58
+ * @param {number} params.priceMax - Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.
59
+ * @param {number} params.priceMin - Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.
60
+ * @throws {AppwriteException}
61
+ * @returns {Promise<Models.DomainSuggestionsList>}
62
+ */
63
+ listSuggestions(params: {
64
+ query: string;
65
+ tlds?: string[];
66
+ limit?: number;
67
+ filterType?: FilterType;
68
+ priceMax?: number;
69
+ priceMin?: number;
70
+ }): Promise<Models.DomainSuggestionsList>;
71
+ /**
72
+ * List domain suggestions.
73
+ *
74
+ * @param {string} query - Query to find available domains and suggestions. Max length: 256 chars.
75
+ * @param {string[]} tlds - TLDs to suggest.
76
+ * @param {number} limit - Maximum number of suggestions to return.
77
+ * @param {FilterType} filterType - Filter type: premium, suggestion.
78
+ * @param {number} priceMax - Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.
79
+ * @param {number} priceMin - Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.
80
+ * @throws {AppwriteException}
81
+ * @returns {Promise<Models.DomainSuggestionsList>}
82
+ * @deprecated Use the object parameter style method for a better developer experience.
83
+ */
84
+ listSuggestions(query: string, tlds?: string[], limit?: number, filterType?: FilterType, priceMax?: number, priceMin?: number): Promise<Models.DomainSuggestionsList>;
50
85
  /**
51
86
  * Get a domain by its unique ID.
52
87
  *
@@ -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.HealthStatus>}
25
+ * @returns {Promise<Models.HealthStatusList>}
26
26
  */
27
- getCache(): Promise<Models.HealthStatus>;
27
+ getCache(): Promise<Models.HealthStatusList>;
28
28
  /**
29
29
  * Get the SSL certificate for a domain
30
30
  *
@@ -48,16 +48,33 @@ 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.HealthStatus>}
51
+ * @returns {Promise<Models.HealthStatusList>}
52
52
  */
53
- getDB(): Promise<Models.HealthStatus>;
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.HealthStatus>}
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
- getPubSub(): Promise<Models.HealthStatus>;
77
+ getQueueAudits(threshold?: number): Promise<Models.HealthQueue>;
61
78
  /**
62
79
  * Get billing project aggregation queue.
63
80
  *