@appwrite.io/console 12.2.0 → 13.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.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +1719 -1204
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1717 -1205
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1736 -1221
- 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/appwrite-migration-resource.d.ts +1 -0
- 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/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/{model.d.ts → embedding-model.d.ts} +1 -1
- package/types/enums/{runtime.d.ts → function-runtime.d.ts} +4 -2
- 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/{on-duplicate.d.ts → migration-on-duplicate.d.ts} +1 -1
- package/types/enums/o-auth-2-google-prompt.d.ts +5 -0
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/organization-addon.d.ts +4 -0
- 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} +10 -8
- package/types/enums/project-o-auth-2-google-prompt.d.ts +5 -0
- package/types/enums/project-o-auth-provider-id.d.ts +45 -0
- package/types/enums/{project-policy.d.ts → project-policy-id.d.ts} +1 -1
- 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/project-status.d.ts +3 -0
- package/types/enums/query-suggestion-resource.d.ts +10 -1
- package/types/enums/redirect-status-code.d.ts +6 -0
- package/types/enums/schedule-resource-type.d.ts +6 -0
- package/types/enums/{adapter.d.ts → site-adapter.d.ts} +1 -1
- package/types/enums/{runtimes.d.ts → site-build-runtime.d.ts} +4 -2
- package/types/enums/{framework.d.ts → site-framework.d.ts} +1 -1
- package/types/enums/{use-cases.d.ts → site-template-use-case.d.ts} +3 -8
- package/types/index.d.ts +36 -26
- package/types/models.d.ts +1186 -1185
- package/types/services/account.d.ts +9 -9
- package/types/services/avatars.d.ts +5 -5
- 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 +36 -25
- package/types/services/health.d.ts +5 -5
- package/types/services/manager.d.ts +49 -9
- package/types/services/migrations.d.ts +13 -13
- package/types/services/organization.d.ts +234 -0
- package/types/services/organizations.d.ts +5 -131
- package/types/services/presences.d.ts +166 -0
- package/types/services/project.d.ts +226 -215
- package/types/services/projects.d.ts +10 -159
- package/types/services/proxy.d.ts +5 -5
- package/types/services/realtime.d.ts +45 -3
- package/types/services/sites.d.ts +43 -32
- package/types/services/usage.d.ts +50 -0
- package/types/services/vectors-db.d.ts +6 -9
- package/types/enums/addon.d.ts +0 -3
- package/types/enums/build-runtime.d.ts +0 -91
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/secure.d.ts +0 -4
- package/types/enums/status-code.d.ts +0 -6
- package/types/enums/status.d.ts +0 -3
|
@@ -1,18 +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 {
|
|
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';
|
|
12
13
|
import { ProjectUsageRange } from '../enums/project-usage-range';
|
|
13
14
|
export declare class Project {
|
|
14
15
|
client: Client;
|
|
15
16
|
constructor(client: Client);
|
|
17
|
+
/**
|
|
18
|
+
* Get a project.
|
|
19
|
+
*
|
|
20
|
+
* @throws {AppwriteException}
|
|
21
|
+
* @returns {Promise<Models.Project>}
|
|
22
|
+
*/
|
|
23
|
+
get(): Promise<Models.Project>;
|
|
16
24
|
/**
|
|
17
25
|
* Delete a project.
|
|
18
26
|
*
|
|
@@ -23,82 +31,25 @@ export declare class Project {
|
|
|
23
31
|
/**
|
|
24
32
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
25
33
|
*
|
|
26
|
-
* @param {
|
|
34
|
+
* @param {ProjectAuthMethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
27
35
|
* @param {boolean} params.enabled - Auth method status.
|
|
28
36
|
* @throws {AppwriteException}
|
|
29
37
|
* @returns {Promise<Models.Project>}
|
|
30
38
|
*/
|
|
31
39
|
updateAuthMethod(params: {
|
|
32
|
-
methodId:
|
|
40
|
+
methodId: ProjectAuthMethodId;
|
|
33
41
|
enabled: boolean;
|
|
34
42
|
}): Promise<Models.Project>;
|
|
35
43
|
/**
|
|
36
44
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
37
45
|
*
|
|
38
|
-
* @param {
|
|
46
|
+
* @param {ProjectAuthMethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
39
47
|
* @param {boolean} enabled - Auth method status.
|
|
40
48
|
* @throws {AppwriteException}
|
|
41
49
|
* @returns {Promise<Models.Project>}
|
|
42
50
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
43
51
|
*/
|
|
44
|
-
updateAuthMethod(methodId:
|
|
45
|
-
/**
|
|
46
|
-
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
47
|
-
*
|
|
48
|
-
* @param {boolean} params.enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
49
|
-
* @throws {AppwriteException}
|
|
50
|
-
* @returns {Promise<Models.Project>}
|
|
51
|
-
*/
|
|
52
|
-
updateCanonicalEmails(params: {
|
|
53
|
-
enabled: boolean;
|
|
54
|
-
}): Promise<Models.Project>;
|
|
55
|
-
/**
|
|
56
|
-
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
57
|
-
*
|
|
58
|
-
* @param {boolean} enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
59
|
-
* @throws {AppwriteException}
|
|
60
|
-
* @returns {Promise<Models.Project>}
|
|
61
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
62
|
-
*/
|
|
63
|
-
updateCanonicalEmails(enabled: boolean): Promise<Models.Project>;
|
|
64
|
-
/**
|
|
65
|
-
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
66
|
-
*
|
|
67
|
-
* @param {boolean} params.enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
68
|
-
* @throws {AppwriteException}
|
|
69
|
-
* @returns {Promise<Models.Project>}
|
|
70
|
-
*/
|
|
71
|
-
updateDisposableEmails(params: {
|
|
72
|
-
enabled: boolean;
|
|
73
|
-
}): Promise<Models.Project>;
|
|
74
|
-
/**
|
|
75
|
-
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
76
|
-
*
|
|
77
|
-
* @param {boolean} enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
78
|
-
* @throws {AppwriteException}
|
|
79
|
-
* @returns {Promise<Models.Project>}
|
|
80
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
81
|
-
*/
|
|
82
|
-
updateDisposableEmails(enabled: boolean): Promise<Models.Project>;
|
|
83
|
-
/**
|
|
84
|
-
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
85
|
-
*
|
|
86
|
-
* @param {boolean} params.enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
87
|
-
* @throws {AppwriteException}
|
|
88
|
-
* @returns {Promise<Models.Project>}
|
|
89
|
-
*/
|
|
90
|
-
updateFreeEmails(params: {
|
|
91
|
-
enabled: boolean;
|
|
92
|
-
}): Promise<Models.Project>;
|
|
93
|
-
/**
|
|
94
|
-
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
95
|
-
*
|
|
96
|
-
* @param {boolean} enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
97
|
-
* @throws {AppwriteException}
|
|
98
|
-
* @returns {Promise<Models.Project>}
|
|
99
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
100
|
-
*/
|
|
101
|
-
updateFreeEmails(enabled: boolean): Promise<Models.Project>;
|
|
52
|
+
updateAuthMethod(methodId: ProjectAuthMethodId, enabled: boolean): Promise<Models.Project>;
|
|
102
53
|
/**
|
|
103
54
|
* Get a list of all API keys from the current project.
|
|
104
55
|
*
|
|
@@ -128,7 +79,7 @@ export declare class Project {
|
|
|
128
79
|
*
|
|
129
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.
|
|
130
81
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
131
|
-
* @param {
|
|
82
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
132
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.
|
|
133
84
|
* @throws {AppwriteException}
|
|
134
85
|
* @returns {Promise<Models.Key>}
|
|
@@ -136,7 +87,7 @@ export declare class Project {
|
|
|
136
87
|
createKey(params: {
|
|
137
88
|
keyId: string;
|
|
138
89
|
name: string;
|
|
139
|
-
scopes:
|
|
90
|
+
scopes: ProjectKeyScopes[];
|
|
140
91
|
expire?: string;
|
|
141
92
|
}): Promise<Models.Key>;
|
|
142
93
|
/**
|
|
@@ -146,25 +97,25 @@ export declare class Project {
|
|
|
146
97
|
*
|
|
147
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.
|
|
148
99
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
149
|
-
* @param {
|
|
100
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
150
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.
|
|
151
102
|
* @throws {AppwriteException}
|
|
152
103
|
* @returns {Promise<Models.Key>}
|
|
153
104
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
154
105
|
*/
|
|
155
|
-
createKey(keyId: string, name: string, scopes:
|
|
106
|
+
createKey(keyId: string, name: string, scopes: ProjectKeyScopes[], expire?: string): Promise<Models.Key>;
|
|
156
107
|
/**
|
|
157
108
|
* Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
158
109
|
*
|
|
159
110
|
* You can also create a standard API key if you need a longer-lived key instead.
|
|
160
111
|
*
|
|
161
|
-
* @param {
|
|
112
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
162
113
|
* @param {number} params.duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
163
114
|
* @throws {AppwriteException}
|
|
164
115
|
* @returns {Promise<Models.EphemeralKey>}
|
|
165
116
|
*/
|
|
166
117
|
createEphemeralKey(params: {
|
|
167
|
-
scopes:
|
|
118
|
+
scopes: ProjectKeyScopes[];
|
|
168
119
|
duration: number;
|
|
169
120
|
}): Promise<Models.EphemeralKey>;
|
|
170
121
|
/**
|
|
@@ -172,13 +123,13 @@ export declare class Project {
|
|
|
172
123
|
*
|
|
173
124
|
* You can also create a standard API key if you need a longer-lived key instead.
|
|
174
125
|
*
|
|
175
|
-
* @param {
|
|
126
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
176
127
|
* @param {number} duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
177
128
|
* @throws {AppwriteException}
|
|
178
129
|
* @returns {Promise<Models.EphemeralKey>}
|
|
179
130
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
180
131
|
*/
|
|
181
|
-
createEphemeralKey(scopes:
|
|
132
|
+
createEphemeralKey(scopes: ProjectKeyScopes[], duration: number): Promise<Models.EphemeralKey>;
|
|
182
133
|
/**
|
|
183
134
|
* Get a key by its unique ID.
|
|
184
135
|
*
|
|
@@ -203,7 +154,7 @@ export declare class Project {
|
|
|
203
154
|
*
|
|
204
155
|
* @param {string} params.keyId - Key ID.
|
|
205
156
|
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
206
|
-
* @param {
|
|
157
|
+
* @param {ProjectKeyScopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
207
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.
|
|
208
159
|
* @throws {AppwriteException}
|
|
209
160
|
* @returns {Promise<Models.Key>}
|
|
@@ -211,7 +162,7 @@ export declare class Project {
|
|
|
211
162
|
updateKey(params: {
|
|
212
163
|
keyId: string;
|
|
213
164
|
name: string;
|
|
214
|
-
scopes:
|
|
165
|
+
scopes: ProjectKeyScopes[];
|
|
215
166
|
expire?: string;
|
|
216
167
|
}): Promise<Models.Key>;
|
|
217
168
|
/**
|
|
@@ -219,13 +170,13 @@ export declare class Project {
|
|
|
219
170
|
*
|
|
220
171
|
* @param {string} keyId - Key ID.
|
|
221
172
|
* @param {string} name - Key name. Max length: 128 chars.
|
|
222
|
-
* @param {
|
|
173
|
+
* @param {ProjectKeyScopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
223
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.
|
|
224
175
|
* @throws {AppwriteException}
|
|
225
176
|
* @returns {Promise<Models.Key>}
|
|
226
177
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
227
178
|
*/
|
|
228
|
-
updateKey(keyId: string, name: string, scopes:
|
|
179
|
+
updateKey(keyId: string, name: string, scopes: ProjectKeyScopes[], expire?: string): Promise<Models.Key>;
|
|
229
180
|
/**
|
|
230
181
|
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
231
182
|
*
|
|
@@ -394,7 +345,7 @@ export declare class Project {
|
|
|
394
345
|
* Update the project OAuth2 Amazon configuration.
|
|
395
346
|
*
|
|
396
347
|
* @param {string} params.clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
397
|
-
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example:
|
|
348
|
+
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
398
349
|
* @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.
|
|
399
350
|
* @throws {AppwriteException}
|
|
400
351
|
* @returns {Promise<Models.OAuth2Amazon>}
|
|
@@ -408,7 +359,7 @@ export declare class Project {
|
|
|
408
359
|
* Update the project OAuth2 Amazon configuration.
|
|
409
360
|
*
|
|
410
361
|
* @param {string} clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
411
|
-
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example:
|
|
362
|
+
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
412
363
|
* @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.
|
|
413
364
|
* @throws {AppwriteException}
|
|
414
365
|
* @returns {Promise<Models.OAuth2Amazon>}
|
|
@@ -450,7 +401,7 @@ export declare class Project {
|
|
|
450
401
|
* Update the project OAuth2 Auth0 configuration.
|
|
451
402
|
*
|
|
452
403
|
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
453
|
-
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example:
|
|
404
|
+
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
454
405
|
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
455
406
|
* @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.
|
|
456
407
|
* @throws {AppwriteException}
|
|
@@ -466,7 +417,7 @@ export declare class Project {
|
|
|
466
417
|
* Update the project OAuth2 Auth0 configuration.
|
|
467
418
|
*
|
|
468
419
|
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
469
|
-
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example:
|
|
420
|
+
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
470
421
|
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
471
422
|
* @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.
|
|
472
423
|
* @throws {AppwriteException}
|
|
@@ -478,7 +429,7 @@ export declare class Project {
|
|
|
478
429
|
* Update the project OAuth2 Authentik configuration.
|
|
479
430
|
*
|
|
480
431
|
* @param {string} params.clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
481
|
-
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example:
|
|
432
|
+
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
482
433
|
* @param {string} params.endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
483
434
|
* @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.
|
|
484
435
|
* @throws {AppwriteException}
|
|
@@ -494,7 +445,7 @@ export declare class Project {
|
|
|
494
445
|
* Update the project OAuth2 Authentik configuration.
|
|
495
446
|
*
|
|
496
447
|
* @param {string} clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
497
|
-
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example:
|
|
448
|
+
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
498
449
|
* @param {string} endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
499
450
|
* @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.
|
|
500
451
|
* @throws {AppwriteException}
|
|
@@ -506,7 +457,7 @@ export declare class Project {
|
|
|
506
457
|
* Update the project OAuth2 Autodesk configuration.
|
|
507
458
|
*
|
|
508
459
|
* @param {string} params.clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
509
|
-
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example:
|
|
460
|
+
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
510
461
|
* @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.
|
|
511
462
|
* @throws {AppwriteException}
|
|
512
463
|
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
@@ -520,7 +471,7 @@ export declare class Project {
|
|
|
520
471
|
* Update the project OAuth2 Autodesk configuration.
|
|
521
472
|
*
|
|
522
473
|
* @param {string} clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
523
|
-
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example:
|
|
474
|
+
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
524
475
|
* @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.
|
|
525
476
|
* @throws {AppwriteException}
|
|
526
477
|
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
@@ -531,7 +482,7 @@ export declare class Project {
|
|
|
531
482
|
* Update the project OAuth2 Bitbucket configuration.
|
|
532
483
|
*
|
|
533
484
|
* @param {string} params.key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
534
|
-
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example:
|
|
485
|
+
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
535
486
|
* @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.
|
|
536
487
|
* @throws {AppwriteException}
|
|
537
488
|
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
@@ -545,7 +496,7 @@ export declare class Project {
|
|
|
545
496
|
* Update the project OAuth2 Bitbucket configuration.
|
|
546
497
|
*
|
|
547
498
|
* @param {string} key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
548
|
-
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example:
|
|
499
|
+
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
549
500
|
* @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.
|
|
550
501
|
* @throws {AppwriteException}
|
|
551
502
|
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
@@ -556,7 +507,7 @@ export declare class Project {
|
|
|
556
507
|
* Update the project OAuth2 Bitly configuration.
|
|
557
508
|
*
|
|
558
509
|
* @param {string} params.clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
559
|
-
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example:
|
|
510
|
+
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
560
511
|
* @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.
|
|
561
512
|
* @throws {AppwriteException}
|
|
562
513
|
* @returns {Promise<Models.OAuth2Bitly>}
|
|
@@ -570,7 +521,7 @@ export declare class Project {
|
|
|
570
521
|
* Update the project OAuth2 Bitly configuration.
|
|
571
522
|
*
|
|
572
523
|
* @param {string} clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
573
|
-
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example:
|
|
524
|
+
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
574
525
|
* @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.
|
|
575
526
|
* @throws {AppwriteException}
|
|
576
527
|
* @returns {Promise<Models.OAuth2Bitly>}
|
|
@@ -581,7 +532,7 @@ export declare class Project {
|
|
|
581
532
|
* Update the project OAuth2 Box configuration.
|
|
582
533
|
*
|
|
583
534
|
* @param {string} params.clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
584
|
-
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example:
|
|
535
|
+
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
585
536
|
* @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.
|
|
586
537
|
* @throws {AppwriteException}
|
|
587
538
|
* @returns {Promise<Models.OAuth2Box>}
|
|
@@ -595,7 +546,7 @@ export declare class Project {
|
|
|
595
546
|
* Update the project OAuth2 Box configuration.
|
|
596
547
|
*
|
|
597
548
|
* @param {string} clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
598
|
-
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example:
|
|
549
|
+
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
599
550
|
* @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.
|
|
600
551
|
* @throws {AppwriteException}
|
|
601
552
|
* @returns {Promise<Models.OAuth2Box>}
|
|
@@ -606,7 +557,7 @@ export declare class Project {
|
|
|
606
557
|
* Update the project OAuth2 Dailymotion configuration.
|
|
607
558
|
*
|
|
608
559
|
* @param {string} params.apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
609
|
-
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example:
|
|
560
|
+
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
610
561
|
* @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.
|
|
611
562
|
* @throws {AppwriteException}
|
|
612
563
|
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
@@ -620,7 +571,7 @@ export declare class Project {
|
|
|
620
571
|
* Update the project OAuth2 Dailymotion configuration.
|
|
621
572
|
*
|
|
622
573
|
* @param {string} apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
623
|
-
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example:
|
|
574
|
+
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
624
575
|
* @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.
|
|
625
576
|
* @throws {AppwriteException}
|
|
626
577
|
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
@@ -631,7 +582,7 @@ export declare class Project {
|
|
|
631
582
|
* Update the project OAuth2 Discord configuration.
|
|
632
583
|
*
|
|
633
584
|
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
634
|
-
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example:
|
|
585
|
+
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
635
586
|
* @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.
|
|
636
587
|
* @throws {AppwriteException}
|
|
637
588
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -645,7 +596,7 @@ export declare class Project {
|
|
|
645
596
|
* Update the project OAuth2 Discord configuration.
|
|
646
597
|
*
|
|
647
598
|
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
648
|
-
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example:
|
|
599
|
+
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
649
600
|
* @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.
|
|
650
601
|
* @throws {AppwriteException}
|
|
651
602
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -656,7 +607,7 @@ export declare class Project {
|
|
|
656
607
|
* Update the project OAuth2 Disqus configuration.
|
|
657
608
|
*
|
|
658
609
|
* @param {string} params.publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
659
|
-
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example:
|
|
610
|
+
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
660
611
|
* @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.
|
|
661
612
|
* @throws {AppwriteException}
|
|
662
613
|
* @returns {Promise<Models.OAuth2Disqus>}
|
|
@@ -670,7 +621,7 @@ export declare class Project {
|
|
|
670
621
|
* Update the project OAuth2 Disqus configuration.
|
|
671
622
|
*
|
|
672
623
|
* @param {string} publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
673
|
-
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example:
|
|
624
|
+
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
674
625
|
* @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.
|
|
675
626
|
* @throws {AppwriteException}
|
|
676
627
|
* @returns {Promise<Models.OAuth2Disqus>}
|
|
@@ -681,7 +632,7 @@ export declare class Project {
|
|
|
681
632
|
* Update the project OAuth2 Dropbox configuration.
|
|
682
633
|
*
|
|
683
634
|
* @param {string} params.appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
684
|
-
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example:
|
|
635
|
+
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
685
636
|
* @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.
|
|
686
637
|
* @throws {AppwriteException}
|
|
687
638
|
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
@@ -695,7 +646,7 @@ export declare class Project {
|
|
|
695
646
|
* Update the project OAuth2 Dropbox configuration.
|
|
696
647
|
*
|
|
697
648
|
* @param {string} appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
698
|
-
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example:
|
|
649
|
+
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
699
650
|
* @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.
|
|
700
651
|
* @throws {AppwriteException}
|
|
701
652
|
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
@@ -706,7 +657,7 @@ export declare class Project {
|
|
|
706
657
|
* Update the project OAuth2 Etsy configuration.
|
|
707
658
|
*
|
|
708
659
|
* @param {string} params.keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
709
|
-
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example:
|
|
660
|
+
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
710
661
|
* @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.
|
|
711
662
|
* @throws {AppwriteException}
|
|
712
663
|
* @returns {Promise<Models.OAuth2Etsy>}
|
|
@@ -720,7 +671,7 @@ export declare class Project {
|
|
|
720
671
|
* Update the project OAuth2 Etsy configuration.
|
|
721
672
|
*
|
|
722
673
|
* @param {string} keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
723
|
-
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example:
|
|
674
|
+
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
724
675
|
* @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.
|
|
725
676
|
* @throws {AppwriteException}
|
|
726
677
|
* @returns {Promise<Models.OAuth2Etsy>}
|
|
@@ -731,7 +682,7 @@ export declare class Project {
|
|
|
731
682
|
* Update the project OAuth2 Facebook configuration.
|
|
732
683
|
*
|
|
733
684
|
* @param {string} params.appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
734
|
-
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example:
|
|
685
|
+
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
735
686
|
* @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.
|
|
736
687
|
* @throws {AppwriteException}
|
|
737
688
|
* @returns {Promise<Models.OAuth2Facebook>}
|
|
@@ -745,7 +696,7 @@ export declare class Project {
|
|
|
745
696
|
* Update the project OAuth2 Facebook configuration.
|
|
746
697
|
*
|
|
747
698
|
* @param {string} appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
748
|
-
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example:
|
|
699
|
+
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
749
700
|
* @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.
|
|
750
701
|
* @throws {AppwriteException}
|
|
751
702
|
* @returns {Promise<Models.OAuth2Facebook>}
|
|
@@ -756,7 +707,7 @@ export declare class Project {
|
|
|
756
707
|
* Update the project OAuth2 Figma configuration.
|
|
757
708
|
*
|
|
758
709
|
* @param {string} params.clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
759
|
-
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example:
|
|
710
|
+
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
760
711
|
* @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.
|
|
761
712
|
* @throws {AppwriteException}
|
|
762
713
|
* @returns {Promise<Models.OAuth2Figma>}
|
|
@@ -770,7 +721,7 @@ export declare class Project {
|
|
|
770
721
|
* Update the project OAuth2 Figma configuration.
|
|
771
722
|
*
|
|
772
723
|
* @param {string} clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
773
|
-
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example:
|
|
724
|
+
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
774
725
|
* @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.
|
|
775
726
|
* @throws {AppwriteException}
|
|
776
727
|
* @returns {Promise<Models.OAuth2Figma>}
|
|
@@ -781,7 +732,7 @@ export declare class Project {
|
|
|
781
732
|
* Update the project OAuth2 FusionAuth configuration.
|
|
782
733
|
*
|
|
783
734
|
* @param {string} params.clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
784
|
-
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example:
|
|
735
|
+
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
785
736
|
* @param {string} params.endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
786
737
|
* @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.
|
|
787
738
|
* @throws {AppwriteException}
|
|
@@ -797,7 +748,7 @@ export declare class Project {
|
|
|
797
748
|
* Update the project OAuth2 FusionAuth configuration.
|
|
798
749
|
*
|
|
799
750
|
* @param {string} clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
800
|
-
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example:
|
|
751
|
+
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
801
752
|
* @param {string} endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
802
753
|
* @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.
|
|
803
754
|
* @throws {AppwriteException}
|
|
@@ -809,7 +760,7 @@ export declare class Project {
|
|
|
809
760
|
* Update the project OAuth2 GitHub configuration.
|
|
810
761
|
*
|
|
811
762
|
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
812
|
-
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example:
|
|
763
|
+
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
813
764
|
* @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.
|
|
814
765
|
* @throws {AppwriteException}
|
|
815
766
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -823,7 +774,7 @@ export declare class Project {
|
|
|
823
774
|
* Update the project OAuth2 GitHub configuration.
|
|
824
775
|
*
|
|
825
776
|
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
826
|
-
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example:
|
|
777
|
+
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
827
778
|
* @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
779
|
* @throws {AppwriteException}
|
|
829
780
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -834,7 +785,7 @@ export declare class Project {
|
|
|
834
785
|
* Update the project OAuth2 Gitlab configuration.
|
|
835
786
|
*
|
|
836
787
|
* @param {string} params.applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
837
|
-
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example:
|
|
788
|
+
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
838
789
|
* @param {string} params.endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
839
790
|
* @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.
|
|
840
791
|
* @throws {AppwriteException}
|
|
@@ -850,7 +801,7 @@ export declare class Project {
|
|
|
850
801
|
* Update the project OAuth2 Gitlab configuration.
|
|
851
802
|
*
|
|
852
803
|
* @param {string} applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
853
|
-
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example:
|
|
804
|
+
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
854
805
|
* @param {string} endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
855
806
|
* @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.
|
|
856
807
|
* @throws {AppwriteException}
|
|
@@ -862,7 +813,8 @@ export declare class Project {
|
|
|
862
813
|
* Update the project OAuth2 Google configuration.
|
|
863
814
|
*
|
|
864
815
|
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
865
|
-
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example:
|
|
816
|
+
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
817
|
+
* @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.
|
|
866
818
|
* @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.
|
|
867
819
|
* @throws {AppwriteException}
|
|
868
820
|
* @returns {Promise<Models.OAuth2Google>}
|
|
@@ -870,24 +822,26 @@ export declare class Project {
|
|
|
870
822
|
updateOAuth2Google(params?: {
|
|
871
823
|
clientId?: string;
|
|
872
824
|
clientSecret?: string;
|
|
825
|
+
prompt?: ProjectOAuth2GooglePrompt[];
|
|
873
826
|
enabled?: boolean;
|
|
874
827
|
}): Promise<Models.OAuth2Google>;
|
|
875
828
|
/**
|
|
876
829
|
* Update the project OAuth2 Google configuration.
|
|
877
830
|
*
|
|
878
831
|
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
879
|
-
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example:
|
|
832
|
+
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
833
|
+
* @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.
|
|
880
834
|
* @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.
|
|
881
835
|
* @throws {AppwriteException}
|
|
882
836
|
* @returns {Promise<Models.OAuth2Google>}
|
|
883
837
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
884
838
|
*/
|
|
885
|
-
updateOAuth2Google(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
839
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GooglePrompt[], enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
886
840
|
/**
|
|
887
841
|
* Update the project OAuth2 Keycloak configuration.
|
|
888
842
|
*
|
|
889
843
|
* @param {string} params.clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
890
|
-
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example:
|
|
844
|
+
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
891
845
|
* @param {string} params.endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
892
846
|
* @param {string} params.realmName - Keycloak realm name. For example: appwrite-realm
|
|
893
847
|
* @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.
|
|
@@ -905,7 +859,7 @@ export declare class Project {
|
|
|
905
859
|
* Update the project OAuth2 Keycloak configuration.
|
|
906
860
|
*
|
|
907
861
|
* @param {string} clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
908
|
-
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example:
|
|
862
|
+
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
909
863
|
* @param {string} endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
910
864
|
* @param {string} realmName - Keycloak realm name. For example: appwrite-realm
|
|
911
865
|
* @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.
|
|
@@ -918,7 +872,7 @@ export declare class Project {
|
|
|
918
872
|
* Update the project OAuth2 Kick configuration.
|
|
919
873
|
*
|
|
920
874
|
* @param {string} params.clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
921
|
-
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example:
|
|
875
|
+
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
922
876
|
* @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.
|
|
923
877
|
* @throws {AppwriteException}
|
|
924
878
|
* @returns {Promise<Models.OAuth2Kick>}
|
|
@@ -932,7 +886,7 @@ export declare class Project {
|
|
|
932
886
|
* Update the project OAuth2 Kick configuration.
|
|
933
887
|
*
|
|
934
888
|
* @param {string} clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
935
|
-
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example:
|
|
889
|
+
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
936
890
|
* @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.
|
|
937
891
|
* @throws {AppwriteException}
|
|
938
892
|
* @returns {Promise<Models.OAuth2Kick>}
|
|
@@ -943,7 +897,7 @@ export declare class Project {
|
|
|
943
897
|
* Update the project OAuth2 Linkedin configuration.
|
|
944
898
|
*
|
|
945
899
|
* @param {string} params.clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
946
|
-
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example:
|
|
900
|
+
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
947
901
|
* @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.
|
|
948
902
|
* @throws {AppwriteException}
|
|
949
903
|
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
@@ -957,7 +911,7 @@ export declare class Project {
|
|
|
957
911
|
* Update the project OAuth2 Linkedin configuration.
|
|
958
912
|
*
|
|
959
913
|
* @param {string} clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
960
|
-
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example:
|
|
914
|
+
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
961
915
|
* @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.
|
|
962
916
|
* @throws {AppwriteException}
|
|
963
917
|
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
@@ -968,7 +922,7 @@ export declare class Project {
|
|
|
968
922
|
* Update the project OAuth2 Microsoft configuration.
|
|
969
923
|
*
|
|
970
924
|
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
971
|
-
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example:
|
|
925
|
+
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
972
926
|
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
973
927
|
* @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.
|
|
974
928
|
* @throws {AppwriteException}
|
|
@@ -984,7 +938,7 @@ export declare class Project {
|
|
|
984
938
|
* Update the project OAuth2 Microsoft configuration.
|
|
985
939
|
*
|
|
986
940
|
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
987
|
-
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example:
|
|
941
|
+
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
988
942
|
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
989
943
|
* @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.
|
|
990
944
|
* @throws {AppwriteException}
|
|
@@ -996,7 +950,7 @@ export declare class Project {
|
|
|
996
950
|
* Update the project OAuth2 Notion configuration.
|
|
997
951
|
*
|
|
998
952
|
* @param {string} params.oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
999
|
-
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example:
|
|
953
|
+
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
1000
954
|
* @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.
|
|
1001
955
|
* @throws {AppwriteException}
|
|
1002
956
|
* @returns {Promise<Models.OAuth2Notion>}
|
|
@@ -1010,7 +964,7 @@ export declare class Project {
|
|
|
1010
964
|
* Update the project OAuth2 Notion configuration.
|
|
1011
965
|
*
|
|
1012
966
|
* @param {string} oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
1013
|
-
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example:
|
|
967
|
+
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
1014
968
|
* @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.
|
|
1015
969
|
* @throws {AppwriteException}
|
|
1016
970
|
* @returns {Promise<Models.OAuth2Notion>}
|
|
@@ -1021,7 +975,7 @@ export declare class Project {
|
|
|
1021
975
|
* Update the project OAuth2 Oidc configuration.
|
|
1022
976
|
*
|
|
1023
977
|
* @param {string} params.clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1024
|
-
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example:
|
|
978
|
+
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1025
979
|
* @param {string} params.wellKnownURL - OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1026
980
|
* @param {string} params.authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1027
981
|
* @param {string} params.tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
@@ -1043,7 +997,7 @@ export declare class Project {
|
|
|
1043
997
|
* Update the project OAuth2 Oidc configuration.
|
|
1044
998
|
*
|
|
1045
999
|
* @param {string} clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1046
|
-
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example:
|
|
1000
|
+
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1047
1001
|
* @param {string} wellKnownURL - OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1048
1002
|
* @param {string} authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1049
1003
|
* @param {string} tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
@@ -1058,7 +1012,7 @@ export declare class Project {
|
|
|
1058
1012
|
* Update the project OAuth2 Okta configuration.
|
|
1059
1013
|
*
|
|
1060
1014
|
* @param {string} params.clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1061
|
-
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example:
|
|
1015
|
+
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1062
1016
|
* @param {string} params.domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1063
1017
|
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1064
1018
|
* @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.
|
|
@@ -1076,7 +1030,7 @@ export declare class Project {
|
|
|
1076
1030
|
* Update the project OAuth2 Okta configuration.
|
|
1077
1031
|
*
|
|
1078
1032
|
* @param {string} clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1079
|
-
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example:
|
|
1033
|
+
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1080
1034
|
* @param {string} domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1081
1035
|
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1082
1036
|
* @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.
|
|
@@ -1089,7 +1043,7 @@ export declare class Project {
|
|
|
1089
1043
|
* Update the project OAuth2 Paypal configuration.
|
|
1090
1044
|
*
|
|
1091
1045
|
* @param {string} params.clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1092
|
-
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example:
|
|
1046
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1093
1047
|
* @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.
|
|
1094
1048
|
* @throws {AppwriteException}
|
|
1095
1049
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1103,7 +1057,7 @@ export declare class Project {
|
|
|
1103
1057
|
* Update the project OAuth2 Paypal configuration.
|
|
1104
1058
|
*
|
|
1105
1059
|
* @param {string} clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1106
|
-
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example:
|
|
1060
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1107
1061
|
* @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.
|
|
1108
1062
|
* @throws {AppwriteException}
|
|
1109
1063
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1114,7 +1068,7 @@ export declare class Project {
|
|
|
1114
1068
|
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1115
1069
|
*
|
|
1116
1070
|
* @param {string} params.clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1117
|
-
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example:
|
|
1071
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1118
1072
|
* @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.
|
|
1119
1073
|
* @throws {AppwriteException}
|
|
1120
1074
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1128,7 +1082,7 @@ export declare class Project {
|
|
|
1128
1082
|
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1129
1083
|
*
|
|
1130
1084
|
* @param {string} clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1131
|
-
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example:
|
|
1085
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1132
1086
|
* @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.
|
|
1133
1087
|
* @throws {AppwriteException}
|
|
1134
1088
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1139,7 +1093,7 @@ export declare class Project {
|
|
|
1139
1093
|
* Update the project OAuth2 Podio configuration.
|
|
1140
1094
|
*
|
|
1141
1095
|
* @param {string} params.clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1142
|
-
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example:
|
|
1096
|
+
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1143
1097
|
* @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.
|
|
1144
1098
|
* @throws {AppwriteException}
|
|
1145
1099
|
* @returns {Promise<Models.OAuth2Podio>}
|
|
@@ -1153,7 +1107,7 @@ export declare class Project {
|
|
|
1153
1107
|
* Update the project OAuth2 Podio configuration.
|
|
1154
1108
|
*
|
|
1155
1109
|
* @param {string} clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1156
|
-
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example:
|
|
1110
|
+
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1157
1111
|
* @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.
|
|
1158
1112
|
* @throws {AppwriteException}
|
|
1159
1113
|
* @returns {Promise<Models.OAuth2Podio>}
|
|
@@ -1164,7 +1118,7 @@ export declare class Project {
|
|
|
1164
1118
|
* Update the project OAuth2 Salesforce configuration.
|
|
1165
1119
|
*
|
|
1166
1120
|
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1167
|
-
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example:
|
|
1121
|
+
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1168
1122
|
* @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.
|
|
1169
1123
|
* @throws {AppwriteException}
|
|
1170
1124
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1178,7 +1132,7 @@ export declare class Project {
|
|
|
1178
1132
|
* Update the project OAuth2 Salesforce configuration.
|
|
1179
1133
|
*
|
|
1180
1134
|
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1181
|
-
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example:
|
|
1135
|
+
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1182
1136
|
* @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.
|
|
1183
1137
|
* @throws {AppwriteException}
|
|
1184
1138
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1189,7 +1143,7 @@ export declare class Project {
|
|
|
1189
1143
|
* Update the project OAuth2 Slack configuration.
|
|
1190
1144
|
*
|
|
1191
1145
|
* @param {string} params.clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1192
|
-
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example:
|
|
1146
|
+
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1193
1147
|
* @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.
|
|
1194
1148
|
* @throws {AppwriteException}
|
|
1195
1149
|
* @returns {Promise<Models.OAuth2Slack>}
|
|
@@ -1203,7 +1157,7 @@ export declare class Project {
|
|
|
1203
1157
|
* Update the project OAuth2 Slack configuration.
|
|
1204
1158
|
*
|
|
1205
1159
|
* @param {string} clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1206
|
-
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example:
|
|
1160
|
+
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1207
1161
|
* @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.
|
|
1208
1162
|
* @throws {AppwriteException}
|
|
1209
1163
|
* @returns {Promise<Models.OAuth2Slack>}
|
|
@@ -1214,7 +1168,7 @@ export declare class Project {
|
|
|
1214
1168
|
* Update the project OAuth2 Spotify configuration.
|
|
1215
1169
|
*
|
|
1216
1170
|
* @param {string} params.clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1217
|
-
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example:
|
|
1171
|
+
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1218
1172
|
* @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.
|
|
1219
1173
|
* @throws {AppwriteException}
|
|
1220
1174
|
* @returns {Promise<Models.OAuth2Spotify>}
|
|
@@ -1228,7 +1182,7 @@ export declare class Project {
|
|
|
1228
1182
|
* Update the project OAuth2 Spotify configuration.
|
|
1229
1183
|
*
|
|
1230
1184
|
* @param {string} clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1231
|
-
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example:
|
|
1185
|
+
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1232
1186
|
* @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.
|
|
1233
1187
|
* @throws {AppwriteException}
|
|
1234
1188
|
* @returns {Promise<Models.OAuth2Spotify>}
|
|
@@ -1239,7 +1193,7 @@ export declare class Project {
|
|
|
1239
1193
|
* Update the project OAuth2 Stripe configuration.
|
|
1240
1194
|
*
|
|
1241
1195
|
* @param {string} params.clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1242
|
-
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example:
|
|
1196
|
+
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1243
1197
|
* @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.
|
|
1244
1198
|
* @throws {AppwriteException}
|
|
1245
1199
|
* @returns {Promise<Models.OAuth2Stripe>}
|
|
@@ -1253,7 +1207,7 @@ export declare class Project {
|
|
|
1253
1207
|
* Update the project OAuth2 Stripe configuration.
|
|
1254
1208
|
*
|
|
1255
1209
|
* @param {string} clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1256
|
-
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example:
|
|
1210
|
+
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1257
1211
|
* @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.
|
|
1258
1212
|
* @throws {AppwriteException}
|
|
1259
1213
|
* @returns {Promise<Models.OAuth2Stripe>}
|
|
@@ -1264,7 +1218,7 @@ export declare class Project {
|
|
|
1264
1218
|
* Update the project OAuth2 Tradeshift configuration.
|
|
1265
1219
|
*
|
|
1266
1220
|
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1267
|
-
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example:
|
|
1221
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1268
1222
|
* @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.
|
|
1269
1223
|
* @throws {AppwriteException}
|
|
1270
1224
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1278,7 +1232,7 @@ export declare class Project {
|
|
|
1278
1232
|
* Update the project OAuth2 Tradeshift configuration.
|
|
1279
1233
|
*
|
|
1280
1234
|
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1281
|
-
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example:
|
|
1235
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1282
1236
|
* @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.
|
|
1283
1237
|
* @throws {AppwriteException}
|
|
1284
1238
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1289,7 +1243,7 @@ export declare class Project {
|
|
|
1289
1243
|
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1290
1244
|
*
|
|
1291
1245
|
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1292
|
-
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example:
|
|
1246
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1293
1247
|
* @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
1248
|
* @throws {AppwriteException}
|
|
1295
1249
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1303,7 +1257,7 @@ export declare class Project {
|
|
|
1303
1257
|
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1304
1258
|
*
|
|
1305
1259
|
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1306
|
-
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example:
|
|
1260
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1307
1261
|
* @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
1262
|
* @throws {AppwriteException}
|
|
1309
1263
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1314,7 +1268,7 @@ export declare class Project {
|
|
|
1314
1268
|
* Update the project OAuth2 Twitch configuration.
|
|
1315
1269
|
*
|
|
1316
1270
|
* @param {string} params.clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1317
|
-
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example:
|
|
1271
|
+
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1318
1272
|
* @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.
|
|
1319
1273
|
* @throws {AppwriteException}
|
|
1320
1274
|
* @returns {Promise<Models.OAuth2Twitch>}
|
|
@@ -1328,7 +1282,7 @@ export declare class Project {
|
|
|
1328
1282
|
* Update the project OAuth2 Twitch configuration.
|
|
1329
1283
|
*
|
|
1330
1284
|
* @param {string} clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1331
|
-
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example:
|
|
1285
|
+
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1332
1286
|
* @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.
|
|
1333
1287
|
* @throws {AppwriteException}
|
|
1334
1288
|
* @returns {Promise<Models.OAuth2Twitch>}
|
|
@@ -1339,7 +1293,7 @@ export declare class Project {
|
|
|
1339
1293
|
* Update the project OAuth2 WordPress configuration.
|
|
1340
1294
|
*
|
|
1341
1295
|
* @param {string} params.clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1342
|
-
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example:
|
|
1296
|
+
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1343
1297
|
* @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.
|
|
1344
1298
|
* @throws {AppwriteException}
|
|
1345
1299
|
* @returns {Promise<Models.OAuth2WordPress>}
|
|
@@ -1353,7 +1307,7 @@ export declare class Project {
|
|
|
1353
1307
|
* Update the project OAuth2 WordPress configuration.
|
|
1354
1308
|
*
|
|
1355
1309
|
* @param {string} clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1356
|
-
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example:
|
|
1310
|
+
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1357
1311
|
* @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.
|
|
1358
1312
|
* @throws {AppwriteException}
|
|
1359
1313
|
* @returns {Promise<Models.OAuth2WordPress>}
|
|
@@ -1364,7 +1318,7 @@ export declare class Project {
|
|
|
1364
1318
|
* Update the project OAuth2 X configuration.
|
|
1365
1319
|
*
|
|
1366
1320
|
* @param {string} params.customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1367
|
-
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example:
|
|
1321
|
+
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1368
1322
|
* @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.
|
|
1369
1323
|
* @throws {AppwriteException}
|
|
1370
1324
|
* @returns {Promise<Models.OAuth2X>}
|
|
@@ -1378,7 +1332,7 @@ export declare class Project {
|
|
|
1378
1332
|
* Update the project OAuth2 X configuration.
|
|
1379
1333
|
*
|
|
1380
1334
|
* @param {string} customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1381
|
-
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example:
|
|
1335
|
+
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1382
1336
|
* @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.
|
|
1383
1337
|
* @throws {AppwriteException}
|
|
1384
1338
|
* @returns {Promise<Models.OAuth2X>}
|
|
@@ -1389,7 +1343,7 @@ export declare class Project {
|
|
|
1389
1343
|
* Update the project OAuth2 Yahoo configuration.
|
|
1390
1344
|
*
|
|
1391
1345
|
* @param {string} params.clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1392
|
-
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example:
|
|
1346
|
+
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1393
1347
|
* @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.
|
|
1394
1348
|
* @throws {AppwriteException}
|
|
1395
1349
|
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
@@ -1403,7 +1357,7 @@ export declare class Project {
|
|
|
1403
1357
|
* Update the project OAuth2 Yahoo configuration.
|
|
1404
1358
|
*
|
|
1405
1359
|
* @param {string} clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1406
|
-
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example:
|
|
1360
|
+
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1407
1361
|
* @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.
|
|
1408
1362
|
* @throws {AppwriteException}
|
|
1409
1363
|
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
@@ -1414,7 +1368,7 @@ export declare class Project {
|
|
|
1414
1368
|
* Update the project OAuth2 Yandex configuration.
|
|
1415
1369
|
*
|
|
1416
1370
|
* @param {string} params.clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1417
|
-
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example:
|
|
1371
|
+
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1418
1372
|
* @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
1373
|
* @throws {AppwriteException}
|
|
1420
1374
|
* @returns {Promise<Models.OAuth2Yandex>}
|
|
@@ -1428,7 +1382,7 @@ export declare class Project {
|
|
|
1428
1382
|
* Update the project OAuth2 Yandex configuration.
|
|
1429
1383
|
*
|
|
1430
1384
|
* @param {string} clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1431
|
-
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example:
|
|
1385
|
+
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1432
1386
|
* @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
1387
|
* @throws {AppwriteException}
|
|
1434
1388
|
* @returns {Promise<Models.OAuth2Yandex>}
|
|
@@ -1439,7 +1393,7 @@ export declare class Project {
|
|
|
1439
1393
|
* Update the project OAuth2 Zoho configuration.
|
|
1440
1394
|
*
|
|
1441
1395
|
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1442
|
-
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example:
|
|
1396
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1443
1397
|
* @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.
|
|
1444
1398
|
* @throws {AppwriteException}
|
|
1445
1399
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1453,7 +1407,7 @@ export declare class Project {
|
|
|
1453
1407
|
* Update the project OAuth2 Zoho configuration.
|
|
1454
1408
|
*
|
|
1455
1409
|
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1456
|
-
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example:
|
|
1410
|
+
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1457
1411
|
* @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.
|
|
1458
1412
|
* @throws {AppwriteException}
|
|
1459
1413
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1464,7 +1418,7 @@ export declare class Project {
|
|
|
1464
1418
|
* Update the project OAuth2 Zoom configuration.
|
|
1465
1419
|
*
|
|
1466
1420
|
* @param {string} params.clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1467
|
-
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example:
|
|
1421
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1468
1422
|
* @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.
|
|
1469
1423
|
* @throws {AppwriteException}
|
|
1470
1424
|
* @returns {Promise<Models.OAuth2Zoom>}
|
|
@@ -1478,7 +1432,7 @@ export declare class Project {
|
|
|
1478
1432
|
* Update the project OAuth2 Zoom configuration.
|
|
1479
1433
|
*
|
|
1480
1434
|
* @param {string} clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1481
|
-
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example:
|
|
1435
|
+
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1482
1436
|
* @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.
|
|
1483
1437
|
* @throws {AppwriteException}
|
|
1484
1438
|
* @returns {Promise<Models.OAuth2Zoom>}
|
|
@@ -1488,22 +1442,22 @@ export declare class Project {
|
|
|
1488
1442
|
/**
|
|
1489
1443
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1490
1444
|
*
|
|
1491
|
-
* @param {
|
|
1445
|
+
* @param {ProjectOAuthProviderId} params.providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1492
1446
|
* @throws {AppwriteException}
|
|
1493
1447
|
* @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>}
|
|
1494
1448
|
*/
|
|
1495
1449
|
getOAuth2Provider(params: {
|
|
1496
|
-
providerId:
|
|
1450
|
+
providerId: ProjectOAuthProviderId;
|
|
1497
1451
|
}): 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>;
|
|
1498
1452
|
/**
|
|
1499
1453
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1500
1454
|
*
|
|
1501
|
-
* @param {
|
|
1455
|
+
* @param {ProjectOAuthProviderId} providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1502
1456
|
* @throws {AppwriteException}
|
|
1503
1457
|
* @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>}
|
|
1504
1458
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1505
1459
|
*/
|
|
1506
|
-
getOAuth2Provider(providerId:
|
|
1460
|
+
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>;
|
|
1507
1461
|
/**
|
|
1508
1462
|
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
1509
1463
|
*
|
|
@@ -1836,6 +1790,63 @@ export declare class Project {
|
|
|
1836
1790
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1837
1791
|
*/
|
|
1838
1792
|
listPolicies(queries?: string[], total?: boolean): Promise<Models.PolicyList>;
|
|
1793
|
+
/**
|
|
1794
|
+
* Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.
|
|
1795
|
+
*
|
|
1796
|
+
* @param {boolean} params.enabled - Set whether or not to block aliased emails during signup and email updates.
|
|
1797
|
+
* @throws {AppwriteException}
|
|
1798
|
+
* @returns {Promise<Models.Project>}
|
|
1799
|
+
*/
|
|
1800
|
+
updateDenyAliasedEmailPolicy(params: {
|
|
1801
|
+
enabled: boolean;
|
|
1802
|
+
}): Promise<Models.Project>;
|
|
1803
|
+
/**
|
|
1804
|
+
* Configures if aliased emails such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.
|
|
1805
|
+
*
|
|
1806
|
+
* @param {boolean} enabled - Set whether or not to block aliased emails during signup and email updates.
|
|
1807
|
+
* @throws {AppwriteException}
|
|
1808
|
+
* @returns {Promise<Models.Project>}
|
|
1809
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1810
|
+
*/
|
|
1811
|
+
updateDenyAliasedEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1812
|
+
/**
|
|
1813
|
+
* Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.
|
|
1814
|
+
*
|
|
1815
|
+
* @param {boolean} params.enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
1816
|
+
* @throws {AppwriteException}
|
|
1817
|
+
* @returns {Promise<Models.Project>}
|
|
1818
|
+
*/
|
|
1819
|
+
updateDenyDisposableEmailPolicy(params: {
|
|
1820
|
+
enabled: boolean;
|
|
1821
|
+
}): Promise<Models.Project>;
|
|
1822
|
+
/**
|
|
1823
|
+
* Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.
|
|
1824
|
+
*
|
|
1825
|
+
* @param {boolean} enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
1826
|
+
* @throws {AppwriteException}
|
|
1827
|
+
* @returns {Promise<Models.Project>}
|
|
1828
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1829
|
+
*/
|
|
1830
|
+
updateDenyDisposableEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.
|
|
1833
|
+
*
|
|
1834
|
+
* @param {boolean} params.enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
1835
|
+
* @throws {AppwriteException}
|
|
1836
|
+
* @returns {Promise<Models.Project>}
|
|
1837
|
+
*/
|
|
1838
|
+
updateDenyFreeEmailPolicy(params: {
|
|
1839
|
+
enabled: boolean;
|
|
1840
|
+
}): Promise<Models.Project>;
|
|
1841
|
+
/**
|
|
1842
|
+
* Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.
|
|
1843
|
+
*
|
|
1844
|
+
* @param {boolean} enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
1845
|
+
* @throws {AppwriteException}
|
|
1846
|
+
* @returns {Promise<Models.Project>}
|
|
1847
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1848
|
+
*/
|
|
1849
|
+
updateDenyFreeEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1839
1850
|
/**
|
|
1840
1851
|
* 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..
|
|
1841
1852
|
*
|
|
@@ -2026,78 +2037,78 @@ export declare class Project {
|
|
|
2026
2037
|
/**
|
|
2027
2038
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2028
2039
|
*
|
|
2029
|
-
* @param {
|
|
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.
|
|
2030
2041
|
* @throws {AppwriteException}
|
|
2031
2042
|
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2032
2043
|
*/
|
|
2033
2044
|
getPolicy(params: {
|
|
2034
|
-
policyId:
|
|
2045
|
+
policyId: ProjectPolicyId;
|
|
2035
2046
|
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2036
2047
|
/**
|
|
2037
2048
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2038
2049
|
*
|
|
2039
|
-
* @param {
|
|
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.
|
|
2040
2051
|
* @throws {AppwriteException}
|
|
2041
2052
|
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2042
2053
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2043
2054
|
*/
|
|
2044
|
-
getPolicy(policyId:
|
|
2055
|
+
getPolicy(policyId: ProjectPolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2045
2056
|
/**
|
|
2046
2057
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2047
2058
|
*
|
|
2048
|
-
* @param {
|
|
2059
|
+
* @param {ProjectProtocolId} params.protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
2049
2060
|
* @param {boolean} params.enabled - Protocol status.
|
|
2050
2061
|
* @throws {AppwriteException}
|
|
2051
2062
|
* @returns {Promise<Models.Project>}
|
|
2052
2063
|
*/
|
|
2053
2064
|
updateProtocol(params: {
|
|
2054
|
-
protocolId:
|
|
2065
|
+
protocolId: ProjectProtocolId;
|
|
2055
2066
|
enabled: boolean;
|
|
2056
2067
|
}): Promise<Models.Project>;
|
|
2057
2068
|
/**
|
|
2058
2069
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2059
2070
|
*
|
|
2060
|
-
* @param {
|
|
2071
|
+
* @param {ProjectProtocolId} protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
2061
2072
|
* @param {boolean} enabled - Protocol status.
|
|
2062
2073
|
* @throws {AppwriteException}
|
|
2063
2074
|
* @returns {Promise<Models.Project>}
|
|
2064
2075
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2065
2076
|
*/
|
|
2066
|
-
updateProtocol(protocolId:
|
|
2077
|
+
updateProtocol(protocolId: ProjectProtocolId, enabled: boolean): Promise<Models.Project>;
|
|
2067
2078
|
/**
|
|
2068
2079
|
* Update properties of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
2069
2080
|
*
|
|
2070
|
-
* @param {
|
|
2081
|
+
* @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
|
|
2071
2082
|
* @param {boolean} params.enabled - Service status.
|
|
2072
2083
|
* @throws {AppwriteException}
|
|
2073
2084
|
* @returns {Promise<Models.Project>}
|
|
2074
2085
|
*/
|
|
2075
2086
|
updateService(params: {
|
|
2076
|
-
serviceId:
|
|
2087
|
+
serviceId: ProjectServiceId;
|
|
2077
2088
|
enabled: boolean;
|
|
2078
2089
|
}): Promise<Models.Project>;
|
|
2079
2090
|
/**
|
|
2080
2091
|
* Update properties of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
2081
2092
|
*
|
|
2082
|
-
* @param {
|
|
2093
|
+
* @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
|
|
2083
2094
|
* @param {boolean} enabled - Service status.
|
|
2084
2095
|
* @throws {AppwriteException}
|
|
2085
2096
|
* @returns {Promise<Models.Project>}
|
|
2086
2097
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2087
2098
|
*/
|
|
2088
|
-
updateService(serviceId:
|
|
2099
|
+
updateService(serviceId: ProjectServiceId, enabled: boolean): Promise<Models.Project>;
|
|
2089
2100
|
/**
|
|
2090
2101
|
* 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.
|
|
2091
2102
|
*
|
|
2092
2103
|
* @param {string} params.host - SMTP server hostname (domain)
|
|
2093
2104
|
* @param {number} params.port - SMTP server port
|
|
2094
|
-
* @param {string} params.username - SMTP server username.
|
|
2095
|
-
* @param {string} params.password - SMTP server password.
|
|
2096
|
-
* @param {string} params.senderEmail - Email address shown in inbox as the sender of the email.
|
|
2097
|
-
* @param {string} params.senderName - Name shown in inbox as the sender of the email.
|
|
2098
|
-
* @param {string} params.replyToEmail - Email used when user replies to the email.
|
|
2099
|
-
* @param {string} params.replyToName - Name used when user replies to the email.
|
|
2100
|
-
* @param {
|
|
2105
|
+
* @param {string} params.username - SMTP server username. Pass an empty string to clear a previously set value.
|
|
2106
|
+
* @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).
|
|
2107
|
+
* @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.
|
|
2108
|
+
* @param {string} params.senderName - Name shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2109
|
+
* @param {string} params.replyToEmail - Email used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2110
|
+
* @param {string} params.replyToName - Name used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2111
|
+
* @param {ProjectSMTPSecure} params.secure - Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.
|
|
2101
2112
|
* @param {boolean} params.enabled - Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
2102
2113
|
* @throws {AppwriteException}
|
|
2103
2114
|
* @returns {Promise<Models.Project>}
|
|
@@ -2111,7 +2122,7 @@ export declare class Project {
|
|
|
2111
2122
|
senderName?: string;
|
|
2112
2123
|
replyToEmail?: string;
|
|
2113
2124
|
replyToName?: string;
|
|
2114
|
-
secure?:
|
|
2125
|
+
secure?: ProjectSMTPSecure;
|
|
2115
2126
|
enabled?: boolean;
|
|
2116
2127
|
}): Promise<Models.Project>;
|
|
2117
2128
|
/**
|
|
@@ -2119,19 +2130,19 @@ export declare class Project {
|
|
|
2119
2130
|
*
|
|
2120
2131
|
* @param {string} host - SMTP server hostname (domain)
|
|
2121
2132
|
* @param {number} port - SMTP server port
|
|
2122
|
-
* @param {string} username - SMTP server username.
|
|
2123
|
-
* @param {string} password - SMTP server password.
|
|
2124
|
-
* @param {string} senderEmail - Email address shown in inbox as the sender of the email.
|
|
2125
|
-
* @param {string} senderName - Name shown in inbox as the sender of the email.
|
|
2126
|
-
* @param {string} replyToEmail - Email used when user replies to the email.
|
|
2127
|
-
* @param {string} replyToName - Name used when user replies to the email.
|
|
2128
|
-
* @param {
|
|
2133
|
+
* @param {string} username - SMTP server username. Pass an empty string to clear a previously set value.
|
|
2134
|
+
* @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).
|
|
2135
|
+
* @param {string} senderEmail - Email address shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2136
|
+
* @param {string} senderName - Name shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.
|
|
2137
|
+
* @param {string} replyToEmail - Email used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2138
|
+
* @param {string} replyToName - Name used when user replies to the email. Pass an empty string to clear a previously set value.
|
|
2139
|
+
* @param {ProjectSMTPSecure} secure - Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.
|
|
2129
2140
|
* @param {boolean} enabled - Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
2130
2141
|
* @throws {AppwriteException}
|
|
2131
2142
|
* @returns {Promise<Models.Project>}
|
|
2132
2143
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2133
2144
|
*/
|
|
2134
|
-
updateSMTP(host?: string, port?: number, username?: string, password?: string, senderEmail?: string, senderName?: string, replyToEmail?: string, replyToName?: string, secure?:
|
|
2145
|
+
updateSMTP(host?: string, port?: number, username?: string, password?: string, senderEmail?: string, senderName?: string, replyToEmail?: string, replyToName?: string, secure?: ProjectSMTPSecure, enabled?: boolean): Promise<Models.Project>;
|
|
2135
2146
|
/**
|
|
2136
2147
|
* Send a test email to verify SMTP configuration.
|
|
2137
2148
|
*
|
|
@@ -2176,20 +2187,20 @@ export declare class Project {
|
|
|
2176
2187
|
/**
|
|
2177
2188
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2178
2189
|
*
|
|
2179
|
-
* @param {
|
|
2180
|
-
* @param {
|
|
2190
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2191
|
+
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2181
2192
|
* @param {string} params.subject - Subject of the email template. Can be up to 255 characters.
|
|
2182
2193
|
* @param {string} params.message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
2183
2194
|
* @param {string} params.senderName - Name of the email sender.
|
|
2184
|
-
* @param {string} params.senderEmail - Email of the sender.
|
|
2185
|
-
* @param {string} params.replyToEmail - Reply to email.
|
|
2195
|
+
* @param {string} params.senderEmail - Email of the sender. Pass an empty string to clear a previously set value.
|
|
2196
|
+
* @param {string} params.replyToEmail - Reply to email. Pass an empty string to clear a previously set value.
|
|
2186
2197
|
* @param {string} params.replyToName - Reply to name.
|
|
2187
2198
|
* @throws {AppwriteException}
|
|
2188
2199
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2189
2200
|
*/
|
|
2190
2201
|
updateEmailTemplate(params: {
|
|
2191
|
-
templateId:
|
|
2192
|
-
locale?:
|
|
2202
|
+
templateId: ProjectEmailTemplateId;
|
|
2203
|
+
locale?: ProjectEmailTemplateLocale;
|
|
2193
2204
|
subject?: string;
|
|
2194
2205
|
message?: string;
|
|
2195
2206
|
senderName?: string;
|
|
@@ -2200,41 +2211,41 @@ export declare class Project {
|
|
|
2200
2211
|
/**
|
|
2201
2212
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2202
2213
|
*
|
|
2203
|
-
* @param {
|
|
2204
|
-
* @param {
|
|
2214
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2215
|
+
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2205
2216
|
* @param {string} subject - Subject of the email template. Can be up to 255 characters.
|
|
2206
2217
|
* @param {string} message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
2207
2218
|
* @param {string} senderName - Name of the email sender.
|
|
2208
|
-
* @param {string} senderEmail - Email of the sender.
|
|
2209
|
-
* @param {string} replyToEmail - Reply to email.
|
|
2219
|
+
* @param {string} senderEmail - Email of the sender. Pass an empty string to clear a previously set value.
|
|
2220
|
+
* @param {string} replyToEmail - Reply to email. Pass an empty string to clear a previously set value.
|
|
2210
2221
|
* @param {string} replyToName - Reply to name.
|
|
2211
2222
|
* @throws {AppwriteException}
|
|
2212
2223
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2213
2224
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2214
2225
|
*/
|
|
2215
|
-
updateEmailTemplate(templateId:
|
|
2226
|
+
updateEmailTemplate(templateId: ProjectEmailTemplateId, locale?: ProjectEmailTemplateLocale, subject?: string, message?: string, senderName?: string, senderEmail?: string, replyToEmail?: string, replyToName?: string): Promise<Models.EmailTemplate>;
|
|
2216
2227
|
/**
|
|
2217
2228
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2218
2229
|
*
|
|
2219
|
-
* @param {
|
|
2220
|
-
* @param {
|
|
2230
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2231
|
+
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2221
2232
|
* @throws {AppwriteException}
|
|
2222
2233
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2223
2234
|
*/
|
|
2224
2235
|
getEmailTemplate(params: {
|
|
2225
|
-
templateId:
|
|
2226
|
-
locale?:
|
|
2236
|
+
templateId: ProjectEmailTemplateId;
|
|
2237
|
+
locale?: ProjectEmailTemplateLocale;
|
|
2227
2238
|
}): Promise<Models.EmailTemplate>;
|
|
2228
2239
|
/**
|
|
2229
2240
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2230
2241
|
*
|
|
2231
|
-
* @param {
|
|
2232
|
-
* @param {
|
|
2242
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2243
|
+
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2233
2244
|
* @throws {AppwriteException}
|
|
2234
2245
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2235
2246
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2236
2247
|
*/
|
|
2237
|
-
getEmailTemplate(templateId:
|
|
2248
|
+
getEmailTemplate(templateId: ProjectEmailTemplateId, locale?: ProjectEmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
2238
2249
|
/**
|
|
2239
2250
|
* 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.
|
|
2240
2251
|
*
|