@appwrite.io/console 13.0.0 → 13.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +5443 -1380
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +5438 -1381
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +5451 -1388
- package/package.json +1 -1
- package/types/channel.d.ts +8 -3
- package/types/client.d.ts +1 -1
- package/types/enums/account-key-scopes.d.ts +5 -0
- package/types/enums/addon.d.ts +2 -1
- package/types/enums/appwrite-migration-resource.d.ts +14 -1
- package/types/enums/backup-services.d.ts +1 -0
- package/types/enums/{resource-type.d.ts → block-resource-type.d.ts} +2 -6
- package/types/enums/{theme.d.ts → browser-theme.d.ts} +1 -1
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/cache-database.d.ts +5 -0
- package/types/enums/cache-target.d.ts +8 -0
- package/types/enums/{registration-type.d.ts → domain-registration-type.d.ts} +1 -1
- package/types/enums/{filter-type.d.ts → domain-suggestion-type.d.ts} +1 -1
- package/types/enums/embedding-model.d.ts +6 -0
- package/types/enums/function-template-use-case.d.ts +9 -0
- package/types/enums/{name.d.ts → health-queue-name.d.ts} +1 -1
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/organization-key-scopes.d.ts +12 -0
- package/types/enums/{auth-method.d.ts → project-auth-method-id.d.ts} +1 -1
- package/types/enums/{email-template-type.d.ts → project-email-template-id.d.ts} +1 -1
- package/types/enums/{email-template-locale.d.ts → project-email-template-locale.d.ts} +1 -1
- package/types/enums/{scopes.d.ts → project-key-scopes.d.ts} +12 -8
- package/types/enums/{prompt.d.ts → project-o-auth-2-google-prompt.d.ts} +1 -1
- package/types/enums/project-o-auth-provider-id.d.ts +45 -0
- package/types/enums/{project-policy.d.ts → project-policy-id.d.ts} +6 -2
- package/types/enums/{protocol-id.d.ts → project-protocol-id.d.ts} +1 -1
- package/types/enums/{service-id.d.ts → project-service-id.d.ts} +3 -2
- package/types/enums/project-smtp-secure.d.ts +4 -0
- package/types/enums/query-suggestion-resource.d.ts +13 -1
- package/types/enums/runtime.d.ts +3 -1
- package/types/enums/schedule-resource-type.d.ts +6 -0
- package/types/enums/{use-cases.d.ts → site-template-use-case.d.ts} +3 -8
- package/types/enums/status-code.d.ts +4 -4
- package/types/index.d.ts +30 -19
- package/types/models.d.ts +2610 -1109
- package/types/services/account.d.ts +11 -11
- package/types/services/advisor.d.ts +123 -0
- package/types/services/apps.d.ts +266 -0
- package/types/services/avatars.d.ts +5 -5
- package/types/services/compute.d.ts +1171 -0
- package/types/services/console.d.ts +31 -0
- package/types/services/documents-db.d.ts +1 -4
- package/types/services/domains.d.ts +216 -216
- package/types/services/functions.d.ts +29 -18
- package/types/services/health.d.ts +13 -5
- package/types/services/manager.d.ts +49 -9
- package/types/services/messaging.d.ts +92 -0
- package/types/services/organization.d.ts +234 -0
- package/types/services/organizations.d.ts +0 -126
- package/types/services/presences.d.ts +166 -0
- package/types/services/project.d.ts +167 -89
- package/types/services/projects.d.ts +5 -154
- package/types/services/realtime.d.ts +45 -3
- package/types/services/sites.d.ts +22 -11
- package/types/services/usage.d.ts +50 -0
- package/types/services/vectors-db.d.ts +6 -9
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/model.d.ts +0 -3
- package/types/enums/runtimes.d.ts +0 -91
- package/types/enums/secure.d.ts +0 -4
|
@@ -1,19 +1,26 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
3
|
+
import { ProjectAuthMethodId } from '../enums/project-auth-method-id';
|
|
4
|
+
import { ProjectKeyScopes } from '../enums/project-key-scopes';
|
|
5
|
+
import { ProjectOAuth2GooglePrompt } from '../enums/project-o-auth-2-google-prompt';
|
|
6
|
+
import { ProjectOAuthProviderId } from '../enums/project-o-auth-provider-id';
|
|
7
|
+
import { ProjectPolicyId } from '../enums/project-policy-id';
|
|
8
|
+
import { ProjectProtocolId } from '../enums/project-protocol-id';
|
|
9
|
+
import { ProjectServiceId } from '../enums/project-service-id';
|
|
10
|
+
import { ProjectSMTPSecure } from '../enums/project-smtp-secure';
|
|
11
|
+
import { ProjectEmailTemplateId } from '../enums/project-email-template-id';
|
|
12
|
+
import { ProjectEmailTemplateLocale } from '../enums/project-email-template-locale';
|
|
13
13
|
import { ProjectUsageRange } from '../enums/project-usage-range';
|
|
14
14
|
export declare class Project {
|
|
15
15
|
client: Client;
|
|
16
16
|
constructor(client: Client);
|
|
17
|
+
/**
|
|
18
|
+
* Get a project.
|
|
19
|
+
*
|
|
20
|
+
* @throws {AppwriteException}
|
|
21
|
+
* @returns {Promise<Models.Project>}
|
|
22
|
+
*/
|
|
23
|
+
get(): Promise<Models.Project>;
|
|
17
24
|
/**
|
|
18
25
|
* Delete a project.
|
|
19
26
|
*
|
|
@@ -24,25 +31,25 @@ export declare class Project {
|
|
|
24
31
|
/**
|
|
25
32
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
26
33
|
*
|
|
27
|
-
* @param {
|
|
34
|
+
* @param {ProjectAuthMethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
28
35
|
* @param {boolean} params.enabled - Auth method status.
|
|
29
36
|
* @throws {AppwriteException}
|
|
30
37
|
* @returns {Promise<Models.Project>}
|
|
31
38
|
*/
|
|
32
39
|
updateAuthMethod(params: {
|
|
33
|
-
methodId:
|
|
40
|
+
methodId: ProjectAuthMethodId;
|
|
34
41
|
enabled: boolean;
|
|
35
42
|
}): Promise<Models.Project>;
|
|
36
43
|
/**
|
|
37
44
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
38
45
|
*
|
|
39
|
-
* @param {
|
|
46
|
+
* @param {ProjectAuthMethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
40
47
|
* @param {boolean} enabled - Auth method status.
|
|
41
48
|
* @throws {AppwriteException}
|
|
42
49
|
* @returns {Promise<Models.Project>}
|
|
43
50
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
44
51
|
*/
|
|
45
|
-
updateAuthMethod(methodId:
|
|
52
|
+
updateAuthMethod(methodId: ProjectAuthMethodId, enabled: boolean): Promise<Models.Project>;
|
|
46
53
|
/**
|
|
47
54
|
* Get a list of all API keys from the current project.
|
|
48
55
|
*
|
|
@@ -72,7 +79,7 @@ export declare class Project {
|
|
|
72
79
|
*
|
|
73
80
|
* @param {string} params.keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
74
81
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
75
|
-
* @param {
|
|
82
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
76
83
|
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
77
84
|
* @throws {AppwriteException}
|
|
78
85
|
* @returns {Promise<Models.Key>}
|
|
@@ -80,7 +87,7 @@ export declare class Project {
|
|
|
80
87
|
createKey(params: {
|
|
81
88
|
keyId: string;
|
|
82
89
|
name: string;
|
|
83
|
-
scopes:
|
|
90
|
+
scopes: ProjectKeyScopes[];
|
|
84
91
|
expire?: string;
|
|
85
92
|
}): Promise<Models.Key>;
|
|
86
93
|
/**
|
|
@@ -90,25 +97,25 @@ export declare class Project {
|
|
|
90
97
|
*
|
|
91
98
|
* @param {string} keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
92
99
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
93
|
-
* @param {
|
|
100
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
94
101
|
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
95
102
|
* @throws {AppwriteException}
|
|
96
103
|
* @returns {Promise<Models.Key>}
|
|
97
104
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
98
105
|
*/
|
|
99
|
-
createKey(keyId: string, name: string, scopes:
|
|
106
|
+
createKey(keyId: string, name: string, scopes: ProjectKeyScopes[], expire?: string): Promise<Models.Key>;
|
|
100
107
|
/**
|
|
101
108
|
* Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
102
109
|
*
|
|
103
110
|
* You can also create a standard API key if you need a longer-lived key instead.
|
|
104
111
|
*
|
|
105
|
-
* @param {
|
|
112
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
106
113
|
* @param {number} params.duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
107
114
|
* @throws {AppwriteException}
|
|
108
115
|
* @returns {Promise<Models.EphemeralKey>}
|
|
109
116
|
*/
|
|
110
117
|
createEphemeralKey(params: {
|
|
111
|
-
scopes:
|
|
118
|
+
scopes: ProjectKeyScopes[];
|
|
112
119
|
duration: number;
|
|
113
120
|
}): Promise<Models.EphemeralKey>;
|
|
114
121
|
/**
|
|
@@ -116,13 +123,13 @@ export declare class Project {
|
|
|
116
123
|
*
|
|
117
124
|
* You can also create a standard API key if you need a longer-lived key instead.
|
|
118
125
|
*
|
|
119
|
-
* @param {
|
|
126
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
120
127
|
* @param {number} duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
121
128
|
* @throws {AppwriteException}
|
|
122
129
|
* @returns {Promise<Models.EphemeralKey>}
|
|
123
130
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
131
|
*/
|
|
125
|
-
createEphemeralKey(scopes:
|
|
132
|
+
createEphemeralKey(scopes: ProjectKeyScopes[], duration: number): Promise<Models.EphemeralKey>;
|
|
126
133
|
/**
|
|
127
134
|
* Get a key by its unique ID.
|
|
128
135
|
*
|
|
@@ -147,7 +154,7 @@ export declare class Project {
|
|
|
147
154
|
*
|
|
148
155
|
* @param {string} params.keyId - Key ID.
|
|
149
156
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
150
|
-
* @param {
|
|
157
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
151
158
|
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
152
159
|
* @throws {AppwriteException}
|
|
153
160
|
* @returns {Promise<Models.Key>}
|
|
@@ -155,7 +162,7 @@ export declare class Project {
|
|
|
155
162
|
updateKey(params: {
|
|
156
163
|
keyId: string;
|
|
157
164
|
name: string;
|
|
158
|
-
scopes:
|
|
165
|
+
scopes: ProjectKeyScopes[];
|
|
159
166
|
expire?: string;
|
|
160
167
|
}): Promise<Models.Key>;
|
|
161
168
|
/**
|
|
@@ -163,13 +170,13 @@ export declare class Project {
|
|
|
163
170
|
*
|
|
164
171
|
* @param {string} keyId - Key ID.
|
|
165
172
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
166
|
-
* @param {
|
|
173
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
167
174
|
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
168
175
|
* @throws {AppwriteException}
|
|
169
176
|
* @returns {Promise<Models.Key>}
|
|
170
177
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
171
178
|
*/
|
|
172
|
-
updateKey(keyId: string, name: string, scopes:
|
|
179
|
+
updateKey(keyId: string, name: string, scopes: ProjectKeyScopes[], expire?: string): Promise<Models.Key>;
|
|
173
180
|
/**
|
|
174
181
|
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
175
182
|
*
|
|
@@ -334,6 +341,46 @@ export declare class Project {
|
|
|
334
341
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
335
342
|
*/
|
|
336
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 {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.
|
|
351
|
+
* @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.
|
|
352
|
+
* @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.
|
|
353
|
+
* @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.
|
|
354
|
+
* @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.
|
|
355
|
+
* @throws {AppwriteException}
|
|
356
|
+
* @returns {Promise<Models.Project>}
|
|
357
|
+
*/
|
|
358
|
+
updateOAuth2Server(params: {
|
|
359
|
+
enabled: boolean;
|
|
360
|
+
authorizationUrl: string;
|
|
361
|
+
scopes?: string[];
|
|
362
|
+
accessTokenDuration?: number;
|
|
363
|
+
refreshTokenDuration?: number;
|
|
364
|
+
publicAccessTokenDuration?: number;
|
|
365
|
+
publicRefreshTokenDuration?: number;
|
|
366
|
+
confidentialPkce?: boolean;
|
|
367
|
+
}): Promise<Models.Project>;
|
|
368
|
+
/**
|
|
369
|
+
* Update the OAuth2 server (OIDC provider) configuration.
|
|
370
|
+
*
|
|
371
|
+
* @param {boolean} enabled - Enable or disable the OAuth2 server.
|
|
372
|
+
* @param {string} authorizationUrl - URL to your application with consent screen.
|
|
373
|
+
* @param {string[]} scopes - List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.
|
|
374
|
+
* @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.
|
|
375
|
+
* @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.
|
|
376
|
+
* @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.
|
|
377
|
+
* @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.
|
|
378
|
+
* @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.
|
|
379
|
+
* @throws {AppwriteException}
|
|
380
|
+
* @returns {Promise<Models.Project>}
|
|
381
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
382
|
+
*/
|
|
383
|
+
updateOAuth2Server(enabled: boolean, authorizationUrl: string, scopes?: string[], accessTokenDuration?: number, refreshTokenDuration?: number, publicAccessTokenDuration?: number, publicRefreshTokenDuration?: number, confidentialPkce?: boolean): Promise<Models.Project>;
|
|
337
384
|
/**
|
|
338
385
|
* Update the project OAuth2 Amazon configuration.
|
|
339
386
|
*
|
|
@@ -807,7 +854,7 @@ export declare class Project {
|
|
|
807
854
|
*
|
|
808
855
|
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
809
856
|
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
810
|
-
* @param {
|
|
857
|
+
* @param {ProjectOAuth2GooglePrompt[]} params.prompt - Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
811
858
|
* @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.
|
|
812
859
|
* @throws {AppwriteException}
|
|
813
860
|
* @returns {Promise<Models.OAuth2Google>}
|
|
@@ -815,7 +862,7 @@ export declare class Project {
|
|
|
815
862
|
updateOAuth2Google(params?: {
|
|
816
863
|
clientId?: string;
|
|
817
864
|
clientSecret?: string;
|
|
818
|
-
prompt?:
|
|
865
|
+
prompt?: ProjectOAuth2GooglePrompt[];
|
|
819
866
|
enabled?: boolean;
|
|
820
867
|
}): Promise<Models.OAuth2Google>;
|
|
821
868
|
/**
|
|
@@ -823,13 +870,13 @@ export declare class Project {
|
|
|
823
870
|
*
|
|
824
871
|
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
825
872
|
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
826
|
-
* @param {
|
|
873
|
+
* @param {ProjectOAuth2GooglePrompt[]} prompt - Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
827
874
|
* @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.
|
|
828
875
|
* @throws {AppwriteException}
|
|
829
876
|
* @returns {Promise<Models.OAuth2Google>}
|
|
830
877
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
831
878
|
*/
|
|
832
|
-
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?:
|
|
879
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GooglePrompt[], enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
833
880
|
/**
|
|
834
881
|
* Update the project OAuth2 Keycloak configuration.
|
|
835
882
|
*
|
|
@@ -1435,22 +1482,22 @@ export declare class Project {
|
|
|
1435
1482
|
/**
|
|
1436
1483
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1437
1484
|
*
|
|
1438
|
-
* @param {
|
|
1485
|
+
* @param {ProjectOAuthProviderId} params.providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1439
1486
|
* @throws {AppwriteException}
|
|
1440
1487
|
* @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>}
|
|
1441
1488
|
*/
|
|
1442
1489
|
getOAuth2Provider(params: {
|
|
1443
|
-
providerId:
|
|
1490
|
+
providerId: ProjectOAuthProviderId;
|
|
1444
1491
|
}): 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>;
|
|
1445
1492
|
/**
|
|
1446
1493
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1447
1494
|
*
|
|
1448
|
-
* @param {
|
|
1495
|
+
* @param {ProjectOAuthProviderId} providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1449
1496
|
* @throws {AppwriteException}
|
|
1450
1497
|
* @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>}
|
|
1451
1498
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1452
1499
|
*/
|
|
1453
|
-
getOAuth2Provider(providerId:
|
|
1500
|
+
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>;
|
|
1454
1501
|
/**
|
|
1455
1502
|
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
1456
1503
|
*
|
|
@@ -1784,24 +1831,24 @@ export declare class Project {
|
|
|
1784
1831
|
*/
|
|
1785
1832
|
listPolicies(queries?: string[], total?: boolean): Promise<Models.PolicyList>;
|
|
1786
1833
|
/**
|
|
1787
|
-
* Configures if
|
|
1834
|
+
* Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.
|
|
1788
1835
|
*
|
|
1789
|
-
* @param {boolean} params.enabled - Set whether or not to block
|
|
1836
|
+
* @param {boolean} params.enabled - Set whether or not to block aliased emails during signup and email updates.
|
|
1790
1837
|
* @throws {AppwriteException}
|
|
1791
1838
|
* @returns {Promise<Models.Project>}
|
|
1792
1839
|
*/
|
|
1793
|
-
|
|
1840
|
+
updateDenyAliasedEmailPolicy(params: {
|
|
1794
1841
|
enabled: boolean;
|
|
1795
1842
|
}): Promise<Models.Project>;
|
|
1796
1843
|
/**
|
|
1797
|
-
* Configures if
|
|
1844
|
+
* Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.
|
|
1798
1845
|
*
|
|
1799
|
-
* @param {boolean} enabled - Set whether or not to block
|
|
1846
|
+
* @param {boolean} enabled - Set whether or not to block aliased emails during signup and email updates.
|
|
1800
1847
|
* @throws {AppwriteException}
|
|
1801
1848
|
* @returns {Promise<Models.Project>}
|
|
1802
1849
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1803
1850
|
*/
|
|
1804
|
-
|
|
1851
|
+
updateDenyAliasedEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1805
1852
|
/**
|
|
1806
1853
|
* Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.
|
|
1807
1854
|
*
|
|
@@ -1932,6 +1979,37 @@ export declare class Project {
|
|
|
1932
1979
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1933
1980
|
*/
|
|
1934
1981
|
updatePasswordPersonalDataPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1982
|
+
/**
|
|
1983
|
+
* Update the password strength requirements for users in the project.
|
|
1984
|
+
*
|
|
1985
|
+
* @param {number} params.min - Minimum password length. Value must be between 8 and 256. Default is 8.
|
|
1986
|
+
* @param {boolean} params.uppercase - Whether passwords must include at least one uppercase letter.
|
|
1987
|
+
* @param {boolean} params.lowercase - Whether passwords must include at least one lowercase letter.
|
|
1988
|
+
* @param {boolean} params.number - Whether passwords must include at least one number.
|
|
1989
|
+
* @param {boolean} params.symbols - Whether passwords must include at least one symbol.
|
|
1990
|
+
* @throws {AppwriteException}
|
|
1991
|
+
* @returns {Promise<Models.PolicyPasswordStrength>}
|
|
1992
|
+
*/
|
|
1993
|
+
updatePasswordStrengthPolicy(params?: {
|
|
1994
|
+
min?: number;
|
|
1995
|
+
uppercase?: boolean;
|
|
1996
|
+
lowercase?: boolean;
|
|
1997
|
+
number?: boolean;
|
|
1998
|
+
symbols?: boolean;
|
|
1999
|
+
}): Promise<Models.PolicyPasswordStrength>;
|
|
2000
|
+
/**
|
|
2001
|
+
* Update the password strength requirements for users in the project.
|
|
2002
|
+
*
|
|
2003
|
+
* @param {number} min - Minimum password length. Value must be between 8 and 256. Default is 8.
|
|
2004
|
+
* @param {boolean} uppercase - Whether passwords must include at least one uppercase letter.
|
|
2005
|
+
* @param {boolean} lowercase - Whether passwords must include at least one lowercase letter.
|
|
2006
|
+
* @param {boolean} number - Whether passwords must include at least one number.
|
|
2007
|
+
* @param {boolean} symbols - Whether passwords must include at least one symbol.
|
|
2008
|
+
* @throws {AppwriteException}
|
|
2009
|
+
* @returns {Promise<Models.PolicyPasswordStrength>}
|
|
2010
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2011
|
+
*/
|
|
2012
|
+
updatePasswordStrengthPolicy(min?: number, uppercase?: boolean, lowercase?: boolean, number?: boolean, symbols?: boolean): Promise<Models.PolicyPasswordStrength>;
|
|
1935
2013
|
/**
|
|
1936
2014
|
* 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.
|
|
1937
2015
|
*
|
|
@@ -2030,78 +2108,78 @@ export declare class Project {
|
|
|
2030
2108
|
/**
|
|
2031
2109
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2032
2110
|
*
|
|
2033
|
-
* @param {
|
|
2111
|
+
* @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.
|
|
2034
2112
|
* @throws {AppwriteException}
|
|
2035
|
-
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2113
|
+
* @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>}
|
|
2036
2114
|
*/
|
|
2037
2115
|
getPolicy(params: {
|
|
2038
|
-
policyId:
|
|
2039
|
-
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2116
|
+
policyId: ProjectPolicyId;
|
|
2117
|
+
}): 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>;
|
|
2040
2118
|
/**
|
|
2041
2119
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2042
2120
|
*
|
|
2043
|
-
* @param {
|
|
2121
|
+
* @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.
|
|
2044
2122
|
* @throws {AppwriteException}
|
|
2045
|
-
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2123
|
+
* @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>}
|
|
2046
2124
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2047
2125
|
*/
|
|
2048
|
-
getPolicy(policyId:
|
|
2126
|
+
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>;
|
|
2049
2127
|
/**
|
|
2050
2128
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2051
2129
|
*
|
|
2052
|
-
* @param {
|
|
2130
|
+
* @param {ProjectProtocolId} params.protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
2053
2131
|
* @param {boolean} params.enabled - Protocol status.
|
|
2054
2132
|
* @throws {AppwriteException}
|
|
2055
2133
|
* @returns {Promise<Models.Project>}
|
|
2056
2134
|
*/
|
|
2057
2135
|
updateProtocol(params: {
|
|
2058
|
-
protocolId:
|
|
2136
|
+
protocolId: ProjectProtocolId;
|
|
2059
2137
|
enabled: boolean;
|
|
2060
2138
|
}): Promise<Models.Project>;
|
|
2061
2139
|
/**
|
|
2062
2140
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2063
2141
|
*
|
|
2064
|
-
* @param {
|
|
2142
|
+
* @param {ProjectProtocolId} protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
2065
2143
|
* @param {boolean} enabled - Protocol status.
|
|
2066
2144
|
* @throws {AppwriteException}
|
|
2067
2145
|
* @returns {Promise<Models.Project>}
|
|
2068
2146
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2069
2147
|
*/
|
|
2070
|
-
updateProtocol(protocolId:
|
|
2148
|
+
updateProtocol(protocolId: ProjectProtocolId, enabled: boolean): Promise<Models.Project>;
|
|
2071
2149
|
/**
|
|
2072
2150
|
* Update properties of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
2073
2151
|
*
|
|
2074
|
-
* @param {
|
|
2152
|
+
* @param {ProjectServiceId} params.serviceId - Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor
|
|
2075
2153
|
* @param {boolean} params.enabled - Service status.
|
|
2076
2154
|
* @throws {AppwriteException}
|
|
2077
2155
|
* @returns {Promise<Models.Project>}
|
|
2078
2156
|
*/
|
|
2079
2157
|
updateService(params: {
|
|
2080
|
-
serviceId:
|
|
2158
|
+
serviceId: ProjectServiceId;
|
|
2081
2159
|
enabled: boolean;
|
|
2082
2160
|
}): Promise<Models.Project>;
|
|
2083
2161
|
/**
|
|
2084
2162
|
* Update properties of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
2085
2163
|
*
|
|
2086
|
-
* @param {
|
|
2164
|
+
* @param {ProjectServiceId} serviceId - Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor
|
|
2087
2165
|
* @param {boolean} enabled - Service status.
|
|
2088
2166
|
* @throws {AppwriteException}
|
|
2089
2167
|
* @returns {Promise<Models.Project>}
|
|
2090
2168
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2091
2169
|
*/
|
|
2092
|
-
updateService(serviceId:
|
|
2170
|
+
updateService(serviceId: ProjectServiceId, enabled: boolean): Promise<Models.Project>;
|
|
2093
2171
|
/**
|
|
2094
2172
|
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
2095
2173
|
*
|
|
2096
2174
|
* @param {string} params.host - SMTP server hostname (domain)
|
|
2097
2175
|
* @param {number} params.port - SMTP server port
|
|
2098
|
-
* @param {string} params.username - SMTP server username.
|
|
2099
|
-
* @param {string} params.password - SMTP server password.
|
|
2100
|
-
* @param {string} params.senderEmail - Email address shown in inbox as the sender of the email.
|
|
2101
|
-
* @param {string} params.senderName - Name shown in inbox as the sender of the email.
|
|
2102
|
-
* @param {string} params.replyToEmail - Email used when user replies to the email.
|
|
2103
|
-
* @param {string} params.replyToName - Name used when user replies to the email.
|
|
2104
|
-
* @param {
|
|
2176
|
+
* @param {string} params.username - SMTP server username. Pass an empty string to clear a previously set value.
|
|
2177
|
+
* @param {string} params.password - SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).
|
|
2178
|
+
* @param {string} params.senderEmail - Email address shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2179
|
+
* @param {string} params.senderName - Name shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2180
|
+
* @param {string} params.replyToEmail - Email used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2181
|
+
* @param {string} params.replyToName - Name used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2182
|
+
* @param {ProjectSMTPSecure} params.secure - Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.
|
|
2105
2183
|
* @param {boolean} params.enabled - Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
2106
2184
|
* @throws {AppwriteException}
|
|
2107
2185
|
* @returns {Promise<Models.Project>}
|
|
@@ -2115,7 +2193,7 @@ export declare class Project {
|
|
|
2115
2193
|
senderName?: string;
|
|
2116
2194
|
replyToEmail?: string;
|
|
2117
2195
|
replyToName?: string;
|
|
2118
|
-
secure?:
|
|
2196
|
+
secure?: ProjectSMTPSecure;
|
|
2119
2197
|
enabled?: boolean;
|
|
2120
2198
|
}): Promise<Models.Project>;
|
|
2121
2199
|
/**
|
|
@@ -2123,19 +2201,19 @@ export declare class Project {
|
|
|
2123
2201
|
*
|
|
2124
2202
|
* @param {string} host - SMTP server hostname (domain)
|
|
2125
2203
|
* @param {number} port - SMTP server port
|
|
2126
|
-
* @param {string} username - SMTP server username.
|
|
2127
|
-
* @param {string} password - SMTP server password.
|
|
2128
|
-
* @param {string} senderEmail - Email address shown in inbox as the sender of the email.
|
|
2129
|
-
* @param {string} senderName - Name shown in inbox as the sender of the email.
|
|
2130
|
-
* @param {string} replyToEmail - Email used when user replies to the email.
|
|
2131
|
-
* @param {string} replyToName - Name used when user replies to the email.
|
|
2132
|
-
* @param {
|
|
2204
|
+
* @param {string} username - SMTP server username. Pass an empty string to clear a previously set value.
|
|
2205
|
+
* @param {string} password - SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).
|
|
2206
|
+
* @param {string} senderEmail - Email address shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2207
|
+
* @param {string} senderName - Name shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2208
|
+
* @param {string} replyToEmail - Email used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2209
|
+
* @param {string} replyToName - Name used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2210
|
+
* @param {ProjectSMTPSecure} secure - Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.
|
|
2133
2211
|
* @param {boolean} enabled - Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
2134
2212
|
* @throws {AppwriteException}
|
|
2135
2213
|
* @returns {Promise<Models.Project>}
|
|
2136
2214
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2137
2215
|
*/
|
|
2138
|
-
updateSMTP(host?: string, port?: number, username?: string, password?: string, senderEmail?: string, senderName?: string, replyToEmail?: string, replyToName?: string, secure?:
|
|
2216
|
+
updateSMTP(host?: string, port?: number, username?: string, password?: string, senderEmail?: string, senderName?: string, replyToEmail?: string, replyToName?: string, secure?: ProjectSMTPSecure, enabled?: boolean): Promise<Models.Project>;
|
|
2139
2217
|
/**
|
|
2140
2218
|
* Send a test email to verify SMTP configuration.
|
|
2141
2219
|
*
|
|
@@ -2180,20 +2258,20 @@ export declare class Project {
|
|
|
2180
2258
|
/**
|
|
2181
2259
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2182
2260
|
*
|
|
2183
|
-
* @param {
|
|
2184
|
-
* @param {
|
|
2261
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2262
|
+
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2185
2263
|
* @param {string} params.subject - Subject of the email template. Can be up to 255 characters.
|
|
2186
2264
|
* @param {string} params.message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
2187
2265
|
* @param {string} params.senderName - Name of the email sender.
|
|
2188
|
-
* @param {string} params.senderEmail - Email of the sender.
|
|
2189
|
-
* @param {string} params.replyToEmail - Reply to email.
|
|
2266
|
+
* @param {string} params.senderEmail - Email of the sender. Pass an empty string to clear a previously set value.
|
|
2267
|
+
* @param {string} params.replyToEmail - Reply to email. Pass an empty string to clear a previously set value.
|
|
2190
2268
|
* @param {string} params.replyToName - Reply to name.
|
|
2191
2269
|
* @throws {AppwriteException}
|
|
2192
2270
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2193
2271
|
*/
|
|
2194
2272
|
updateEmailTemplate(params: {
|
|
2195
|
-
templateId:
|
|
2196
|
-
locale?:
|
|
2273
|
+
templateId: ProjectEmailTemplateId;
|
|
2274
|
+
locale?: ProjectEmailTemplateLocale;
|
|
2197
2275
|
subject?: string;
|
|
2198
2276
|
message?: string;
|
|
2199
2277
|
senderName?: string;
|
|
@@ -2204,41 +2282,41 @@ export declare class Project {
|
|
|
2204
2282
|
/**
|
|
2205
2283
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2206
2284
|
*
|
|
2207
|
-
* @param {
|
|
2208
|
-
* @param {
|
|
2285
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2286
|
+
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2209
2287
|
* @param {string} subject - Subject of the email template. Can be up to 255 characters.
|
|
2210
2288
|
* @param {string} message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
2211
2289
|
* @param {string} senderName - Name of the email sender.
|
|
2212
|
-
* @param {string} senderEmail - Email of the sender.
|
|
2213
|
-
* @param {string} replyToEmail - Reply to email.
|
|
2290
|
+
* @param {string} senderEmail - Email of the sender. Pass an empty string to clear a previously set value.
|
|
2291
|
+
* @param {string} replyToEmail - Reply to email. Pass an empty string to clear a previously set value.
|
|
2214
2292
|
* @param {string} replyToName - Reply to name.
|
|
2215
2293
|
* @throws {AppwriteException}
|
|
2216
2294
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2217
2295
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2218
2296
|
*/
|
|
2219
|
-
updateEmailTemplate(templateId:
|
|
2297
|
+
updateEmailTemplate(templateId: ProjectEmailTemplateId, locale?: ProjectEmailTemplateLocale, subject?: string, message?: string, senderName?: string, senderEmail?: string, replyToEmail?: string, replyToName?: string): Promise<Models.EmailTemplate>;
|
|
2220
2298
|
/**
|
|
2221
2299
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2222
2300
|
*
|
|
2223
|
-
* @param {
|
|
2224
|
-
* @param {
|
|
2301
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2302
|
+
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2225
2303
|
* @throws {AppwriteException}
|
|
2226
2304
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2227
2305
|
*/
|
|
2228
2306
|
getEmailTemplate(params: {
|
|
2229
|
-
templateId:
|
|
2230
|
-
locale?:
|
|
2307
|
+
templateId: ProjectEmailTemplateId;
|
|
2308
|
+
locale?: ProjectEmailTemplateLocale;
|
|
2231
2309
|
}): Promise<Models.EmailTemplate>;
|
|
2232
2310
|
/**
|
|
2233
2311
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2234
2312
|
*
|
|
2235
|
-
* @param {
|
|
2236
|
-
* @param {
|
|
2313
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2314
|
+
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2237
2315
|
* @throws {AppwriteException}
|
|
2238
2316
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2239
2317
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2240
2318
|
*/
|
|
2241
|
-
getEmailTemplate(templateId:
|
|
2319
|
+
getEmailTemplate(templateId: ProjectEmailTemplateId, locale?: ProjectEmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
2242
2320
|
/**
|
|
2243
2321
|
* Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
|
|
2244
2322
|
*
|