@appwrite.io/console 13.1.0 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/sdk.js +5059 -687
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +5057 -688
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +5061 -689
  7. package/package.json +1 -1
  8. package/types/enums/{site-adapter.d.ts → adapter.d.ts} +1 -1
  9. package/types/enums/{organization-addon.d.ts → addon.d.ts} +1 -1
  10. package/types/enums/appwrite-migration-resource.d.ts +13 -1
  11. package/types/enums/{function-runtime.d.ts → build-runtime.d.ts} +1 -1
  12. package/types/enums/embedding-model.d.ts +4 -1
  13. package/types/enums/{site-framework.d.ts → framework.d.ts} +1 -1
  14. package/types/enums/{migration-on-duplicate.d.ts → on-duplicate.d.ts} +1 -1
  15. package/types/enums/project-key-scopes.d.ts +3 -0
  16. package/types/enums/project-policy-id.d.ts +5 -1
  17. package/types/enums/query-suggestion-resource.d.ts +3 -0
  18. package/types/enums/{site-build-runtime.d.ts → runtime.d.ts} +1 -1
  19. package/types/enums/{redirect-status-code.d.ts → status-code.d.ts} +1 -1
  20. package/types/enums/status.d.ts +3 -0
  21. package/types/index.d.ts +11 -8
  22. package/types/models.d.ts +1490 -67
  23. package/types/services/account.d.ts +2 -2
  24. package/types/services/advisor.d.ts +123 -0
  25. package/types/services/apps.d.ts +302 -0
  26. package/types/services/compute.d.ts +1074 -0
  27. package/types/services/databases.d.ts +24 -24
  28. package/types/services/documents-db.d.ts +4 -1
  29. package/types/services/functions.d.ts +13 -13
  30. package/types/services/health.d.ts +8 -0
  31. package/types/services/messaging.d.ts +92 -0
  32. package/types/services/migrations.d.ts +13 -13
  33. package/types/services/organizations.d.ts +13 -13
  34. package/types/services/project.d.ts +96 -7
  35. package/types/services/projects.d.ts +5 -5
  36. package/types/services/proxy.d.ts +5 -5
  37. package/types/services/sites.d.ts +27 -27
  38. package/types/services/tables-db.d.ts +28 -25
  39. package/types/services/vectors-db.d.ts +4 -1
  40. package/types/enums/project-status.d.ts +0 -3
@@ -1,7 +1,7 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
3
  import { Platform } from '../enums/platform';
4
- import { OrganizationAddon } from '../enums/organization-addon';
4
+ import { Addon } from '../enums/addon';
5
5
  export declare class Organizations {
6
6
  client: Client;
7
7
  constructor(client: Client);
@@ -244,25 +244,25 @@ export declare class Organizations {
244
244
  *
245
245
  *
246
246
  * @param {string} params.organizationId - Organization ID
247
- * @param {OrganizationAddon} params.addon - Addon key identifier (e.g. baa).
247
+ * @param {Addon} params.addon - Addon key identifier (e.g. baa).
248
248
  * @throws {AppwriteException}
249
249
  * @returns {Promise<Models.AddonPrice>}
250
250
  */
251
251
  getAddonPrice(params: {
252
252
  organizationId: string;
253
- addon: OrganizationAddon;
253
+ addon: Addon;
254
254
  }): Promise<Models.AddonPrice>;
255
255
  /**
256
256
  * Get the price details for a billing addon for an organization.
257
257
  *
258
258
  *
259
259
  * @param {string} organizationId - Organization ID
260
- * @param {OrganizationAddon} addon - Addon key identifier (e.g. baa).
260
+ * @param {Addon} addon - Addon key identifier (e.g. baa).
261
261
  * @throws {AppwriteException}
262
262
  * @returns {Promise<Models.AddonPrice>}
263
263
  * @deprecated Use the object parameter style method for a better developer experience.
264
264
  */
265
- getAddonPrice(organizationId: string, addon: OrganizationAddon): Promise<Models.AddonPrice>;
265
+ getAddonPrice(organizationId: string, addon: Addon): Promise<Models.AddonPrice>;
266
266
  /**
267
267
  * Get a list of all aggregations for an organization.
268
268
  *
@@ -640,22 +640,22 @@ export declare class Organizations {
640
640
  * @param {string} params.organizationId - Organization ID
641
641
  * @param {string} params.invoiceId - Invoice unique ID
642
642
  * @throws {AppwriteException}
643
- * @returns {Promise<Models.PaymentMethod>}
643
+ * @returns {string}
644
644
  */
645
645
  getInvoiceDownload(params: {
646
646
  organizationId: string;
647
647
  invoiceId: string;
648
- }): Promise<Models.PaymentMethod>;
648
+ }): string;
649
649
  /**
650
650
  * Download invoice in PDF
651
651
  *
652
652
  * @param {string} organizationId - Organization ID
653
653
  * @param {string} invoiceId - Invoice unique ID
654
654
  * @throws {AppwriteException}
655
- * @returns {Promise<Models.PaymentMethod>}
655
+ * @returns {string}
656
656
  * @deprecated Use the object parameter style method for a better developer experience.
657
657
  */
658
- getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
658
+ getInvoiceDownload(organizationId: string, invoiceId: string): string;
659
659
  /**
660
660
  * Initiate payment for failed invoice to pay live from console
661
661
  *
@@ -709,22 +709,22 @@ export declare class Organizations {
709
709
  * @param {string} params.organizationId - Organization ID
710
710
  * @param {string} params.invoiceId - Invoice unique ID
711
711
  * @throws {AppwriteException}
712
- * @returns {Promise<Models.PaymentMethod>}
712
+ * @returns {string}
713
713
  */
714
714
  getInvoiceView(params: {
715
715
  organizationId: string;
716
716
  invoiceId: string;
717
- }): Promise<Models.PaymentMethod>;
717
+ }): string;
718
718
  /**
719
719
  * View invoice in PDF
720
720
  *
721
721
  * @param {string} organizationId - Organization ID
722
722
  * @param {string} invoiceId - Invoice unique ID
723
723
  * @throws {AppwriteException}
724
- * @returns {Promise<Models.PaymentMethod>}
724
+ * @returns {string}
725
725
  * @deprecated Use the object parameter style method for a better developer experience.
726
726
  */
727
- getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
727
+ getInvoiceView(organizationId: string, invoiceId: string): string;
728
728
  /**
729
729
  * Set a organization's default payment method.
730
730
  *
@@ -341,6 +341,61 @@ export declare class Project {
341
341
  * @deprecated Use the object parameter style method for a better developer experience.
342
342
  */
343
343
  listOAuth2Providers(queries?: string[], total?: boolean): Promise<Models.OAuth2ProviderList>;
344
+ /**
345
+ * Update the OAuth2 server (OIDC provider) configuration.
346
+ *
347
+ * @param {boolean} params.enabled - Enable or disable the OAuth2 server.
348
+ * @param {string} params.authorizationUrl - URL to your application with consent screen.
349
+ * @param {string[]} params.scopes - List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.
350
+ * @param {string[]} params.authorizationDetailsTypes - List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.
351
+ * @param {number} params.accessTokenDuration - Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.
352
+ * @param {number} params.refreshTokenDuration - Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.
353
+ * @param {number} params.publicAccessTokenDuration - Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.
354
+ * @param {number} params.publicRefreshTokenDuration - Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.
355
+ * @param {boolean} params.confidentialPkce - When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
356
+ * @param {string} params.verificationUrl - URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.
357
+ * @param {number} params.userCodeLength - Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.
358
+ * @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`.
359
+ * @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.
360
+ * @throws {AppwriteException}
361
+ * @returns {Promise<Models.Project>}
362
+ */
363
+ updateOAuth2Server(params: {
364
+ enabled: boolean;
365
+ authorizationUrl: string;
366
+ scopes?: string[];
367
+ authorizationDetailsTypes?: string[];
368
+ accessTokenDuration?: number;
369
+ refreshTokenDuration?: number;
370
+ publicAccessTokenDuration?: number;
371
+ publicRefreshTokenDuration?: number;
372
+ confidentialPkce?: boolean;
373
+ verificationUrl?: string;
374
+ userCodeLength?: number;
375
+ userCodeFormat?: string;
376
+ deviceCodeDuration?: number;
377
+ }): Promise<Models.Project>;
378
+ /**
379
+ * Update the OAuth2 server (OIDC provider) configuration.
380
+ *
381
+ * @param {boolean} enabled - Enable or disable the OAuth2 server.
382
+ * @param {string} authorizationUrl - URL to your application with consent screen.
383
+ * @param {string[]} scopes - List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.
384
+ * @param {string[]} authorizationDetailsTypes - List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.
385
+ * @param {number} accessTokenDuration - Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.
386
+ * @param {number} refreshTokenDuration - Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.
387
+ * @param {number} publicAccessTokenDuration - Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.
388
+ * @param {number} publicRefreshTokenDuration - Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.
389
+ * @param {boolean} confidentialPkce - When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
390
+ * @param {string} verificationUrl - URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.
391
+ * @param {number} userCodeLength - Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.
392
+ * @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`.
393
+ * @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.
394
+ * @throws {AppwriteException}
395
+ * @returns {Promise<Models.Project>}
396
+ * @deprecated Use the object parameter style method for a better developer experience.
397
+ */
398
+ updateOAuth2Server(enabled: boolean, authorizationUrl: string, scopes?: string[], authorizationDetailsTypes?: string[], accessTokenDuration?: number, refreshTokenDuration?: number, publicAccessTokenDuration?: number, publicRefreshTokenDuration?: number, confidentialPkce?: boolean, verificationUrl?: string, userCodeLength?: number, userCodeFormat?: string, deviceCodeDuration?: number): Promise<Models.Project>;
344
399
  /**
345
400
  * Update the project OAuth2 Amazon configuration.
346
401
  *
@@ -1855,6 +1910,7 @@ export declare class Project {
1855
1910
  * @param {boolean} params.userPhone - Set to true if you want make user phone number visible to all team members, or false to hide it.
1856
1911
  * @param {boolean} params.userName - Set to true if you want make user name visible to all team members, or false to hide it.
1857
1912
  * @param {boolean} params.userMFA - Set to true if you want make user MFA status visible to all team members, or false to hide it.
1913
+ * @param {boolean} params.userAccessedAt - Set to true if you want make user last access time visible to all team members, or false to hide it.
1858
1914
  * @throws {AppwriteException}
1859
1915
  * @returns {Promise<Models.Project>}
1860
1916
  */
@@ -1864,6 +1920,7 @@ export declare class Project {
1864
1920
  userPhone?: boolean;
1865
1921
  userName?: boolean;
1866
1922
  userMFA?: boolean;
1923
+ userAccessedAt?: boolean;
1867
1924
  }): Promise<Models.Project>;
1868
1925
  /**
1869
1926
  * Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..
@@ -1873,11 +1930,12 @@ export declare class Project {
1873
1930
  * @param {boolean} userPhone - Set to true if you want make user phone number visible to all team members, or false to hide it.
1874
1931
  * @param {boolean} userName - Set to true if you want make user name visible to all team members, or false to hide it.
1875
1932
  * @param {boolean} userMFA - Set to true if you want make user MFA status visible to all team members, or false to hide it.
1933
+ * @param {boolean} userAccessedAt - Set to true if you want make user last access time visible to all team members, or false to hide it.
1876
1934
  * @throws {AppwriteException}
1877
1935
  * @returns {Promise<Models.Project>}
1878
1936
  * @deprecated Use the object parameter style method for a better developer experience.
1879
1937
  */
1880
- updateMembershipPrivacyPolicy(userId?: boolean, userEmail?: boolean, userPhone?: boolean, userName?: boolean, userMFA?: boolean): Promise<Models.Project>;
1938
+ updateMembershipPrivacyPolicy(userId?: boolean, userEmail?: boolean, userPhone?: boolean, userName?: boolean, userMFA?: boolean, userAccessedAt?: boolean): Promise<Models.Project>;
1881
1939
  /**
1882
1940
  * 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.
1883
1941
  *
@@ -1939,6 +1997,37 @@ export declare class Project {
1939
1997
  * @deprecated Use the object parameter style method for a better developer experience.
1940
1998
  */
1941
1999
  updatePasswordPersonalDataPolicy(enabled: boolean): Promise<Models.Project>;
2000
+ /**
2001
+ * Update the password strength requirements for users in the project.
2002
+ *
2003
+ * @param {number} params.min - Minimum password length. Value must be between 8 and 256. Default is 8.
2004
+ * @param {boolean} params.uppercase - Whether passwords must include at least one uppercase letter.
2005
+ * @param {boolean} params.lowercase - Whether passwords must include at least one lowercase letter.
2006
+ * @param {boolean} params.number - Whether passwords must include at least one number.
2007
+ * @param {boolean} params.symbols - Whether passwords must include at least one symbol.
2008
+ * @throws {AppwriteException}
2009
+ * @returns {Promise<Models.PolicyPasswordStrength>}
2010
+ */
2011
+ updatePasswordStrengthPolicy(params?: {
2012
+ min?: number;
2013
+ uppercase?: boolean;
2014
+ lowercase?: boolean;
2015
+ number?: boolean;
2016
+ symbols?: boolean;
2017
+ }): Promise<Models.PolicyPasswordStrength>;
2018
+ /**
2019
+ * Update the password strength requirements for users in the project.
2020
+ *
2021
+ * @param {number} min - Minimum password length. Value must be between 8 and 256. Default is 8.
2022
+ * @param {boolean} uppercase - Whether passwords must include at least one uppercase letter.
2023
+ * @param {boolean} lowercase - Whether passwords must include at least one lowercase letter.
2024
+ * @param {boolean} number - Whether passwords must include at least one number.
2025
+ * @param {boolean} symbols - Whether passwords must include at least one symbol.
2026
+ * @throws {AppwriteException}
2027
+ * @returns {Promise<Models.PolicyPasswordStrength>}
2028
+ * @deprecated Use the object parameter style method for a better developer experience.
2029
+ */
2030
+ updatePasswordStrengthPolicy(min?: number, uppercase?: boolean, lowercase?: boolean, number?: boolean, symbols?: boolean): Promise<Models.PolicyPasswordStrength>;
1942
2031
  /**
1943
2032
  * Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.
1944
2033
  *
@@ -2037,22 +2126,22 @@ export declare class Project {
2037
2126
  /**
2038
2127
  * Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
2039
2128
  *
2040
- * @param {ProjectPolicyId} params.policyId - Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.
2129
+ * @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.
2041
2130
  * @throws {AppwriteException}
2042
- * @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
2131
+ * @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>}
2043
2132
  */
2044
2133
  getPolicy(params: {
2045
2134
  policyId: ProjectPolicyId;
2046
- }): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
2135
+ }): 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>;
2047
2136
  /**
2048
2137
  * Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
2049
2138
  *
2050
- * @param {ProjectPolicyId} policyId - Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.
2139
+ * @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.
2051
2140
  * @throws {AppwriteException}
2052
- * @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
2141
+ * @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>}
2053
2142
  * @deprecated Use the object parameter style method for a better developer experience.
2054
2143
  */
2055
- getPolicy(policyId: ProjectPolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
2144
+ 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>;
2056
2145
  /**
2057
2146
  * Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
2058
2147
  *
@@ -1,7 +1,7 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
3
  import { ScheduleResourceType } from '../enums/schedule-resource-type';
4
- import { ProjectStatus } from '../enums/project-status';
4
+ import { Status } from '../enums/status';
5
5
  export declare class Projects {
6
6
  client: Client;
7
7
  constructor(client: Client);
@@ -231,25 +231,25 @@ export declare class Projects {
231
231
  *
232
232
  *
233
233
  * @param {string} params.projectId - Project ID
234
- * @param {ProjectStatus} params.status - New status for the project
234
+ * @param {Status} params.status - New status for the project
235
235
  * @throws {AppwriteException}
236
236
  * @returns {Promise<{}>}
237
237
  */
238
238
  updateStatus(params: {
239
239
  projectId: string;
240
- status: ProjectStatus;
240
+ status: Status;
241
241
  }): Promise<{}>;
242
242
  /**
243
243
  * Update the status of a project. Can be used to archive/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.
244
244
  *
245
245
  *
246
246
  * @param {string} projectId - Project ID
247
- * @param {ProjectStatus} status - New status for the project
247
+ * @param {Status} status - New status for the project
248
248
  * @throws {AppwriteException}
249
249
  * @returns {Promise<{}>}
250
250
  * @deprecated Use the object parameter style method for a better developer experience.
251
251
  */
252
- updateStatus(projectId: string, status: ProjectStatus): Promise<{}>;
252
+ updateStatus(projectId: string, status: Status): Promise<{}>;
253
253
  /**
254
254
  * Update the team ID of a project allowing for it to be transferred to another team.
255
255
  *
@@ -1,6 +1,6 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
- import { RedirectStatusCode } from '../enums/redirect-status-code';
3
+ import { StatusCode } from '../enums/status-code';
4
4
  import { ProxyResourceType } from '../enums/proxy-resource-type';
5
5
  export declare class Proxy {
6
6
  client: Client;
@@ -86,7 +86,7 @@ export declare class Proxy {
86
86
  *
87
87
  * @param {string} params.domain - Domain name.
88
88
  * @param {string} params.url - Target URL of redirection
89
- * @param {RedirectStatusCode} params.statusCode - Status code of redirection
89
+ * @param {StatusCode} params.statusCode - Status code of redirection
90
90
  * @param {string} params.resourceId - ID of parent resource.
91
91
  * @param {ProxyResourceType} params.resourceType - Type of parent resource.
92
92
  * @throws {AppwriteException}
@@ -95,7 +95,7 @@ export declare class Proxy {
95
95
  createRedirectRule(params: {
96
96
  domain: string;
97
97
  url: string;
98
- statusCode: RedirectStatusCode;
98
+ statusCode: StatusCode;
99
99
  resourceId: string;
100
100
  resourceType: ProxyResourceType;
101
101
  }): Promise<Models.ProxyRule>;
@@ -106,14 +106,14 @@ export declare class Proxy {
106
106
  *
107
107
  * @param {string} domain - Domain name.
108
108
  * @param {string} url - Target URL of redirection
109
- * @param {RedirectStatusCode} statusCode - Status code of redirection
109
+ * @param {StatusCode} statusCode - Status code of redirection
110
110
  * @param {string} resourceId - ID of parent resource.
111
111
  * @param {ProxyResourceType} resourceType - Type of parent resource.
112
112
  * @throws {AppwriteException}
113
113
  * @returns {Promise<Models.ProxyRule>}
114
114
  * @deprecated Use the object parameter style method for a better developer experience.
115
115
  */
116
- createRedirectRule(domain: string, url: string, statusCode: RedirectStatusCode, resourceId: string, resourceType: ProxyResourceType): Promise<Models.ProxyRule>;
116
+ createRedirectRule(domain: string, url: string, statusCode: StatusCode, resourceId: string, resourceType: ProxyResourceType): Promise<Models.ProxyRule>;
117
117
  /**
118
118
  * Create a new proxy rule for serving Appwrite Site on custom domain.
119
119
  *
@@ -1,8 +1,8 @@
1
1
  import { Client, UploadProgress } from '../client';
2
2
  import type { Models } from '../models';
3
- import { SiteFramework } from '../enums/site-framework';
4
- import { SiteBuildRuntime } from '../enums/site-build-runtime';
5
- import { SiteAdapter } from '../enums/site-adapter';
3
+ import { Framework } from '../enums/framework';
4
+ import { BuildRuntime } from '../enums/build-runtime';
5
+ import { Adapter } from '../enums/adapter';
6
6
  import { SiteTemplateUseCase } from '../enums/site-template-use-case';
7
7
  import { UsageRange } from '../enums/usage-range';
8
8
  import { TemplateReferenceType } from '../enums/template-reference-type';
@@ -41,8 +41,8 @@ export declare class Sites {
41
41
  *
42
42
  * @param {string} params.siteId - Site 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.
43
43
  * @param {string} params.name - Site name. Max length: 128 chars.
44
- * @param {SiteFramework} params.framework - Sites framework.
45
- * @param {SiteBuildRuntime} params.buildRuntime - Runtime to use during build step.
44
+ * @param {Framework} params.framework - Sites framework.
45
+ * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
46
46
  * @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
47
47
  * @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
48
48
  * @param {number} params.timeout - Maximum request time in seconds.
@@ -50,7 +50,7 @@ export declare class Sites {
50
50
  * @param {string} params.buildCommand - Build Command.
51
51
  * @param {string} params.startCommand - Custom start command. Leave empty to use default.
52
52
  * @param {string} params.outputDirectory - Output Directory for site.
53
- * @param {SiteAdapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
53
+ * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
54
54
  * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
55
55
  * @param {string} params.fallbackFile - Fallback file for single page application sites.
56
56
  * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the site.
@@ -68,8 +68,8 @@ export declare class Sites {
68
68
  create(params: {
69
69
  siteId: string;
70
70
  name: string;
71
- framework: SiteFramework;
72
- buildRuntime: SiteBuildRuntime;
71
+ framework: Framework;
72
+ buildRuntime: BuildRuntime;
73
73
  enabled?: boolean;
74
74
  logging?: boolean;
75
75
  timeout?: number;
@@ -77,7 +77,7 @@ export declare class Sites {
77
77
  buildCommand?: string;
78
78
  startCommand?: string;
79
79
  outputDirectory?: string;
80
- adapter?: SiteAdapter;
80
+ adapter?: Adapter;
81
81
  installationId?: string;
82
82
  fallbackFile?: string;
83
83
  providerRepositoryId?: string;
@@ -95,8 +95,8 @@ export declare class Sites {
95
95
  *
96
96
  * @param {string} siteId - Site 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.
97
97
  * @param {string} name - Site name. Max length: 128 chars.
98
- * @param {SiteFramework} framework - Sites framework.
99
- * @param {SiteBuildRuntime} buildRuntime - Runtime to use during build step.
98
+ * @param {Framework} framework - Sites framework.
99
+ * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
100
100
  * @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
101
101
  * @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
102
102
  * @param {number} timeout - Maximum request time in seconds.
@@ -104,7 +104,7 @@ export declare class Sites {
104
104
  * @param {string} buildCommand - Build Command.
105
105
  * @param {string} startCommand - Custom start command. Leave empty to use default.
106
106
  * @param {string} outputDirectory - Output Directory for site.
107
- * @param {SiteAdapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
107
+ * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
108
108
  * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
109
109
  * @param {string} fallbackFile - Fallback file for single page application sites.
110
110
  * @param {string} providerRepositoryId - Repository ID of the repo linked to the site.
@@ -120,7 +120,7 @@ export declare class Sites {
120
120
  * @returns {Promise<Models.Site>}
121
121
  * @deprecated Use the object parameter style method for a better developer experience.
122
122
  */
123
- create(siteId: string, name: string, framework: SiteFramework, buildRuntime: SiteBuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: SiteAdapter, 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>;
123
+ 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>;
124
124
  /**
125
125
  * Get a list of all frameworks that are currently available on the server instance.
126
126
  *
@@ -138,7 +138,7 @@ export declare class Sites {
138
138
  /**
139
139
  * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
140
140
  *
141
- * @param {SiteFramework[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
141
+ * @param {Framework[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
142
142
  * @param {SiteTemplateUseCase[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
143
143
  * @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
144
144
  * @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
@@ -146,7 +146,7 @@ export declare class Sites {
146
146
  * @returns {Promise<Models.TemplateSiteList>}
147
147
  */
148
148
  listTemplates(params?: {
149
- frameworks?: SiteFramework[];
149
+ frameworks?: Framework[];
150
150
  useCases?: SiteTemplateUseCase[];
151
151
  limit?: number;
152
152
  offset?: number;
@@ -154,7 +154,7 @@ export declare class Sites {
154
154
  /**
155
155
  * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
156
156
  *
157
- * @param {SiteFramework[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
157
+ * @param {Framework[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
158
158
  * @param {SiteTemplateUseCase[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
159
159
  * @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
160
160
  * @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
@@ -162,7 +162,7 @@ export declare class Sites {
162
162
  * @returns {Promise<Models.TemplateSiteList>}
163
163
  * @deprecated Use the object parameter style method for a better developer experience.
164
164
  */
165
- listTemplates(frameworks?: SiteFramework[], useCases?: SiteTemplateUseCase[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
165
+ listTemplates(frameworks?: Framework[], useCases?: SiteTemplateUseCase[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
166
166
  /**
167
167
  * Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
168
168
  *
@@ -225,7 +225,7 @@ export declare class Sites {
225
225
  *
226
226
  * @param {string} params.siteId - Site ID.
227
227
  * @param {string} params.name - Site name. Max length: 128 chars.
228
- * @param {SiteFramework} params.framework - Sites framework.
228
+ * @param {Framework} params.framework - Sites framework.
229
229
  * @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
230
230
  * @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
231
231
  * @param {number} params.timeout - Maximum request time in seconds.
@@ -233,8 +233,8 @@ export declare class Sites {
233
233
  * @param {string} params.buildCommand - Build Command.
234
234
  * @param {string} params.startCommand - Custom start command. Leave empty to use default.
235
235
  * @param {string} params.outputDirectory - Output Directory for site.
236
- * @param {SiteBuildRuntime} params.buildRuntime - Runtime to use during build step.
237
- * @param {SiteAdapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
236
+ * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
237
+ * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
238
238
  * @param {string} params.fallbackFile - Fallback file for single page application sites.
239
239
  * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
240
240
  * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the site.
@@ -252,7 +252,7 @@ export declare class Sites {
252
252
  update(params: {
253
253
  siteId: string;
254
254
  name: string;
255
- framework: SiteFramework;
255
+ framework: Framework;
256
256
  enabled?: boolean;
257
257
  logging?: boolean;
258
258
  timeout?: number;
@@ -260,8 +260,8 @@ export declare class Sites {
260
260
  buildCommand?: string;
261
261
  startCommand?: string;
262
262
  outputDirectory?: string;
263
- buildRuntime?: SiteBuildRuntime;
264
- adapter?: SiteAdapter;
263
+ buildRuntime?: BuildRuntime;
264
+ adapter?: Adapter;
265
265
  fallbackFile?: string;
266
266
  installationId?: string;
267
267
  providerRepositoryId?: string;
@@ -279,7 +279,7 @@ export declare class Sites {
279
279
  *
280
280
  * @param {string} siteId - Site ID.
281
281
  * @param {string} name - Site name. Max length: 128 chars.
282
- * @param {SiteFramework} framework - Sites framework.
282
+ * @param {Framework} framework - Sites framework.
283
283
  * @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
284
284
  * @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
285
285
  * @param {number} timeout - Maximum request time in seconds.
@@ -287,8 +287,8 @@ export declare class Sites {
287
287
  * @param {string} buildCommand - Build Command.
288
288
  * @param {string} startCommand - Custom start command. Leave empty to use default.
289
289
  * @param {string} outputDirectory - Output Directory for site.
290
- * @param {SiteBuildRuntime} buildRuntime - Runtime to use during build step.
291
- * @param {SiteAdapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
290
+ * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
291
+ * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
292
292
  * @param {string} fallbackFile - Fallback file for single page application sites.
293
293
  * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
294
294
  * @param {string} providerRepositoryId - Repository ID of the repo linked to the site.
@@ -304,7 +304,7 @@ export declare class Sites {
304
304
  * @returns {Promise<Models.Site>}
305
305
  * @deprecated Use the object parameter style method for a better developer experience.
306
306
  */
307
- update(siteId: string, name: string, framework: SiteFramework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: SiteBuildRuntime, adapter?: SiteAdapter, 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>;
307
+ 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>;
308
308
  /**
309
309
  * Delete a site by its unique ID.
310
310
  *