@appwrite.io/console 8.3.0 → 9.1.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.
@@ -1,13 +1,10 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
3
  import { Region } from '../enums/region';
4
- import { Api } from '../enums/api';
5
4
  import { AuthMethod } from '../enums/auth-method';
6
5
  import { Scopes } from '../enums/scopes';
7
6
  import { OAuthProvider } from '../enums/o-auth-provider';
8
- import { PlatformType } from '../enums/platform-type';
9
7
  import { ResourceType } from '../enums/resource-type';
10
- import { ApiService } from '../enums/api-service';
11
8
  import { SMTPSecure } from '../enums/smtp-secure';
12
9
  import { Status } from '../enums/status';
13
10
  import { EmailTemplateType } from '../enums/email-template-type';
@@ -184,102 +181,6 @@ export declare class Projects {
184
181
  * @deprecated Use the object parameter style method for a better developer experience.
185
182
  */
186
183
  delete(projectId: string): Promise<{}>;
187
- /**
188
- * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
189
- *
190
- * @param {string} params.projectId - Project unique ID.
191
- * @param {Api} params.api - API name.
192
- * @param {boolean} params.status - API status.
193
- * @throws {AppwriteException}
194
- * @returns {Promise<Models.Project>}
195
- * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateAPIStatus` instead.
196
- */
197
- updateApiStatus(params: {
198
- projectId: string;
199
- api: Api;
200
- status: boolean;
201
- }): Promise<Models.Project>;
202
- /**
203
- * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
204
- *
205
- * @param {string} projectId - Project unique ID.
206
- * @param {Api} api - API name.
207
- * @param {boolean} status - API status.
208
- * @throws {AppwriteException}
209
- * @returns {Promise<Models.Project>}
210
- * @deprecated Use the object parameter style method for a better developer experience.
211
- */
212
- updateApiStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
213
- /**
214
- * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
215
- *
216
- * @param {string} params.projectId - Project unique ID.
217
- * @param {Api} params.api - API name.
218
- * @param {boolean} params.status - API status.
219
- * @throws {AppwriteException}
220
- * @returns {Promise<Models.Project>}
221
- */
222
- updateAPIStatus(params: {
223
- projectId: string;
224
- api: Api;
225
- status: boolean;
226
- }): Promise<Models.Project>;
227
- /**
228
- * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
229
- *
230
- * @param {string} projectId - Project unique ID.
231
- * @param {Api} api - API name.
232
- * @param {boolean} status - API status.
233
- * @throws {AppwriteException}
234
- * @returns {Promise<Models.Project>}
235
- * @deprecated Use the object parameter style method for a better developer experience.
236
- */
237
- updateAPIStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
238
- /**
239
- * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
240
- *
241
- * @param {string} params.projectId - Project unique ID.
242
- * @param {boolean} params.status - API status.
243
- * @throws {AppwriteException}
244
- * @returns {Promise<Models.Project>}
245
- * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateAPIStatusAll` instead.
246
- */
247
- updateApiStatusAll(params: {
248
- projectId: string;
249
- status: boolean;
250
- }): Promise<Models.Project>;
251
- /**
252
- * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
253
- *
254
- * @param {string} projectId - Project unique ID.
255
- * @param {boolean} status - API status.
256
- * @throws {AppwriteException}
257
- * @returns {Promise<Models.Project>}
258
- * @deprecated Use the object parameter style method for a better developer experience.
259
- */
260
- updateApiStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
261
- /**
262
- * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
263
- *
264
- * @param {string} params.projectId - Project unique ID.
265
- * @param {boolean} params.status - API status.
266
- * @throws {AppwriteException}
267
- * @returns {Promise<Models.Project>}
268
- */
269
- updateAPIStatusAll(params: {
270
- projectId: string;
271
- status: boolean;
272
- }): Promise<Models.Project>;
273
- /**
274
- * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
275
- *
276
- * @param {string} projectId - Project unique ID.
277
- * @param {boolean} status - API status.
278
- * @throws {AppwriteException}
279
- * @returns {Promise<Models.Project>}
280
- * @deprecated Use the object parameter style method for a better developer experience.
281
- */
282
- updateAPIStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
283
184
  /**
284
185
  * Update how long sessions created within a project should stay active for.
285
186
  *
@@ -696,159 +597,6 @@ export declare class Projects {
696
597
  * @deprecated Use the object parameter style method for a better developer experience.
697
598
  */
698
599
  createJWT(projectId: string, scopes: Scopes[], duration?: number): Promise<Models.Jwt>;
699
- /**
700
- * Get a list of all API keys from the current project.
701
- *
702
- * @param {string} params.projectId - Project unique ID.
703
- * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes
704
- * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
705
- * @throws {AppwriteException}
706
- * @returns {Promise<Models.KeyList>}
707
- */
708
- listKeys(params: {
709
- projectId: string;
710
- queries?: string[];
711
- total?: boolean;
712
- }): Promise<Models.KeyList>;
713
- /**
714
- * Get a list of all API keys from the current project.
715
- *
716
- * @param {string} projectId - Project unique ID.
717
- * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes
718
- * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
719
- * @throws {AppwriteException}
720
- * @returns {Promise<Models.KeyList>}
721
- * @deprecated Use the object parameter style method for a better developer experience.
722
- */
723
- listKeys(projectId: string, queries?: string[], total?: boolean): Promise<Models.KeyList>;
724
- /**
725
- * Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
726
- *
727
- * @param {string} params.projectId - Project unique ID.
728
- * @param {string} params.name - Key name. Max length: 128 chars.
729
- * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
730
- * @param {string} params.keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
731
- * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
732
- * @throws {AppwriteException}
733
- * @returns {Promise<Models.Key>}
734
- */
735
- createKey(params: {
736
- projectId: string;
737
- name: string;
738
- scopes?: Scopes[];
739
- keyId?: string;
740
- expire?: string;
741
- }): Promise<Models.Key>;
742
- /**
743
- * Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
744
- *
745
- * @param {string} projectId - Project unique ID.
746
- * @param {string} name - Key name. Max length: 128 chars.
747
- * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
748
- * @param {string} keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
749
- * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
750
- * @throws {AppwriteException}
751
- * @returns {Promise<Models.Key>}
752
- * @deprecated Use the object parameter style method for a better developer experience.
753
- */
754
- createKey(projectId: string, name: string, scopes?: Scopes[], keyId?: string, expire?: string): Promise<Models.Key>;
755
- /**
756
- * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
757
- *
758
- * @param {string} params.projectId - Project unique ID.
759
- * @param {string} params.keyId - Key unique ID.
760
- * @throws {AppwriteException}
761
- * @returns {Promise<Models.Key>}
762
- */
763
- getKey(params: {
764
- projectId: string;
765
- keyId: string;
766
- }): Promise<Models.Key>;
767
- /**
768
- * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
769
- *
770
- * @param {string} projectId - Project unique ID.
771
- * @param {string} keyId - Key unique ID.
772
- * @throws {AppwriteException}
773
- * @returns {Promise<Models.Key>}
774
- * @deprecated Use the object parameter style method for a better developer experience.
775
- */
776
- getKey(projectId: string, keyId: string): Promise<Models.Key>;
777
- /**
778
- * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
779
- *
780
- * @param {string} params.projectId - Project unique ID.
781
- * @param {string} params.keyId - Key unique ID.
782
- * @param {string} params.name - Key name. Max length: 128 chars.
783
- * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 events are allowed.
784
- * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
785
- * @throws {AppwriteException}
786
- * @returns {Promise<Models.Key>}
787
- */
788
- updateKey(params: {
789
- projectId: string;
790
- keyId: string;
791
- name: string;
792
- scopes?: Scopes[];
793
- expire?: string;
794
- }): Promise<Models.Key>;
795
- /**
796
- * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
797
- *
798
- * @param {string} projectId - Project unique ID.
799
- * @param {string} keyId - Key unique ID.
800
- * @param {string} name - Key name. Max length: 128 chars.
801
- * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 events are allowed.
802
- * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
803
- * @throws {AppwriteException}
804
- * @returns {Promise<Models.Key>}
805
- * @deprecated Use the object parameter style method for a better developer experience.
806
- */
807
- updateKey(projectId: string, keyId: string, name: string, scopes?: Scopes[], expire?: string): Promise<Models.Key>;
808
- /**
809
- * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
810
- *
811
- * @param {string} params.projectId - Project unique ID.
812
- * @param {string} params.keyId - Key unique ID.
813
- * @throws {AppwriteException}
814
- * @returns {Promise<{}>}
815
- */
816
- deleteKey(params: {
817
- projectId: string;
818
- keyId: string;
819
- }): Promise<{}>;
820
- /**
821
- * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
822
- *
823
- * @param {string} projectId - Project unique ID.
824
- * @param {string} keyId - Key unique ID.
825
- * @throws {AppwriteException}
826
- * @returns {Promise<{}>}
827
- * @deprecated Use the object parameter style method for a better developer experience.
828
- */
829
- deleteKey(projectId: string, keyId: string): Promise<{}>;
830
- /**
831
- * Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.
832
- *
833
- * @param {string} params.projectId - Project unique ID.
834
- * @param {string[]} params.labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
835
- * @throws {AppwriteException}
836
- * @returns {Promise<Models.Project>}
837
- */
838
- updateLabels(params: {
839
- projectId: string;
840
- labels: string[];
841
- }): Promise<Models.Project>;
842
- /**
843
- * Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.
844
- *
845
- * @param {string} projectId - Project unique ID.
846
- * @param {string[]} labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
847
- * @throws {AppwriteException}
848
- * @returns {Promise<Models.Project>}
849
- * @deprecated Use the object parameter style method for a better developer experience.
850
- */
851
- updateLabels(projectId: string, labels: string[]): Promise<Models.Project>;
852
600
  /**
853
601
  * Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
854
602
  *
@@ -880,140 +628,6 @@ export declare class Projects {
880
628
  * @deprecated Use the object parameter style method for a better developer experience.
881
629
  */
882
630
  updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
883
- /**
884
- * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
885
- *
886
- * @param {string} params.projectId - Project unique ID.
887
- * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
888
- * @throws {AppwriteException}
889
- * @returns {Promise<Models.PlatformList>}
890
- */
891
- listPlatforms(params: {
892
- projectId: string;
893
- total?: boolean;
894
- }): Promise<Models.PlatformList>;
895
- /**
896
- * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
897
- *
898
- * @param {string} projectId - Project unique ID.
899
- * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
900
- * @throws {AppwriteException}
901
- * @returns {Promise<Models.PlatformList>}
902
- * @deprecated Use the object parameter style method for a better developer experience.
903
- */
904
- listPlatforms(projectId: string, total?: boolean): Promise<Models.PlatformList>;
905
- /**
906
- * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
907
- *
908
- * @param {string} params.projectId - Project unique ID.
909
- * @param {PlatformType} params.type - Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
910
- * @param {string} params.name - Platform name. Max length: 128 chars.
911
- * @param {string} params.key - Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.
912
- * @param {string} params.store - App store or Google Play store ID. Max length: 256 chars.
913
- * @param {string} params.hostname - Platform client hostname. Max length: 256 chars.
914
- * @throws {AppwriteException}
915
- * @returns {Promise<Models.Platform>}
916
- */
917
- createPlatform(params: {
918
- projectId: string;
919
- type: PlatformType;
920
- name: string;
921
- key?: string;
922
- store?: string;
923
- hostname?: string;
924
- }): Promise<Models.Platform>;
925
- /**
926
- * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
927
- *
928
- * @param {string} projectId - Project unique ID.
929
- * @param {PlatformType} type - Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
930
- * @param {string} name - Platform name. Max length: 128 chars.
931
- * @param {string} key - Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.
932
- * @param {string} store - App store or Google Play store ID. Max length: 256 chars.
933
- * @param {string} hostname - Platform client hostname. Max length: 256 chars.
934
- * @throws {AppwriteException}
935
- * @returns {Promise<Models.Platform>}
936
- * @deprecated Use the object parameter style method for a better developer experience.
937
- */
938
- createPlatform(projectId: string, type: PlatformType, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
939
- /**
940
- * Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
941
- *
942
- * @param {string} params.projectId - Project unique ID.
943
- * @param {string} params.platformId - Platform unique ID.
944
- * @throws {AppwriteException}
945
- * @returns {Promise<Models.Platform>}
946
- */
947
- getPlatform(params: {
948
- projectId: string;
949
- platformId: string;
950
- }): Promise<Models.Platform>;
951
- /**
952
- * Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
953
- *
954
- * @param {string} projectId - Project unique ID.
955
- * @param {string} platformId - Platform unique ID.
956
- * @throws {AppwriteException}
957
- * @returns {Promise<Models.Platform>}
958
- * @deprecated Use the object parameter style method for a better developer experience.
959
- */
960
- getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
961
- /**
962
- * Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
963
- *
964
- * @param {string} params.projectId - Project unique ID.
965
- * @param {string} params.platformId - Platform unique ID.
966
- * @param {string} params.name - Platform name. Max length: 128 chars.
967
- * @param {string} params.key - Package name for android or bundle ID for iOS. Max length: 256 chars.
968
- * @param {string} params.store - App store or Google Play store ID. Max length: 256 chars.
969
- * @param {string} params.hostname - Platform client URL. Max length: 256 chars.
970
- * @throws {AppwriteException}
971
- * @returns {Promise<Models.Platform>}
972
- */
973
- updatePlatform(params: {
974
- projectId: string;
975
- platformId: string;
976
- name: string;
977
- key?: string;
978
- store?: string;
979
- hostname?: string;
980
- }): Promise<Models.Platform>;
981
- /**
982
- * Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
983
- *
984
- * @param {string} projectId - Project unique ID.
985
- * @param {string} platformId - Platform unique ID.
986
- * @param {string} name - Platform name. Max length: 128 chars.
987
- * @param {string} key - Package name for android or bundle ID for iOS. Max length: 256 chars.
988
- * @param {string} store - App store or Google Play store ID. Max length: 256 chars.
989
- * @param {string} hostname - Platform client URL. Max length: 256 chars.
990
- * @throws {AppwriteException}
991
- * @returns {Promise<Models.Platform>}
992
- * @deprecated Use the object parameter style method for a better developer experience.
993
- */
994
- updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
995
- /**
996
- * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
997
- *
998
- * @param {string} params.projectId - Project unique ID.
999
- * @param {string} params.platformId - Platform unique ID.
1000
- * @throws {AppwriteException}
1001
- * @returns {Promise<{}>}
1002
- */
1003
- deletePlatform(params: {
1004
- projectId: string;
1005
- platformId: string;
1006
- }): Promise<{}>;
1007
- /**
1008
- * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
1009
- *
1010
- * @param {string} projectId - Project unique ID.
1011
- * @param {string} platformId - Platform unique ID.
1012
- * @throws {AppwriteException}
1013
- * @returns {Promise<{}>}
1014
- * @deprecated Use the object parameter style method for a better developer experience.
1015
- */
1016
- deletePlatform(projectId: string, platformId: string): Promise<{}>;
1017
631
  /**
1018
632
  * Get a list of all the project's schedules. You can use the query params to filter your results.
1019
633
  *
@@ -1095,53 +709,6 @@ export declare class Projects {
1095
709
  * @deprecated Use the object parameter style method for a better developer experience.
1096
710
  */
1097
711
  getSchedule(projectId: string, scheduleId: string): Promise<Models.Schedule>;
1098
- /**
1099
- * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
1100
- *
1101
- * @param {string} params.projectId - Project unique ID.
1102
- * @param {ApiService} params.service - Service name.
1103
- * @param {boolean} params.status - Service status.
1104
- * @throws {AppwriteException}
1105
- * @returns {Promise<Models.Project>}
1106
- */
1107
- updateServiceStatus(params: {
1108
- projectId: string;
1109
- service: ApiService;
1110
- status: boolean;
1111
- }): Promise<Models.Project>;
1112
- /**
1113
- * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
1114
- *
1115
- * @param {string} projectId - Project unique ID.
1116
- * @param {ApiService} service - Service name.
1117
- * @param {boolean} status - Service status.
1118
- * @throws {AppwriteException}
1119
- * @returns {Promise<Models.Project>}
1120
- * @deprecated Use the object parameter style method for a better developer experience.
1121
- */
1122
- updateServiceStatus(projectId: string, service: ApiService, status: boolean): Promise<Models.Project>;
1123
- /**
1124
- * Update the status of all services. Use this endpoint to enable or disable all optional services at once.
1125
- *
1126
- * @param {string} params.projectId - Project unique ID.
1127
- * @param {boolean} params.status - Service status.
1128
- * @throws {AppwriteException}
1129
- * @returns {Promise<Models.Project>}
1130
- */
1131
- updateServiceStatusAll(params: {
1132
- projectId: string;
1133
- status: boolean;
1134
- }): Promise<Models.Project>;
1135
- /**
1136
- * Update the status of all services. Use this endpoint to enable or disable all optional services at once.
1137
- *
1138
- * @param {string} projectId - Project unique ID.
1139
- * @param {boolean} status - Service status.
1140
- * @throws {AppwriteException}
1141
- * @returns {Promise<Models.Project>}
1142
- * @deprecated Use the object parameter style method for a better developer experience.
1143
- */
1144
- updateServiceStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
1145
712
  /**
1146
713
  * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
1147
714
  *
@@ -364,6 +364,7 @@ export declare class TablesDB {
364
364
  * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
365
365
  * @param {boolean} params.rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
366
366
  * @param {boolean} params.enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
367
+ * @param {boolean} params.purge - When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
367
368
  * @throws {AppwriteException}
368
369
  * @returns {Promise<Models.Table>}
369
370
  */
@@ -374,6 +375,7 @@ export declare class TablesDB {
374
375
  permissions?: string[];
375
376
  rowSecurity?: boolean;
376
377
  enabled?: boolean;
378
+ purge?: boolean;
377
379
  }): Promise<Models.Table>;
378
380
  /**
379
381
  * Update a table by its unique ID.
@@ -384,11 +386,12 @@ export declare class TablesDB {
384
386
  * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
385
387
  * @param {boolean} rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
386
388
  * @param {boolean} enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
389
+ * @param {boolean} purge - When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
387
390
  * @throws {AppwriteException}
388
391
  * @returns {Promise<Models.Table>}
389
392
  * @deprecated Use the object parameter style method for a better developer experience.
390
393
  */
391
- updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
394
+ updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean, purge?: boolean): Promise<Models.Table>;
392
395
  /**
393
396
  * Delete a table by its unique ID. Only users with write permissions have access to delete this resource.
394
397
  *
@@ -1896,7 +1899,7 @@ export declare class TablesDB {
1896
1899
  * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
1897
1900
  * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
1898
1901
  * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
1899
- * @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
1902
+ * @param {number} params.ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
1900
1903
  * @throws {AppwriteException}
1901
1904
  * @returns {Promise<Models.RowList<Row>>}
1902
1905
  */
@@ -1916,7 +1919,7 @@ export declare class TablesDB {
1916
1919
  * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
1917
1920
  * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
1918
1921
  * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
1919
- * @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
1922
+ * @param {number} ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
1920
1923
  * @throws {AppwriteException}
1921
1924
  * @returns {Promise<Models.RowList<Row>>}
1922
1925
  * @deprecated Use the object parameter style method for a better developer experience.
@@ -6,7 +6,7 @@ export declare class Webhooks {
6
6
  /**
7
7
  * Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
8
8
  *
9
- * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts
9
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, url, authUsername, tls, events, enabled, logs, attempts
10
10
  * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
11
11
  * @throws {AppwriteException}
12
12
  * @returns {Promise<Models.WebhookList>}
@@ -18,7 +18,7 @@ export declare class Webhooks {
18
18
  /**
19
19
  * Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
20
20
  *
21
- * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts
21
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, url, authUsername, tls, events, enabled, logs, attempts
22
22
  * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
23
23
  * @throws {AppwriteException}
24
24
  * @returns {Promise<Models.WebhookList>}
@@ -33,9 +33,10 @@ export declare class Webhooks {
33
33
  * @param {string} params.name - Webhook name. Max length: 128 chars.
34
34
  * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
35
35
  * @param {boolean} params.enabled - Enable or disable a webhook.
36
- * @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
37
- * @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
38
- * @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
36
+ * @param {boolean} params.tls - Certificate verification, false for disabled or true for enabled.
37
+ * @param {string} params.authUsername - Webhook HTTP user. Max length: 256 chars.
38
+ * @param {string} params.authPassword - Webhook HTTP password. Max length: 256 chars.
39
+ * @param {string} params.secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
39
40
  * @throws {AppwriteException}
40
41
  * @returns {Promise<Models.Webhook>}
41
42
  */
@@ -45,9 +46,10 @@ export declare class Webhooks {
45
46
  name: string;
46
47
  events: string[];
47
48
  enabled?: boolean;
48
- security?: boolean;
49
- httpUser?: string;
50
- httpPass?: string;
49
+ tls?: boolean;
50
+ authUsername?: string;
51
+ authPassword?: string;
52
+ secret?: string;
51
53
  }): Promise<Models.Webhook>;
52
54
  /**
53
55
  * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
@@ -57,14 +59,15 @@ export declare class Webhooks {
57
59
  * @param {string} name - Webhook name. Max length: 128 chars.
58
60
  * @param {string[]} events - Events list. Maximum of 100 events are allowed.
59
61
  * @param {boolean} enabled - Enable or disable a webhook.
60
- * @param {boolean} security - Certificate verification, false for disabled or true for enabled.
61
- * @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
62
- * @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
62
+ * @param {boolean} tls - Certificate verification, false for disabled or true for enabled.
63
+ * @param {string} authUsername - Webhook HTTP user. Max length: 256 chars.
64
+ * @param {string} authPassword - Webhook HTTP password. Max length: 256 chars.
65
+ * @param {string} secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
63
66
  * @throws {AppwriteException}
64
67
  * @returns {Promise<Models.Webhook>}
65
68
  * @deprecated Use the object parameter style method for a better developer experience.
66
69
  */
67
- create(webhookId: string, url: string, name: string, events: string[], enabled?: boolean, security?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
70
+ create(webhookId: string, url: string, name: string, events: string[], enabled?: boolean, tls?: boolean, authUsername?: string, authPassword?: string, secret?: string): Promise<Models.Webhook>;
68
71
  /**
69
72
  * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
70
73
  *
@@ -92,9 +95,9 @@ export declare class Webhooks {
92
95
  * @param {string} params.url - Webhook URL.
93
96
  * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
94
97
  * @param {boolean} params.enabled - Enable or disable a webhook.
95
- * @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
96
- * @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
97
- * @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
98
+ * @param {boolean} params.tls - Certificate verification, false for disabled or true for enabled.
99
+ * @param {string} params.authUsername - Webhook HTTP user. Max length: 256 chars.
100
+ * @param {string} params.authPassword - Webhook HTTP password. Max length: 256 chars.
98
101
  * @throws {AppwriteException}
99
102
  * @returns {Promise<Models.Webhook>}
100
103
  */
@@ -104,9 +107,9 @@ export declare class Webhooks {
104
107
  url: string;
105
108
  events: string[];
106
109
  enabled?: boolean;
107
- security?: boolean;
108
- httpUser?: string;
109
- httpPass?: string;
110
+ tls?: boolean;
111
+ authUsername?: string;
112
+ authPassword?: string;
110
113
  }): Promise<Models.Webhook>;
111
114
  /**
112
115
  * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
@@ -116,14 +119,14 @@ export declare class Webhooks {
116
119
  * @param {string} url - Webhook URL.
117
120
  * @param {string[]} events - Events list. Maximum of 100 events are allowed.
118
121
  * @param {boolean} enabled - Enable or disable a webhook.
119
- * @param {boolean} security - Certificate verification, false for disabled or true for enabled.
120
- * @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
121
- * @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
122
+ * @param {boolean} tls - Certificate verification, false for disabled or true for enabled.
123
+ * @param {string} authUsername - Webhook HTTP user. Max length: 256 chars.
124
+ * @param {string} authPassword - Webhook HTTP password. Max length: 256 chars.
122
125
  * @throws {AppwriteException}
123
126
  * @returns {Promise<Models.Webhook>}
124
127
  * @deprecated Use the object parameter style method for a better developer experience.
125
128
  */
126
- update(webhookId: string, name: string, url: string, events: string[], enabled?: boolean, security?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
129
+ update(webhookId: string, name: string, url: string, events: string[], enabled?: boolean, tls?: boolean, authUsername?: string, authPassword?: string): Promise<Models.Webhook>;
127
130
  /**
128
131
  * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
129
132
  *
@@ -144,22 +147,25 @@ export declare class Webhooks {
144
147
  */
145
148
  delete(webhookId: string): Promise<{}>;
146
149
  /**
147
- * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
150
+ * Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.
148
151
  *
149
152
  * @param {string} params.webhookId - Webhook ID.
153
+ * @param {string} params.secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
150
154
  * @throws {AppwriteException}
151
155
  * @returns {Promise<Models.Webhook>}
152
156
  */
153
- updateSignature(params: {
157
+ updateSecret(params: {
154
158
  webhookId: string;
159
+ secret?: string;
155
160
  }): Promise<Models.Webhook>;
156
161
  /**
157
- * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
162
+ * Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.
158
163
  *
159
164
  * @param {string} webhookId - Webhook ID.
165
+ * @param {string} secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
160
166
  * @throws {AppwriteException}
161
167
  * @returns {Promise<Models.Webhook>}
162
168
  * @deprecated Use the object parameter style method for a better developer experience.
163
169
  */
164
- updateSignature(webhookId: string): Promise<Models.Webhook>;
170
+ updateSecret(webhookId: string, secret?: string): Promise<Models.Webhook>;
165
171
  }