@appwrite.io/console 15.8.0 → 16.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.
Files changed (54) hide show
  1. package/README.md +5 -6
  2. package/dist/cjs/package.json +1 -1
  3. package/dist/cjs/sdk.js +8360 -4537
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/package.json +1 -1
  6. package/dist/esm/sdk.js +8359 -4538
  7. package/dist/esm/sdk.js.map +1 -1
  8. package/dist/iife/sdk.js +8360 -4537
  9. package/package.json +59 -50
  10. package/types/client.d.ts +13 -2
  11. package/types/enums/{addon.d.ts → addon-key.d.ts} +1 -1
  12. package/types/enums/authentication-factor.d.ts +2 -1
  13. package/types/enums/build-runtime.d.ts +4 -1
  14. package/types/enums/embedding-model.d.ts +1 -3
  15. package/types/enums/execution-resource-type.d.ts +4 -0
  16. package/types/enums/image-gravity.d.ts +1 -0
  17. package/types/enums/invalidation-type.d.ts +5 -0
  18. package/types/enums/o-auth-provider.d.ts +5 -0
  19. package/types/enums/project-key-scopes.d.ts +20 -3
  20. package/types/enums/project-o-auth-provider-id.d.ts +5 -0
  21. package/types/enums/project-policy-id.d.ts +1 -0
  22. package/types/enums/query-suggestion-resource.d.ts +5 -1
  23. package/types/enums/runtime.d.ts +4 -1
  24. package/types/enums/usage-event-dimension.d.ts +27 -0
  25. package/types/enums/usage-event-metric.d.ts +55 -0
  26. package/types/enums/usage-gauge-dimension.d.ts +7 -0
  27. package/types/enums/usage-gauge-metric.d.ts +50 -0
  28. package/types/enums/usage-interval.d.ts +7 -0
  29. package/types/enums/usage-order-by.d.ts +4 -0
  30. package/types/enums/usage-order-direction.d.ts +4 -0
  31. package/types/index.d.ts +19 -6
  32. package/types/models.d.ts +764 -313
  33. package/types/services/account.d.ts +8 -8
  34. package/types/services/affiliates.d.ts +162 -0
  35. package/types/services/apps.d.ts +6 -6
  36. package/types/services/avatars.d.ts +44 -0
  37. package/types/services/databases.d.ts +8 -8
  38. package/types/services/documents-db.d.ts +13 -7
  39. package/types/services/domains.d.ts +82 -54
  40. package/types/services/embeddings.d.ts +31 -0
  41. package/types/services/functions.d.ts +6 -6
  42. package/types/services/mongo.d.ts +17 -23
  43. package/types/services/mysql.d.ts +17 -23
  44. package/types/services/organizations.d.ts +5 -5
  45. package/types/services/postgresql.d.ts +17 -23
  46. package/types/services/project.d.ts +171 -15
  47. package/types/services/proxy.d.ts +30 -0
  48. package/types/services/sites.d.ts +15 -8
  49. package/types/services/storage.d.ts +6 -6
  50. package/types/services/tables-db.d.ts +37 -12
  51. package/types/services/usage.d.ts +52 -38
  52. package/types/services/users.d.ts +24 -2
  53. package/types/services/vectors-db.d.ts +15 -34
  54. package/types/services/waf.d.ts +11 -2
@@ -360,6 +360,7 @@ export declare class Project {
360
360
  * @param {string} params.userCodeFormat - Character set for device flow user codes: `numeric` (digits only — best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits — highest entropy per character). Defaults to `alphanumeric`.
361
361
  * @param {number} params.deviceCodeDuration - Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.
362
362
  * @param {string[]} params.defaultScopes - List of OAuth2 scopes used when an authorization request omits the scope parameter. Every default scope must also be allowed by the OAuth2 server. Maximum of 100 scopes are allowed, each up to 128 characters long.
363
+ * @param {string[]} params.installationScopes - List of scopes an application may request when installed on a team. Omitting the parameter clears the list, so no installation scopes can be granted. Maximum of 100 scopes are allowed, each up to 128 characters long.
363
364
  * @throws {AppwriteException}
364
365
  * @returns {Promise<Models.Project>}
365
366
  */
@@ -379,6 +380,7 @@ export declare class Project {
379
380
  userCodeFormat?: string;
380
381
  deviceCodeDuration?: number;
381
382
  defaultScopes?: string[];
383
+ installationScopes?: string[];
382
384
  }): Promise<Models.Project>;
383
385
  /**
384
386
  * Update the OAuth2 server (OIDC provider) configuration.
@@ -398,11 +400,12 @@ export declare class Project {
398
400
  * @param {string} userCodeFormat - Character set for device flow user codes: `numeric` (digits only — best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits — highest entropy per character). Defaults to `alphanumeric`.
399
401
  * @param {number} deviceCodeDuration - Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.
400
402
  * @param {string[]} defaultScopes - List of OAuth2 scopes used when an authorization request omits the scope parameter. Every default scope must also be allowed by the OAuth2 server. Maximum of 100 scopes are allowed, each up to 128 characters long.
403
+ * @param {string[]} installationScopes - List of scopes an application may request when installed on a team. Omitting the parameter clears the list, so no installation scopes can be granted. Maximum of 100 scopes are allowed, each up to 128 characters long.
401
404
  * @throws {AppwriteException}
402
405
  * @returns {Promise<Models.Project>}
403
406
  * @deprecated Use the object parameter style method for a better developer experience.
404
407
  */
405
- updateOAuth2Server(enabled: boolean, authorizationUrl: string, scopes?: string[], authorizationDetailsTypes?: string[], accessTokenDuration?: number, refreshTokenDuration?: number, publicAccessTokenDuration?: number, publicRefreshTokenDuration?: number, installationAccessTokenDuration?: number, confidentialPkce?: boolean, verificationUrl?: string, userCodeLength?: number, userCodeFormat?: string, deviceCodeDuration?: number, defaultScopes?: string[]): Promise<Models.Project>;
408
+ updateOAuth2Server(enabled: boolean, authorizationUrl: string, scopes?: string[], authorizationDetailsTypes?: string[], accessTokenDuration?: number, refreshTokenDuration?: number, publicAccessTokenDuration?: number, publicRefreshTokenDuration?: number, installationAccessTokenDuration?: number, confidentialPkce?: boolean, verificationUrl?: string, userCodeLength?: number, userCodeFormat?: string, deviceCodeDuration?: number, defaultScopes?: string[], installationScopes?: string[]): Promise<Models.Project>;
406
409
  /**
407
410
  * Update the project OAuth2 Amazon configuration.
408
411
  *
@@ -640,6 +643,31 @@ export declare class Project {
640
643
  * @deprecated Use the object parameter style method for a better developer experience.
641
644
  */
642
645
  updateOAuth2Box(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Box>;
646
+ /**
647
+ * Update the project OAuth2 Cloudflare configuration.
648
+ *
649
+ * @param {string} params.clientId - 'Client ID' of Cloudflare OAuth2 app. For example: 4b866000000000000000000000c9e4e2
650
+ * @param {string} params.clientSecret - 'Client Secret' of Cloudflare OAuth2 app. For example: cfoc_5Q6YRl0000000000000000000000000000000000003d214f
651
+ * @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
652
+ * @throws {AppwriteException}
653
+ * @returns {Promise<Models.OAuth2Cloudflare>}
654
+ */
655
+ updateOAuth2Cloudflare(params?: {
656
+ clientId?: string;
657
+ clientSecret?: string;
658
+ enabled?: boolean;
659
+ }): Promise<Models.OAuth2Cloudflare>;
660
+ /**
661
+ * Update the project OAuth2 Cloudflare configuration.
662
+ *
663
+ * @param {string} clientId - 'Client ID' of Cloudflare OAuth2 app. For example: 4b866000000000000000000000c9e4e2
664
+ * @param {string} clientSecret - 'Client Secret' of Cloudflare OAuth2 app. For example: cfoc_5Q6YRl0000000000000000000000000000000000003d214f
665
+ * @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
666
+ * @throws {AppwriteException}
667
+ * @returns {Promise<Models.OAuth2Cloudflare>}
668
+ * @deprecated Use the object parameter style method for a better developer experience.
669
+ */
670
+ updateOAuth2Cloudflare(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Cloudflare>;
643
671
  /**
644
672
  * Update the project OAuth2 Dailymotion configuration.
645
673
  *
@@ -924,6 +952,56 @@ export declare class Project {
924
952
  * @deprecated Use the object parameter style method for a better developer experience.
925
953
  */
926
954
  updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GooglePrompt[], enabled?: boolean): Promise<Models.OAuth2Google>;
955
+ /**
956
+ * Update the project OAuth2 Hugging Face configuration.
957
+ *
958
+ * @param {string} params.clientId - 'Client ID' of Hugging Face OAuth2 app. For example: 2ab9cff9-d711-40ad-a91e-b08a49c42d24
959
+ * @param {string} params.clientSecret - 'Client Secret' of Hugging Face OAuth2 app. For example: oauth_app_secret_wcLhRtl000000000000000000000xbNdLt
960
+ * @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
961
+ * @throws {AppwriteException}
962
+ * @returns {Promise<Models.OAuth2HuggingFace>}
963
+ */
964
+ updateOAuth2HuggingFace(params?: {
965
+ clientId?: string;
966
+ clientSecret?: string;
967
+ enabled?: boolean;
968
+ }): Promise<Models.OAuth2HuggingFace>;
969
+ /**
970
+ * Update the project OAuth2 Hugging Face configuration.
971
+ *
972
+ * @param {string} clientId - 'Client ID' of Hugging Face OAuth2 app. For example: 2ab9cff9-d711-40ad-a91e-b08a49c42d24
973
+ * @param {string} clientSecret - 'Client Secret' of Hugging Face OAuth2 app. For example: oauth_app_secret_wcLhRtl000000000000000000000xbNdLt
974
+ * @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
975
+ * @throws {AppwriteException}
976
+ * @returns {Promise<Models.OAuth2HuggingFace>}
977
+ * @deprecated Use the object parameter style method for a better developer experience.
978
+ */
979
+ updateOAuth2HuggingFace(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2HuggingFace>;
980
+ /**
981
+ * Update the project OAuth2 Kakao configuration.
982
+ *
983
+ * @param {string} params.clientId - 'REST API key' of Kakao OAuth2 app. For example: 839ff5000000000000000000013206de
984
+ * @param {string} params.clientSecret - 'Client Secret' of Kakao OAuth2 app. For example: jLNVOK00000000000000000000yJebea. Generate it under Kakao Login > Security and set its status to enabled
985
+ * @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
986
+ * @throws {AppwriteException}
987
+ * @returns {Promise<Models.OAuth2Kakao>}
988
+ */
989
+ updateOAuth2Kakao(params?: {
990
+ clientId?: string;
991
+ clientSecret?: string;
992
+ enabled?: boolean;
993
+ }): Promise<Models.OAuth2Kakao>;
994
+ /**
995
+ * Update the project OAuth2 Kakao configuration.
996
+ *
997
+ * @param {string} clientId - 'REST API key' of Kakao OAuth2 app. For example: 839ff5000000000000000000013206de
998
+ * @param {string} clientSecret - 'Client Secret' of Kakao OAuth2 app. For example: jLNVOK00000000000000000000yJebea. Generate it under Kakao Login > Security and set its status to enabled
999
+ * @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
1000
+ * @throws {AppwriteException}
1001
+ * @returns {Promise<Models.OAuth2Kakao>}
1002
+ * @deprecated Use the object parameter style method for a better developer experience.
1003
+ */
1004
+ updateOAuth2Kakao(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Kakao>;
927
1005
  /**
928
1006
  * Update the project OAuth2 Keycloak configuration.
929
1007
  *
@@ -1207,6 +1285,31 @@ export declare class Project {
1207
1285
  * @deprecated Use the object parameter style method for a better developer experience.
1208
1286
  */
1209
1287
  updateOAuth2Podio(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Podio>;
1288
+ /**
1289
+ * Update the project OAuth2 Resend configuration.
1290
+ *
1291
+ * @param {string} params.clientId - 'Client ID' of Resend OAuth2 app. For example: f47ac10b-58cc-4372-a567-0e02b2c3d479
1292
+ * @param {string} params.clientSecret - 'Client Secret' of Resend OAuth2 app. For example: 9c1e4b00000000000000000000000000000000000000000000000000a72d5f4
1293
+ * @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
1294
+ * @throws {AppwriteException}
1295
+ * @returns {Promise<Models.OAuth2Resend>}
1296
+ */
1297
+ updateOAuth2Resend(params?: {
1298
+ clientId?: string;
1299
+ clientSecret?: string;
1300
+ enabled?: boolean;
1301
+ }): Promise<Models.OAuth2Resend>;
1302
+ /**
1303
+ * Update the project OAuth2 Resend configuration.
1304
+ *
1305
+ * @param {string} clientId - 'Client ID' of Resend OAuth2 app. For example: f47ac10b-58cc-4372-a567-0e02b2c3d479
1306
+ * @param {string} clientSecret - 'Client Secret' of Resend OAuth2 app. For example: 9c1e4b00000000000000000000000000000000000000000000000000a72d5f4
1307
+ * @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
1308
+ * @throws {AppwriteException}
1309
+ * @returns {Promise<Models.OAuth2Resend>}
1310
+ * @deprecated Use the object parameter style method for a better developer experience.
1311
+ */
1312
+ updateOAuth2Resend(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Resend>;
1210
1313
  /**
1211
1314
  * Update the project OAuth2 Salesforce configuration.
1212
1315
  *
@@ -1307,6 +1410,31 @@ export declare class Project {
1307
1410
  * @deprecated Use the object parameter style method for a better developer experience.
1308
1411
  */
1309
1412
  updateOAuth2Stripe(clientId?: string, apiSecretKey?: string, enabled?: boolean): Promise<Models.OAuth2Stripe>;
1413
+ /**
1414
+ * Update the project OAuth2 TikTok configuration.
1415
+ *
1416
+ * @param {string} params.clientId - 'Client key' of TikTok OAuth2 app. For example: awz000000000tyw0
1417
+ * @param {string} params.clientSecret - 'Client secret' of TikTok OAuth2 app. For example: 6wXewM00000000000000000000yXnite
1418
+ * @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
1419
+ * @throws {AppwriteException}
1420
+ * @returns {Promise<Models.OAuth2TikTok>}
1421
+ */
1422
+ updateOAuth2TikTok(params?: {
1423
+ clientId?: string;
1424
+ clientSecret?: string;
1425
+ enabled?: boolean;
1426
+ }): Promise<Models.OAuth2TikTok>;
1427
+ /**
1428
+ * Update the project OAuth2 TikTok configuration.
1429
+ *
1430
+ * @param {string} clientId - 'Client key' of TikTok OAuth2 app. For example: awz000000000tyw0
1431
+ * @param {string} clientSecret - 'Client secret' of TikTok OAuth2 app. For example: 6wXewM00000000000000000000yXnite
1432
+ * @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
1433
+ * @throws {AppwriteException}
1434
+ * @returns {Promise<Models.OAuth2TikTok>}
1435
+ * @deprecated Use the object parameter style method for a better developer experience.
1436
+ */
1437
+ updateOAuth2TikTok(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2TikTok>;
1310
1438
  /**
1311
1439
  * Update the project OAuth2 Tradeshift configuration.
1312
1440
  *
@@ -1537,20 +1665,20 @@ export declare class Project {
1537
1665
  *
1538
1666
  * @param {ProjectOAuthProviderId} params.providerId - OAuth2 provider key. For example: github, google, apple.
1539
1667
  * @throws {AppwriteException}
1540
- * @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>}
1668
+ * @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2TikTok | Models.OAuth2Kakao>}
1541
1669
  */
1542
1670
  getOAuth2Provider(params: {
1543
1671
  providerId: ProjectOAuthProviderId;
1544
- }): Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>;
1672
+ }): Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2TikTok | Models.OAuth2Kakao>;
1545
1673
  /**
1546
1674
  * Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
1547
1675
  *
1548
1676
  * @param {ProjectOAuthProviderId} providerId - OAuth2 provider key. For example: github, google, apple.
1549
1677
  * @throws {AppwriteException}
1550
- * @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>}
1678
+ * @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2TikTok | Models.OAuth2Kakao>}
1551
1679
  * @deprecated Use the object parameter style method for a better developer experience.
1552
1680
  */
1553
- getOAuth2Provider(providerId: ProjectOAuthProviderId): Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>;
1681
+ getOAuth2Provider(providerId: ProjectOAuthProviderId): Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2TikTok | Models.OAuth2Kakao>;
1554
1682
  /**
1555
1683
  * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
1556
1684
  *
@@ -1993,6 +2121,34 @@ export declare class Project {
1993
2121
  * @deprecated Use the object parameter style method for a better developer experience.
1994
2122
  */
1995
2123
  updateMembershipPrivacyPolicy(userId?: boolean, userEmail?: boolean, userPhone?: boolean, userName?: boolean, userMFA?: boolean, userAccessedAt?: boolean): Promise<Models.Project>;
2124
+ /**
2125
+ * Updating this policy allows you to control which factors users can use to complete an MFA challenge. Disabled factors cannot be used to create a challenge and are reported as unavailable when listing factors. The custom factor is disabled by default; enable it to deliver challenge codes through your own channel. Recovery codes always remain available as a fallback.
2126
+ *
2127
+ * @param {boolean} params.totp - Set to true to allow TOTP to complete an MFA challenge, or false to disable it.
2128
+ * @param {boolean} params.email - Set to true to allow email to complete an MFA challenge, or false to disable it.
2129
+ * @param {boolean} params.phone - Set to true to allow phone (SMS) to complete an MFA challenge, or false to disable it.
2130
+ * @param {boolean} params.custom - Set to true to allow the custom factor to complete an MFA challenge, or false to disable it.
2131
+ * @throws {AppwriteException}
2132
+ * @returns {Promise<Models.Project>}
2133
+ */
2134
+ updateMFAFactorsPolicy(params?: {
2135
+ totp?: boolean;
2136
+ email?: boolean;
2137
+ phone?: boolean;
2138
+ custom?: boolean;
2139
+ }): Promise<Models.Project>;
2140
+ /**
2141
+ * Updating this policy allows you to control which factors users can use to complete an MFA challenge. Disabled factors cannot be used to create a challenge and are reported as unavailable when listing factors. The custom factor is disabled by default; enable it to deliver challenge codes through your own channel. Recovery codes always remain available as a fallback.
2142
+ *
2143
+ * @param {boolean} totp - Set to true to allow TOTP to complete an MFA challenge, or false to disable it.
2144
+ * @param {boolean} email - Set to true to allow email to complete an MFA challenge, or false to disable it.
2145
+ * @param {boolean} phone - Set to true to allow phone (SMS) to complete an MFA challenge, or false to disable it.
2146
+ * @param {boolean} custom - Set to true to allow the custom factor to complete an MFA challenge, or false to disable it.
2147
+ * @throws {AppwriteException}
2148
+ * @returns {Promise<Models.Project>}
2149
+ * @deprecated Use the object parameter style method for a better developer experience.
2150
+ */
2151
+ updateMFAFactorsPolicy(totp?: boolean, email?: boolean, phone?: boolean, custom?: boolean): Promise<Models.Project>;
1996
2152
  /**
1997
2153
  * Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.
1998
2154
  *
@@ -2183,22 +2339,22 @@ export declare class Project {
2183
2339
  /**
2184
2340
  * Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
2185
2341
  *
2186
- * @param {ProjectPolicyId} params.policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
2342
+ * @param {ProjectPolicyId} params.policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
2187
2343
  * @throws {AppwriteException}
2188
- * @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
2344
+ * @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
2189
2345
  */
2190
2346
  getPolicy(params: {
2191
2347
  policyId: ProjectPolicyId;
2192
- }): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
2348
+ }): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
2193
2349
  /**
2194
2350
  * Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
2195
2351
  *
2196
- * @param {ProjectPolicyId} policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
2352
+ * @param {ProjectPolicyId} policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
2197
2353
  * @throws {AppwriteException}
2198
- * @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
2354
+ * @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
2199
2355
  * @deprecated Use the object parameter style method for a better developer experience.
2200
2356
  */
2201
- getPolicy(policyId: ProjectPolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
2357
+ getPolicy(policyId: ProjectPolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
2202
2358
  /**
2203
2359
  * Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
2204
2360
  *
@@ -2443,7 +2599,7 @@ export declare class Project {
2443
2599
  * Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
2444
2600
  *
2445
2601
  * @param {string} params.variableId - Variable unique 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.
2446
- * @param {string} params.key - Variable key. Max length: 255 chars.
2602
+ * @param {string} params.key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
2447
2603
  * @param {string} params.value - Variable value. Max length: 8192 chars.
2448
2604
  * @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
2449
2605
  * @throws {AppwriteException}
@@ -2459,7 +2615,7 @@ export declare class Project {
2459
2615
  * Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
2460
2616
  *
2461
2617
  * @param {string} variableId - Variable unique 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.
2462
- * @param {string} key - Variable key. Max length: 255 chars.
2618
+ * @param {string} key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
2463
2619
  * @param {string} value - Variable value. Max length: 8192 chars.
2464
2620
  * @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
2465
2621
  * @throws {AppwriteException}
@@ -2490,7 +2646,7 @@ export declare class Project {
2490
2646
  * Update variable by its unique ID.
2491
2647
  *
2492
2648
  * @param {string} params.variableId - Variable unique ID.
2493
- * @param {string} params.key - Variable key. Max length: 255 chars.
2649
+ * @param {string} params.key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
2494
2650
  * @param {string} params.value - Variable value. Max length: 8192 chars.
2495
2651
  * @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
2496
2652
  * @throws {AppwriteException}
@@ -2506,7 +2662,7 @@ export declare class Project {
2506
2662
  * Update variable by its unique ID.
2507
2663
  *
2508
2664
  * @param {string} variableId - Variable unique ID.
2509
- * @param {string} key - Variable key. Max length: 255 chars.
2665
+ * @param {string} key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
2510
2666
  * @param {string} value - Variable value. Max length: 8192 chars.
2511
2667
  * @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
2512
2668
  * @throws {AppwriteException}
@@ -1,10 +1,40 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
+ import { InvalidationType } from '../enums/invalidation-type';
3
4
  import { StatusCode } from '../enums/status-code';
4
5
  import { ProxyResourceType } from '../enums/proxy-resource-type';
5
6
  export declare class Proxy {
6
7
  client: Client;
7
8
  constructor(client: Client);
9
+ /**
10
+ * Create a new CDN cache invalidation for a domain. Executes a hard purge of cached content.
11
+ *
12
+ * Depending on type, the invalidation purges a single cache tag, a single URL path, or all cached content for the domain.
13
+ *
14
+ * @param {string} params.domain - Domain name.
15
+ * @param {InvalidationType} params.type - Type of reference passed. Allowed values are: tag, path, all
16
+ * @param {string} params.reference - Reference to invalidate. Depending on type this can be: cache tag name (up to 128 characters), URL path (up to 2048 characters). Not required when type is all.
17
+ * @throws {AppwriteException}
18
+ * @returns {Promise<Models.ProxyInvalidation>}
19
+ */
20
+ createInvalidation(params: {
21
+ domain: string;
22
+ type: InvalidationType;
23
+ reference?: string;
24
+ }): Promise<Models.ProxyInvalidation>;
25
+ /**
26
+ * Create a new CDN cache invalidation for a domain. Executes a hard purge of cached content.
27
+ *
28
+ * Depending on type, the invalidation purges a single cache tag, a single URL path, or all cached content for the domain.
29
+ *
30
+ * @param {string} domain - Domain name.
31
+ * @param {InvalidationType} type - Type of reference passed. Allowed values are: tag, path, all
32
+ * @param {string} reference - Reference to invalidate. Depending on type this can be: cache tag name (up to 128 characters), URL path (up to 2048 characters). Not required when type is all.
33
+ * @throws {AppwriteException}
34
+ * @returns {Promise<Models.ProxyInvalidation>}
35
+ * @deprecated Use the object parameter style method for a better developer experience.
36
+ */
37
+ createInvalidation(domain: string, type: InvalidationType, reference?: string): Promise<Models.ProxyInvalidation>;
8
38
  /**
9
39
  * Get a list of all the proxy rules. You can use the query params to filter your results.
10
40
  *
@@ -3,6 +3,7 @@ import type { Models } from '../models';
3
3
  import { Framework } from '../enums/framework';
4
4
  import { BuildRuntime } from '../enums/build-runtime';
5
5
  import { Adapter } from '../enums/adapter';
6
+ import { ProjectKeyScopes } from '../enums/project-key-scopes';
6
7
  import { SiteTemplateUseCase } from '../enums/site-template-use-case';
7
8
  import { TemplateReferenceType } from '../enums/template-reference-type';
8
9
  import { VCSReferenceType } from '../enums/vcs-reference-type';
@@ -61,6 +62,7 @@ export declare class Sites {
61
62
  * @param {string} params.buildSpecification - Build specification for the site deployments.
62
63
  * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
63
64
  * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
65
+ * @param {ProjectKeyScopes[]} params.scopes - List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
64
66
  * @throws {AppwriteException}
65
67
  * @returns {Promise<Models.Site>}
66
68
  */
@@ -88,6 +90,7 @@ export declare class Sites {
88
90
  buildSpecification?: string;
89
91
  runtimeSpecification?: string;
90
92
  deploymentRetention?: number;
93
+ scopes?: ProjectKeyScopes[];
91
94
  }): Promise<Models.Site>;
92
95
  /**
93
96
  * Create a new site.
@@ -115,11 +118,12 @@ export declare class Sites {
115
118
  * @param {string} buildSpecification - Build specification for the site deployments.
116
119
  * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
117
120
  * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
121
+ * @param {ProjectKeyScopes[]} scopes - List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
118
122
  * @throws {AppwriteException}
119
123
  * @returns {Promise<Models.Site>}
120
124
  * @deprecated Use the object parameter style method for a better developer experience.
121
125
  */
122
- create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
126
+ create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number, scopes?: ProjectKeyScopes[]): Promise<Models.Site>;
123
127
  /**
124
128
  * Get a list of all frameworks that are currently available on the server instance.
125
129
  *
@@ -130,7 +134,7 @@ export declare class Sites {
130
134
  /**
131
135
  * List allowed site specifications for this instance.
132
136
  *
133
- * @param {string} params.type - Specification type to list. Can be one of: runtimes, builds.
137
+ * @param {string} params.type - Specification type to list. Can be one of: runtimes, builds. Defaults to runtimes.
134
138
  * @throws {AppwriteException}
135
139
  * @returns {Promise<Models.SpecificationList>}
136
140
  */
@@ -140,7 +144,7 @@ export declare class Sites {
140
144
  /**
141
145
  * List allowed site specifications for this instance.
142
146
  *
143
- * @param {string} type - Specification type to list. Can be one of: runtimes, builds.
147
+ * @param {string} type - Specification type to list. Can be one of: runtimes, builds. Defaults to runtimes.
144
148
  * @throws {AppwriteException}
145
149
  * @returns {Promise<Models.SpecificationList>}
146
150
  * @deprecated Use the object parameter style method for a better developer experience.
@@ -238,6 +242,7 @@ export declare class Sites {
238
242
  * @param {string} params.buildSpecification - Build specification for the site deployments.
239
243
  * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
240
244
  * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
245
+ * @param {ProjectKeyScopes[]} params.scopes - List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
241
246
  * @throws {AppwriteException}
242
247
  * @returns {Promise<Models.Site>}
243
248
  */
@@ -265,6 +270,7 @@ export declare class Sites {
265
270
  buildSpecification?: string;
266
271
  runtimeSpecification?: string;
267
272
  deploymentRetention?: number;
273
+ scopes?: ProjectKeyScopes[];
268
274
  }): Promise<Models.Site>;
269
275
  /**
270
276
  * Update site by its unique ID.
@@ -292,11 +298,12 @@ export declare class Sites {
292
298
  * @param {string} buildSpecification - Build specification for the site deployments.
293
299
  * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
294
300
  * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
301
+ * @param {ProjectKeyScopes[]} scopes - List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
295
302
  * @throws {AppwriteException}
296
303
  * @returns {Promise<Models.Site>}
297
304
  * @deprecated Use the object parameter style method for a better developer experience.
298
305
  */
299
- update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
306
+ update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number, scopes?: ProjectKeyScopes[]): Promise<Models.Site>;
300
307
  /**
301
308
  * Delete a site by its unique ID.
302
309
  *
@@ -689,7 +696,7 @@ export declare class Sites {
689
696
  *
690
697
  * @param {string} params.siteId - Site unique ID.
691
698
  * @param {string} params.variableId - Variable 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.
692
- * @param {string} params.key - Variable key. Max length: 255 chars.
699
+ * @param {string} params.key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
693
700
  * @param {string} params.value - Variable value. Max length: 8192 chars.
694
701
  * @param {boolean} params.secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
695
702
  * @throws {AppwriteException}
@@ -707,7 +714,7 @@ export declare class Sites {
707
714
  *
708
715
  * @param {string} siteId - Site unique ID.
709
716
  * @param {string} variableId - Variable 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.
710
- * @param {string} key - Variable key. Max length: 255 chars.
717
+ * @param {string} key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
711
718
  * @param {string} value - Variable value. Max length: 8192 chars.
712
719
  * @param {boolean} secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
713
720
  * @throws {AppwriteException}
@@ -742,7 +749,7 @@ export declare class Sites {
742
749
  *
743
750
  * @param {string} params.siteId - Site unique ID.
744
751
  * @param {string} params.variableId - Variable unique ID.
745
- * @param {string} params.key - Variable key. Max length: 255 chars.
752
+ * @param {string} params.key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
746
753
  * @param {string} params.value - Variable value. Max length: 8192 chars.
747
754
  * @param {boolean} params.secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
748
755
  * @throws {AppwriteException}
@@ -760,7 +767,7 @@ export declare class Sites {
760
767
  *
761
768
  * @param {string} siteId - Site unique ID.
762
769
  * @param {string} variableId - Variable unique ID.
763
- * @param {string} key - Variable key. Max length: 255 chars.
770
+ * @param {string} key - Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
764
771
  * @param {string} value - Variable value. Max length: 8192 chars.
765
772
  * @param {boolean} secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
766
773
  * @throws {AppwriteException}
@@ -39,7 +39,7 @@ export declare class Storage {
39
39
  * @param {string[]} params.permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
40
40
  * @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
41
41
  * @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
42
- * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
42
+ * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 0B.
43
43
  * @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
44
44
  * @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
45
45
  * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
@@ -69,7 +69,7 @@ export declare class Storage {
69
69
  * @param {string[]} permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
70
70
  * @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
71
71
  * @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
72
- * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
72
+ * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 0B.
73
73
  * @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
74
74
  * @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
75
75
  * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
@@ -107,7 +107,7 @@ export declare class Storage {
107
107
  * @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).
108
108
  * @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
109
109
  * @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
110
- * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
110
+ * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 0B.
111
111
  * @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
112
112
  * @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
113
113
  * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
@@ -137,7 +137,7 @@ export declare class Storage {
137
137
  * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
138
138
  * @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
139
139
  * @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
140
- * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
140
+ * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 0B.
141
141
  * @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
142
142
  * @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
143
143
  * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
@@ -345,7 +345,7 @@ export declare class Storage {
345
345
  * @param {string} params.fileId - File ID
346
346
  * @param {number} params.width - Resize preview image width, Pass an integer between 0 to 4000.
347
347
  * @param {number} params.height - Resize preview image height, Pass an integer between 0 to 4000.
348
- * @param {ImageGravity} params.gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
348
+ * @param {ImageGravity} params.gravity - Image crop gravity. Can be one of auto,center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
349
349
  * @param {number} params.quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
350
350
  * @param {number} params.borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
351
351
  * @param {string} params.borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
@@ -381,7 +381,7 @@ export declare class Storage {
381
381
  * @param {string} fileId - File ID
382
382
  * @param {number} width - Resize preview image width, Pass an integer between 0 to 4000.
383
383
  * @param {number} height - Resize preview image height, Pass an integer between 0 to 4000.
384
- * @param {ImageGravity} gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
384
+ * @param {ImageGravity} gravity - Image crop gravity. Can be one of auto,center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
385
385
  * @param {number} quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
386
386
  * @param {number} borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
387
387
  * @param {string} borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.