@appwrite.io/console 11.0.0 → 12.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 +2337 -369
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +2337 -370
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +2337 -369
- package/package.json +1 -1
- package/types/client.d.ts +23 -2
- package/types/enums/appwrite-migration-resource.d.ts +2 -1
- package/types/enums/build-runtime.d.ts +1 -0
- package/types/enums/{auth-method.d.ts → method-id.d.ts} +1 -1
- package/types/enums/o-auth-provider.d.ts +3 -0
- package/types/enums/policy-id.d.ts +11 -0
- package/types/enums/query-suggestion-resource.d.ts +74 -0
- package/types/enums/resource-type.d.ts +9 -0
- package/types/enums/runtime.d.ts +1 -0
- package/types/enums/runtimes.d.ts +1 -0
- package/types/enums/scopes.d.ts +46 -35
- package/types/index.d.ts +5 -2
- package/types/models.d.ts +1560 -150
- package/types/services/account.d.ts +4 -4
- package/types/services/console.d.ts +45 -0
- package/types/services/domains.d.ts +8 -8
- package/types/services/manager.d.ts +110 -0
- package/types/services/organizations.d.ts +30 -0
- package/types/services/project.d.ts +1459 -110
- package/types/services/projects.d.ts +0 -125
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { MethodId } from '../enums/method-id';
|
|
3
4
|
import { Scopes } from '../enums/scopes';
|
|
5
|
+
import { PolicyId } from '../enums/policy-id';
|
|
4
6
|
import { ProtocolId } from '../enums/protocol-id';
|
|
5
7
|
import { ServiceId } from '../enums/service-id';
|
|
6
8
|
import { Secure } from '../enums/secure';
|
|
@@ -10,198 +12,1482 @@ import { ProjectUsageRange } from '../enums/project-usage-range';
|
|
|
10
12
|
export declare class Project {
|
|
11
13
|
client: Client;
|
|
12
14
|
constructor(client: Client);
|
|
15
|
+
/**
|
|
16
|
+
* Delete a project.
|
|
17
|
+
*
|
|
18
|
+
* @throws {AppwriteException}
|
|
19
|
+
* @returns {Promise<{}>}
|
|
20
|
+
*/
|
|
21
|
+
delete(): Promise<{}>;
|
|
22
|
+
/**
|
|
23
|
+
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
24
|
+
*
|
|
25
|
+
* @param {MethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
26
|
+
* @param {boolean} params.enabled - Auth method status.
|
|
27
|
+
* @throws {AppwriteException}
|
|
28
|
+
* @returns {Promise<Models.Project>}
|
|
29
|
+
*/
|
|
30
|
+
updateAuthMethod(params: {
|
|
31
|
+
methodId: MethodId;
|
|
32
|
+
enabled: boolean;
|
|
33
|
+
}): Promise<Models.Project>;
|
|
34
|
+
/**
|
|
35
|
+
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
36
|
+
*
|
|
37
|
+
* @param {MethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
38
|
+
* @param {boolean} enabled - Auth method status.
|
|
39
|
+
* @throws {AppwriteException}
|
|
40
|
+
* @returns {Promise<Models.Project>}
|
|
41
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
42
|
+
*/
|
|
43
|
+
updateAuthMethod(methodId: MethodId, enabled: boolean): Promise<Models.Project>;
|
|
44
|
+
/**
|
|
45
|
+
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
46
|
+
*
|
|
47
|
+
* @param {boolean} params.enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
48
|
+
* @throws {AppwriteException}
|
|
49
|
+
* @returns {Promise<Models.Project>}
|
|
50
|
+
*/
|
|
51
|
+
updateCanonicalEmails(params: {
|
|
52
|
+
enabled: boolean;
|
|
53
|
+
}): Promise<Models.Project>;
|
|
13
54
|
/**
|
|
14
55
|
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
15
56
|
*
|
|
16
|
-
* @param {boolean}
|
|
57
|
+
* @param {boolean} enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
58
|
+
* @throws {AppwriteException}
|
|
59
|
+
* @returns {Promise<Models.Project>}
|
|
60
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
61
|
+
*/
|
|
62
|
+
updateCanonicalEmails(enabled: boolean): Promise<Models.Project>;
|
|
63
|
+
/**
|
|
64
|
+
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
65
|
+
*
|
|
66
|
+
* @param {boolean} params.enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
67
|
+
* @throws {AppwriteException}
|
|
68
|
+
* @returns {Promise<Models.Project>}
|
|
69
|
+
*/
|
|
70
|
+
updateDisposableEmails(params: {
|
|
71
|
+
enabled: boolean;
|
|
72
|
+
}): Promise<Models.Project>;
|
|
73
|
+
/**
|
|
74
|
+
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
75
|
+
*
|
|
76
|
+
* @param {boolean} enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
77
|
+
* @throws {AppwriteException}
|
|
78
|
+
* @returns {Promise<Models.Project>}
|
|
79
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
80
|
+
*/
|
|
81
|
+
updateDisposableEmails(enabled: boolean): Promise<Models.Project>;
|
|
82
|
+
/**
|
|
83
|
+
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
84
|
+
*
|
|
85
|
+
* @param {boolean} params.enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
86
|
+
* @throws {AppwriteException}
|
|
87
|
+
* @returns {Promise<Models.Project>}
|
|
88
|
+
*/
|
|
89
|
+
updateFreeEmails(params: {
|
|
90
|
+
enabled: boolean;
|
|
91
|
+
}): Promise<Models.Project>;
|
|
92
|
+
/**
|
|
93
|
+
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
94
|
+
*
|
|
95
|
+
* @param {boolean} enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
96
|
+
* @throws {AppwriteException}
|
|
97
|
+
* @returns {Promise<Models.Project>}
|
|
98
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
99
|
+
*/
|
|
100
|
+
updateFreeEmails(enabled: boolean): Promise<Models.Project>;
|
|
101
|
+
/**
|
|
102
|
+
* Get a list of all API keys from the current project.
|
|
103
|
+
*
|
|
104
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes
|
|
105
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
106
|
+
* @throws {AppwriteException}
|
|
107
|
+
* @returns {Promise<Models.KeyList>}
|
|
108
|
+
*/
|
|
109
|
+
listKeys(params?: {
|
|
110
|
+
queries?: string[];
|
|
111
|
+
total?: boolean;
|
|
112
|
+
}): Promise<Models.KeyList>;
|
|
113
|
+
/**
|
|
114
|
+
* Get a list of all API keys from the current project.
|
|
115
|
+
*
|
|
116
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes
|
|
117
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
118
|
+
* @throws {AppwriteException}
|
|
119
|
+
* @returns {Promise<Models.KeyList>}
|
|
120
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
121
|
+
*/
|
|
122
|
+
listKeys(queries?: string[], total?: boolean): Promise<Models.KeyList>;
|
|
123
|
+
/**
|
|
124
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
125
|
+
*
|
|
126
|
+
* You can also create an ephemeral API key if you need a short-lived key instead.
|
|
127
|
+
*
|
|
128
|
+
* @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.
|
|
129
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
130
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
131
|
+
* @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.
|
|
132
|
+
* @throws {AppwriteException}
|
|
133
|
+
* @returns {Promise<Models.Key>}
|
|
134
|
+
*/
|
|
135
|
+
createKey(params: {
|
|
136
|
+
keyId: string;
|
|
137
|
+
name: string;
|
|
138
|
+
scopes: Scopes[];
|
|
139
|
+
expire?: string;
|
|
140
|
+
}): Promise<Models.Key>;
|
|
141
|
+
/**
|
|
142
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
143
|
+
*
|
|
144
|
+
* You can also create an ephemeral API key if you need a short-lived key instead.
|
|
145
|
+
*
|
|
146
|
+
* @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.
|
|
147
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
148
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
149
|
+
* @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.
|
|
150
|
+
* @throws {AppwriteException}
|
|
151
|
+
* @returns {Promise<Models.Key>}
|
|
152
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
153
|
+
*/
|
|
154
|
+
createKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
155
|
+
/**
|
|
156
|
+
* Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
157
|
+
*
|
|
158
|
+
* You can also create a standard API key if you need a longer-lived key instead.
|
|
159
|
+
*
|
|
160
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
161
|
+
* @param {number} params.duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
162
|
+
* @throws {AppwriteException}
|
|
163
|
+
* @returns {Promise<Models.EphemeralKey>}
|
|
164
|
+
*/
|
|
165
|
+
createEphemeralKey(params: {
|
|
166
|
+
scopes: Scopes[];
|
|
167
|
+
duration: number;
|
|
168
|
+
}): Promise<Models.EphemeralKey>;
|
|
169
|
+
/**
|
|
170
|
+
* Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
171
|
+
*
|
|
172
|
+
* You can also create a standard API key if you need a longer-lived key instead.
|
|
173
|
+
*
|
|
174
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
175
|
+
* @param {number} duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
176
|
+
* @throws {AppwriteException}
|
|
177
|
+
* @returns {Promise<Models.EphemeralKey>}
|
|
178
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
179
|
+
*/
|
|
180
|
+
createEphemeralKey(scopes: Scopes[], duration: number): Promise<Models.EphemeralKey>;
|
|
181
|
+
/**
|
|
182
|
+
* Get a key by its unique ID.
|
|
183
|
+
*
|
|
184
|
+
* @param {string} params.keyId - Key ID.
|
|
185
|
+
* @throws {AppwriteException}
|
|
186
|
+
* @returns {Promise<Models.Key>}
|
|
187
|
+
*/
|
|
188
|
+
getKey(params: {
|
|
189
|
+
keyId: string;
|
|
190
|
+
}): Promise<Models.Key>;
|
|
191
|
+
/**
|
|
192
|
+
* Get a key by its unique ID.
|
|
193
|
+
*
|
|
194
|
+
* @param {string} keyId - Key ID.
|
|
195
|
+
* @throws {AppwriteException}
|
|
196
|
+
* @returns {Promise<Models.Key>}
|
|
197
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
198
|
+
*/
|
|
199
|
+
getKey(keyId: string): Promise<Models.Key>;
|
|
200
|
+
/**
|
|
201
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
202
|
+
*
|
|
203
|
+
* @param {string} params.keyId - Key ID.
|
|
204
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
205
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
206
|
+
* @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.
|
|
207
|
+
* @throws {AppwriteException}
|
|
208
|
+
* @returns {Promise<Models.Key>}
|
|
209
|
+
*/
|
|
210
|
+
updateKey(params: {
|
|
211
|
+
keyId: string;
|
|
212
|
+
name: string;
|
|
213
|
+
scopes: Scopes[];
|
|
214
|
+
expire?: string;
|
|
215
|
+
}): Promise<Models.Key>;
|
|
216
|
+
/**
|
|
217
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
218
|
+
*
|
|
219
|
+
* @param {string} keyId - Key ID.
|
|
220
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
221
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
222
|
+
* @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.
|
|
223
|
+
* @throws {AppwriteException}
|
|
224
|
+
* @returns {Promise<Models.Key>}
|
|
225
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
226
|
+
*/
|
|
227
|
+
updateKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
228
|
+
/**
|
|
229
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
230
|
+
*
|
|
231
|
+
* @param {string} params.keyId - Key ID.
|
|
232
|
+
* @throws {AppwriteException}
|
|
233
|
+
* @returns {Promise<{}>}
|
|
234
|
+
*/
|
|
235
|
+
deleteKey(params: {
|
|
236
|
+
keyId: string;
|
|
237
|
+
}): Promise<{}>;
|
|
238
|
+
/**
|
|
239
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
240
|
+
*
|
|
241
|
+
* @param {string} keyId - Key ID.
|
|
242
|
+
* @throws {AppwriteException}
|
|
243
|
+
* @returns {Promise<{}>}
|
|
244
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
245
|
+
*/
|
|
246
|
+
deleteKey(keyId: string): Promise<{}>;
|
|
247
|
+
/**
|
|
248
|
+
* Update the project labels. Labels can be used to easily filter projects in an organization.
|
|
249
|
+
*
|
|
250
|
+
* @param {string[]} params.labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
251
|
+
* @throws {AppwriteException}
|
|
252
|
+
* @returns {Promise<Models.Project>}
|
|
253
|
+
*/
|
|
254
|
+
updateLabels(params: {
|
|
255
|
+
labels: string[];
|
|
256
|
+
}): Promise<Models.Project>;
|
|
257
|
+
/**
|
|
258
|
+
* Update the project labels. Labels can be used to easily filter projects in an organization.
|
|
259
|
+
*
|
|
260
|
+
* @param {string[]} labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
261
|
+
* @throws {AppwriteException}
|
|
262
|
+
* @returns {Promise<Models.Project>}
|
|
263
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
264
|
+
*/
|
|
265
|
+
updateLabels(labels: string[]): Promise<Models.Project>;
|
|
266
|
+
/**
|
|
267
|
+
* Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.
|
|
268
|
+
*
|
|
269
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
270
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
271
|
+
* @throws {AppwriteException}
|
|
272
|
+
* @returns {Promise<Models.MockNumberList>}
|
|
273
|
+
*/
|
|
274
|
+
listMockPhones(params?: {
|
|
275
|
+
queries?: string[];
|
|
276
|
+
total?: boolean;
|
|
277
|
+
}): Promise<Models.MockNumberList>;
|
|
278
|
+
/**
|
|
279
|
+
* Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.
|
|
280
|
+
*
|
|
281
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
282
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
283
|
+
* @throws {AppwriteException}
|
|
284
|
+
* @returns {Promise<Models.MockNumberList>}
|
|
285
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
286
|
+
*/
|
|
287
|
+
listMockPhones(queries?: string[], total?: boolean): Promise<Models.MockNumberList>;
|
|
288
|
+
/**
|
|
289
|
+
* Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.
|
|
290
|
+
*
|
|
291
|
+
* @param {string} params.number - Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.
|
|
292
|
+
* @param {string} params.otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
293
|
+
* @throws {AppwriteException}
|
|
294
|
+
* @returns {Promise<Models.MockNumber>}
|
|
295
|
+
*/
|
|
296
|
+
createMockPhone(params: {
|
|
297
|
+
number: string;
|
|
298
|
+
otp: string;
|
|
299
|
+
}): Promise<Models.MockNumber>;
|
|
300
|
+
/**
|
|
301
|
+
* Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.
|
|
302
|
+
*
|
|
303
|
+
* @param {string} number - Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.
|
|
304
|
+
* @param {string} otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
305
|
+
* @throws {AppwriteException}
|
|
306
|
+
* @returns {Promise<Models.MockNumber>}
|
|
307
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
308
|
+
*/
|
|
309
|
+
createMockPhone(number: string, otp: string): Promise<Models.MockNumber>;
|
|
310
|
+
/**
|
|
311
|
+
* Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.
|
|
312
|
+
*
|
|
313
|
+
* @param {string} params.number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
314
|
+
* @throws {AppwriteException}
|
|
315
|
+
* @returns {Promise<Models.MockNumber>}
|
|
316
|
+
*/
|
|
317
|
+
getMockPhone(params: {
|
|
318
|
+
number: string;
|
|
319
|
+
}): Promise<Models.MockNumber>;
|
|
320
|
+
/**
|
|
321
|
+
* Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.
|
|
322
|
+
*
|
|
323
|
+
* @param {string} number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
324
|
+
* @throws {AppwriteException}
|
|
325
|
+
* @returns {Promise<Models.MockNumber>}
|
|
326
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
327
|
+
*/
|
|
328
|
+
getMockPhone(number: string): Promise<Models.MockNumber>;
|
|
329
|
+
/**
|
|
330
|
+
* Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.
|
|
331
|
+
*
|
|
332
|
+
* @param {string} params.number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
333
|
+
* @param {string} params.otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
334
|
+
* @throws {AppwriteException}
|
|
335
|
+
* @returns {Promise<Models.MockNumber>}
|
|
336
|
+
*/
|
|
337
|
+
updateMockPhone(params: {
|
|
338
|
+
number: string;
|
|
339
|
+
otp: string;
|
|
340
|
+
}): Promise<Models.MockNumber>;
|
|
341
|
+
/**
|
|
342
|
+
* Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.
|
|
343
|
+
*
|
|
344
|
+
* @param {string} number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
345
|
+
* @param {string} otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
346
|
+
* @throws {AppwriteException}
|
|
347
|
+
* @returns {Promise<Models.MockNumber>}
|
|
348
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
349
|
+
*/
|
|
350
|
+
updateMockPhone(number: string, otp: string): Promise<Models.MockNumber>;
|
|
351
|
+
/**
|
|
352
|
+
* Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.
|
|
353
|
+
*
|
|
354
|
+
* @param {string} params.number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
355
|
+
* @throws {AppwriteException}
|
|
356
|
+
* @returns {Promise<{}>}
|
|
357
|
+
*/
|
|
358
|
+
deleteMockPhone(params: {
|
|
359
|
+
number: string;
|
|
360
|
+
}): Promise<{}>;
|
|
361
|
+
/**
|
|
362
|
+
* Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.
|
|
363
|
+
*
|
|
364
|
+
* @param {string} number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
365
|
+
* @throws {AppwriteException}
|
|
366
|
+
* @returns {Promise<{}>}
|
|
367
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
368
|
+
*/
|
|
369
|
+
deleteMockPhone(number: string): Promise<{}>;
|
|
370
|
+
/**
|
|
371
|
+
* Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.
|
|
372
|
+
*
|
|
373
|
+
* @throws {AppwriteException}
|
|
374
|
+
* @returns {Promise<Models.OAuth2ProviderList>}
|
|
375
|
+
*/
|
|
376
|
+
listOAuth2Providers(): Promise<Models.OAuth2ProviderList>;
|
|
377
|
+
/**
|
|
378
|
+
* Update the project OAuth2 Amazon configuration.
|
|
379
|
+
*
|
|
380
|
+
* @param {string} params.clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
381
|
+
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
382
|
+
* @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.
|
|
383
|
+
* @throws {AppwriteException}
|
|
384
|
+
* @returns {Promise<Models.OAuth2Amazon>}
|
|
385
|
+
*/
|
|
386
|
+
updateOAuth2Amazon(params?: {
|
|
387
|
+
clientId?: string;
|
|
388
|
+
clientSecret?: string;
|
|
389
|
+
enabled?: boolean;
|
|
390
|
+
}): Promise<Models.OAuth2Amazon>;
|
|
391
|
+
/**
|
|
392
|
+
* Update the project OAuth2 Amazon configuration.
|
|
393
|
+
*
|
|
394
|
+
* @param {string} clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
395
|
+
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
396
|
+
* @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.
|
|
397
|
+
* @throws {AppwriteException}
|
|
398
|
+
* @returns {Promise<Models.OAuth2Amazon>}
|
|
399
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
400
|
+
*/
|
|
401
|
+
updateOAuth2Amazon(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Amazon>;
|
|
402
|
+
/**
|
|
403
|
+
* Update the project OAuth2 Apple configuration.
|
|
404
|
+
*
|
|
405
|
+
* @param {string} params.serviceId - 'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web
|
|
406
|
+
* @param {string} params.keyId - 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
407
|
+
* @param {string} params.teamId - 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
408
|
+
* @param {string} params.p8File - Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
409
|
+
* @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.
|
|
410
|
+
* @throws {AppwriteException}
|
|
411
|
+
* @returns {Promise<Models.OAuth2Apple>}
|
|
412
|
+
*/
|
|
413
|
+
updateOAuth2Apple(params?: {
|
|
414
|
+
serviceId?: string;
|
|
415
|
+
keyId?: string;
|
|
416
|
+
teamId?: string;
|
|
417
|
+
p8File?: string;
|
|
418
|
+
enabled?: boolean;
|
|
419
|
+
}): Promise<Models.OAuth2Apple>;
|
|
420
|
+
/**
|
|
421
|
+
* Update the project OAuth2 Apple configuration.
|
|
422
|
+
*
|
|
423
|
+
* @param {string} serviceId - 'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web
|
|
424
|
+
* @param {string} keyId - 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
425
|
+
* @param {string} teamId - 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
426
|
+
* @param {string} p8File - Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
427
|
+
* @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.
|
|
428
|
+
* @throws {AppwriteException}
|
|
429
|
+
* @returns {Promise<Models.OAuth2Apple>}
|
|
430
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
431
|
+
*/
|
|
432
|
+
updateOAuth2Apple(serviceId?: string, keyId?: string, teamId?: string, p8File?: string, enabled?: boolean): Promise<Models.OAuth2Apple>;
|
|
433
|
+
/**
|
|
434
|
+
* Update the project OAuth2 Auth0 configuration.
|
|
435
|
+
*
|
|
436
|
+
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
437
|
+
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
438
|
+
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
439
|
+
* @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.
|
|
440
|
+
* @throws {AppwriteException}
|
|
441
|
+
* @returns {Promise<Models.OAuth2Auth0>}
|
|
442
|
+
*/
|
|
443
|
+
updateOAuth2Auth0(params?: {
|
|
444
|
+
clientId?: string;
|
|
445
|
+
clientSecret?: string;
|
|
446
|
+
endpoint?: string;
|
|
447
|
+
enabled?: boolean;
|
|
448
|
+
}): Promise<Models.OAuth2Auth0>;
|
|
449
|
+
/**
|
|
450
|
+
* Update the project OAuth2 Auth0 configuration.
|
|
451
|
+
*
|
|
452
|
+
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
453
|
+
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
454
|
+
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
455
|
+
* @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.
|
|
456
|
+
* @throws {AppwriteException}
|
|
457
|
+
* @returns {Promise<Models.OAuth2Auth0>}
|
|
458
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
459
|
+
*/
|
|
460
|
+
updateOAuth2Auth0(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Auth0>;
|
|
461
|
+
/**
|
|
462
|
+
* Update the project OAuth2 Authentik configuration.
|
|
463
|
+
*
|
|
464
|
+
* @param {string} params.clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
465
|
+
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
466
|
+
* @param {string} params.endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
467
|
+
* @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.
|
|
468
|
+
* @throws {AppwriteException}
|
|
469
|
+
* @returns {Promise<Models.OAuth2Authentik>}
|
|
470
|
+
*/
|
|
471
|
+
updateOAuth2Authentik(params?: {
|
|
472
|
+
clientId?: string;
|
|
473
|
+
clientSecret?: string;
|
|
474
|
+
endpoint?: string;
|
|
475
|
+
enabled?: boolean;
|
|
476
|
+
}): Promise<Models.OAuth2Authentik>;
|
|
477
|
+
/**
|
|
478
|
+
* Update the project OAuth2 Authentik configuration.
|
|
479
|
+
*
|
|
480
|
+
* @param {string} clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
481
|
+
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
482
|
+
* @param {string} endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
483
|
+
* @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.
|
|
484
|
+
* @throws {AppwriteException}
|
|
485
|
+
* @returns {Promise<Models.OAuth2Authentik>}
|
|
486
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
487
|
+
*/
|
|
488
|
+
updateOAuth2Authentik(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Authentik>;
|
|
489
|
+
/**
|
|
490
|
+
* Update the project OAuth2 Autodesk configuration.
|
|
491
|
+
*
|
|
492
|
+
* @param {string} params.clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
493
|
+
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
494
|
+
* @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.
|
|
495
|
+
* @throws {AppwriteException}
|
|
496
|
+
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
497
|
+
*/
|
|
498
|
+
updateOAuth2Autodesk(params?: {
|
|
499
|
+
clientId?: string;
|
|
500
|
+
clientSecret?: string;
|
|
501
|
+
enabled?: boolean;
|
|
502
|
+
}): Promise<Models.OAuth2Autodesk>;
|
|
503
|
+
/**
|
|
504
|
+
* Update the project OAuth2 Autodesk configuration.
|
|
505
|
+
*
|
|
506
|
+
* @param {string} clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
507
|
+
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
508
|
+
* @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.
|
|
509
|
+
* @throws {AppwriteException}
|
|
510
|
+
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
511
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
512
|
+
*/
|
|
513
|
+
updateOAuth2Autodesk(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Autodesk>;
|
|
514
|
+
/**
|
|
515
|
+
* Update the project OAuth2 Bitbucket configuration.
|
|
516
|
+
*
|
|
517
|
+
* @param {string} params.key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
518
|
+
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
519
|
+
* @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.
|
|
520
|
+
* @throws {AppwriteException}
|
|
521
|
+
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
522
|
+
*/
|
|
523
|
+
updateOAuth2Bitbucket(params?: {
|
|
524
|
+
key?: string;
|
|
525
|
+
secret?: string;
|
|
526
|
+
enabled?: boolean;
|
|
527
|
+
}): Promise<Models.OAuth2Bitbucket>;
|
|
528
|
+
/**
|
|
529
|
+
* Update the project OAuth2 Bitbucket configuration.
|
|
530
|
+
*
|
|
531
|
+
* @param {string} key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
532
|
+
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
533
|
+
* @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.
|
|
534
|
+
* @throws {AppwriteException}
|
|
535
|
+
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
536
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
537
|
+
*/
|
|
538
|
+
updateOAuth2Bitbucket(key?: string, secret?: string, enabled?: boolean): Promise<Models.OAuth2Bitbucket>;
|
|
539
|
+
/**
|
|
540
|
+
* Update the project OAuth2 Bitly configuration.
|
|
541
|
+
*
|
|
542
|
+
* @param {string} params.clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
543
|
+
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
544
|
+
* @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.
|
|
545
|
+
* @throws {AppwriteException}
|
|
546
|
+
* @returns {Promise<Models.OAuth2Bitly>}
|
|
547
|
+
*/
|
|
548
|
+
updateOAuth2Bitly(params?: {
|
|
549
|
+
clientId?: string;
|
|
550
|
+
clientSecret?: string;
|
|
551
|
+
enabled?: boolean;
|
|
552
|
+
}): Promise<Models.OAuth2Bitly>;
|
|
553
|
+
/**
|
|
554
|
+
* Update the project OAuth2 Bitly configuration.
|
|
555
|
+
*
|
|
556
|
+
* @param {string} clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
557
|
+
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
558
|
+
* @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.
|
|
559
|
+
* @throws {AppwriteException}
|
|
560
|
+
* @returns {Promise<Models.OAuth2Bitly>}
|
|
561
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
562
|
+
*/
|
|
563
|
+
updateOAuth2Bitly(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Bitly>;
|
|
564
|
+
/**
|
|
565
|
+
* Update the project OAuth2 Box configuration.
|
|
566
|
+
*
|
|
567
|
+
* @param {string} params.clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
568
|
+
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
569
|
+
* @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.
|
|
570
|
+
* @throws {AppwriteException}
|
|
571
|
+
* @returns {Promise<Models.OAuth2Box>}
|
|
572
|
+
*/
|
|
573
|
+
updateOAuth2Box(params?: {
|
|
574
|
+
clientId?: string;
|
|
575
|
+
clientSecret?: string;
|
|
576
|
+
enabled?: boolean;
|
|
577
|
+
}): Promise<Models.OAuth2Box>;
|
|
578
|
+
/**
|
|
579
|
+
* Update the project OAuth2 Box configuration.
|
|
580
|
+
*
|
|
581
|
+
* @param {string} clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
582
|
+
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
583
|
+
* @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.
|
|
584
|
+
* @throws {AppwriteException}
|
|
585
|
+
* @returns {Promise<Models.OAuth2Box>}
|
|
586
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
587
|
+
*/
|
|
588
|
+
updateOAuth2Box(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Box>;
|
|
589
|
+
/**
|
|
590
|
+
* Update the project OAuth2 Dailymotion configuration.
|
|
591
|
+
*
|
|
592
|
+
* @param {string} params.apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
593
|
+
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
594
|
+
* @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.
|
|
595
|
+
* @throws {AppwriteException}
|
|
596
|
+
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
597
|
+
*/
|
|
598
|
+
updateOAuth2Dailymotion(params?: {
|
|
599
|
+
apiKey?: string;
|
|
600
|
+
apiSecret?: string;
|
|
601
|
+
enabled?: boolean;
|
|
602
|
+
}): Promise<Models.OAuth2Dailymotion>;
|
|
603
|
+
/**
|
|
604
|
+
* Update the project OAuth2 Dailymotion configuration.
|
|
605
|
+
*
|
|
606
|
+
* @param {string} apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
607
|
+
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
608
|
+
* @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.
|
|
609
|
+
* @throws {AppwriteException}
|
|
610
|
+
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
611
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
612
|
+
*/
|
|
613
|
+
updateOAuth2Dailymotion(apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.OAuth2Dailymotion>;
|
|
614
|
+
/**
|
|
615
|
+
* Update the project OAuth2 Discord configuration.
|
|
616
|
+
*
|
|
617
|
+
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
618
|
+
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
619
|
+
* @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.
|
|
620
|
+
* @throws {AppwriteException}
|
|
621
|
+
* @returns {Promise<Models.OAuth2Discord>}
|
|
622
|
+
*/
|
|
623
|
+
updateOAuth2Discord(params?: {
|
|
624
|
+
clientId?: string;
|
|
625
|
+
clientSecret?: string;
|
|
626
|
+
enabled?: boolean;
|
|
627
|
+
}): Promise<Models.OAuth2Discord>;
|
|
628
|
+
/**
|
|
629
|
+
* Update the project OAuth2 Discord configuration.
|
|
630
|
+
*
|
|
631
|
+
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
632
|
+
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
633
|
+
* @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.
|
|
634
|
+
* @throws {AppwriteException}
|
|
635
|
+
* @returns {Promise<Models.OAuth2Discord>}
|
|
636
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
637
|
+
*/
|
|
638
|
+
updateOAuth2Discord(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Discord>;
|
|
639
|
+
/**
|
|
640
|
+
* Update the project OAuth2 Disqus configuration.
|
|
641
|
+
*
|
|
642
|
+
* @param {string} params.publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
643
|
+
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
644
|
+
* @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.
|
|
645
|
+
* @throws {AppwriteException}
|
|
646
|
+
* @returns {Promise<Models.OAuth2Disqus>}
|
|
647
|
+
*/
|
|
648
|
+
updateOAuth2Disqus(params?: {
|
|
649
|
+
publicKey?: string;
|
|
650
|
+
secretKey?: string;
|
|
651
|
+
enabled?: boolean;
|
|
652
|
+
}): Promise<Models.OAuth2Disqus>;
|
|
653
|
+
/**
|
|
654
|
+
* Update the project OAuth2 Disqus configuration.
|
|
655
|
+
*
|
|
656
|
+
* @param {string} publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
657
|
+
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
658
|
+
* @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.
|
|
659
|
+
* @throws {AppwriteException}
|
|
660
|
+
* @returns {Promise<Models.OAuth2Disqus>}
|
|
661
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
662
|
+
*/
|
|
663
|
+
updateOAuth2Disqus(publicKey?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2Disqus>;
|
|
664
|
+
/**
|
|
665
|
+
* Update the project OAuth2 Dropbox configuration.
|
|
666
|
+
*
|
|
667
|
+
* @param {string} params.appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
668
|
+
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
669
|
+
* @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.
|
|
670
|
+
* @throws {AppwriteException}
|
|
671
|
+
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
672
|
+
*/
|
|
673
|
+
updateOAuth2Dropbox(params?: {
|
|
674
|
+
appKey?: string;
|
|
675
|
+
appSecret?: string;
|
|
676
|
+
enabled?: boolean;
|
|
677
|
+
}): Promise<Models.OAuth2Dropbox>;
|
|
678
|
+
/**
|
|
679
|
+
* Update the project OAuth2 Dropbox configuration.
|
|
680
|
+
*
|
|
681
|
+
* @param {string} appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
682
|
+
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
683
|
+
* @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.
|
|
684
|
+
* @throws {AppwriteException}
|
|
685
|
+
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
686
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
687
|
+
*/
|
|
688
|
+
updateOAuth2Dropbox(appKey?: string, appSecret?: string, enabled?: boolean): Promise<Models.OAuth2Dropbox>;
|
|
689
|
+
/**
|
|
690
|
+
* Update the project OAuth2 Etsy configuration.
|
|
691
|
+
*
|
|
692
|
+
* @param {string} params.keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
693
|
+
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
694
|
+
* @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.
|
|
695
|
+
* @throws {AppwriteException}
|
|
696
|
+
* @returns {Promise<Models.OAuth2Etsy>}
|
|
697
|
+
*/
|
|
698
|
+
updateOAuth2Etsy(params?: {
|
|
699
|
+
keyString?: string;
|
|
700
|
+
sharedSecret?: string;
|
|
701
|
+
enabled?: boolean;
|
|
702
|
+
}): Promise<Models.OAuth2Etsy>;
|
|
703
|
+
/**
|
|
704
|
+
* Update the project OAuth2 Etsy configuration.
|
|
705
|
+
*
|
|
706
|
+
* @param {string} keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
707
|
+
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
708
|
+
* @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.
|
|
709
|
+
* @throws {AppwriteException}
|
|
710
|
+
* @returns {Promise<Models.OAuth2Etsy>}
|
|
711
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
712
|
+
*/
|
|
713
|
+
updateOAuth2Etsy(keyString?: string, sharedSecret?: string, enabled?: boolean): Promise<Models.OAuth2Etsy>;
|
|
714
|
+
/**
|
|
715
|
+
* Update the project OAuth2 Facebook configuration.
|
|
716
|
+
*
|
|
717
|
+
* @param {string} params.appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
718
|
+
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
719
|
+
* @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.
|
|
720
|
+
* @throws {AppwriteException}
|
|
721
|
+
* @returns {Promise<Models.OAuth2Facebook>}
|
|
722
|
+
*/
|
|
723
|
+
updateOAuth2Facebook(params?: {
|
|
724
|
+
appId?: string;
|
|
725
|
+
appSecret?: string;
|
|
726
|
+
enabled?: boolean;
|
|
727
|
+
}): Promise<Models.OAuth2Facebook>;
|
|
728
|
+
/**
|
|
729
|
+
* Update the project OAuth2 Facebook configuration.
|
|
730
|
+
*
|
|
731
|
+
* @param {string} appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
732
|
+
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
733
|
+
* @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.
|
|
734
|
+
* @throws {AppwriteException}
|
|
735
|
+
* @returns {Promise<Models.OAuth2Facebook>}
|
|
736
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
737
|
+
*/
|
|
738
|
+
updateOAuth2Facebook(appId?: string, appSecret?: string, enabled?: boolean): Promise<Models.OAuth2Facebook>;
|
|
739
|
+
/**
|
|
740
|
+
* Update the project OAuth2 Figma configuration.
|
|
741
|
+
*
|
|
742
|
+
* @param {string} params.clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
743
|
+
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
744
|
+
* @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.
|
|
745
|
+
* @throws {AppwriteException}
|
|
746
|
+
* @returns {Promise<Models.OAuth2Figma>}
|
|
747
|
+
*/
|
|
748
|
+
updateOAuth2Figma(params?: {
|
|
749
|
+
clientId?: string;
|
|
750
|
+
clientSecret?: string;
|
|
751
|
+
enabled?: boolean;
|
|
752
|
+
}): Promise<Models.OAuth2Figma>;
|
|
753
|
+
/**
|
|
754
|
+
* Update the project OAuth2 Figma configuration.
|
|
755
|
+
*
|
|
756
|
+
* @param {string} clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
757
|
+
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
758
|
+
* @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.
|
|
759
|
+
* @throws {AppwriteException}
|
|
760
|
+
* @returns {Promise<Models.OAuth2Figma>}
|
|
761
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
762
|
+
*/
|
|
763
|
+
updateOAuth2Figma(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Figma>;
|
|
764
|
+
/**
|
|
765
|
+
* Update the project OAuth2 FusionAuth configuration.
|
|
766
|
+
*
|
|
767
|
+
* @param {string} params.clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
768
|
+
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
769
|
+
* @param {string} params.endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
770
|
+
* @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.
|
|
771
|
+
* @throws {AppwriteException}
|
|
772
|
+
* @returns {Promise<Models.OAuth2FusionAuth>}
|
|
773
|
+
*/
|
|
774
|
+
updateOAuth2FusionAuth(params?: {
|
|
775
|
+
clientId?: string;
|
|
776
|
+
clientSecret?: string;
|
|
777
|
+
endpoint?: string;
|
|
778
|
+
enabled?: boolean;
|
|
779
|
+
}): Promise<Models.OAuth2FusionAuth>;
|
|
780
|
+
/**
|
|
781
|
+
* Update the project OAuth2 FusionAuth configuration.
|
|
782
|
+
*
|
|
783
|
+
* @param {string} clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
784
|
+
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
785
|
+
* @param {string} endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
786
|
+
* @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.
|
|
787
|
+
* @throws {AppwriteException}
|
|
788
|
+
* @returns {Promise<Models.OAuth2FusionAuth>}
|
|
789
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
790
|
+
*/
|
|
791
|
+
updateOAuth2FusionAuth(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2FusionAuth>;
|
|
792
|
+
/**
|
|
793
|
+
* Update the project OAuth2 GitHub configuration.
|
|
794
|
+
*
|
|
795
|
+
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
796
|
+
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
797
|
+
* @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.
|
|
798
|
+
* @throws {AppwriteException}
|
|
799
|
+
* @returns {Promise<Models.OAuth2Github>}
|
|
800
|
+
*/
|
|
801
|
+
updateOAuth2GitHub(params?: {
|
|
802
|
+
clientId?: string;
|
|
803
|
+
clientSecret?: string;
|
|
804
|
+
enabled?: boolean;
|
|
805
|
+
}): Promise<Models.OAuth2Github>;
|
|
806
|
+
/**
|
|
807
|
+
* Update the project OAuth2 GitHub configuration.
|
|
808
|
+
*
|
|
809
|
+
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
810
|
+
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
811
|
+
* @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.
|
|
812
|
+
* @throws {AppwriteException}
|
|
813
|
+
* @returns {Promise<Models.OAuth2Github>}
|
|
814
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
815
|
+
*/
|
|
816
|
+
updateOAuth2GitHub(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Github>;
|
|
817
|
+
/**
|
|
818
|
+
* Update the project OAuth2 Gitlab configuration.
|
|
819
|
+
*
|
|
820
|
+
* @param {string} params.applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
821
|
+
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
822
|
+
* @param {string} params.endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
823
|
+
* @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.
|
|
824
|
+
* @throws {AppwriteException}
|
|
825
|
+
* @returns {Promise<Models.OAuth2Gitlab>}
|
|
826
|
+
*/
|
|
827
|
+
updateOAuth2Gitlab(params?: {
|
|
828
|
+
applicationId?: string;
|
|
829
|
+
secret?: string;
|
|
830
|
+
endpoint?: string;
|
|
831
|
+
enabled?: boolean;
|
|
832
|
+
}): Promise<Models.OAuth2Gitlab>;
|
|
833
|
+
/**
|
|
834
|
+
* Update the project OAuth2 Gitlab configuration.
|
|
835
|
+
*
|
|
836
|
+
* @param {string} applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
837
|
+
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
838
|
+
* @param {string} endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
839
|
+
* @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.
|
|
840
|
+
* @throws {AppwriteException}
|
|
841
|
+
* @returns {Promise<Models.OAuth2Gitlab>}
|
|
842
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
843
|
+
*/
|
|
844
|
+
updateOAuth2Gitlab(applicationId?: string, secret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Gitlab>;
|
|
845
|
+
/**
|
|
846
|
+
* Update the project OAuth2 Google configuration.
|
|
847
|
+
*
|
|
848
|
+
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
849
|
+
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
850
|
+
* @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.
|
|
851
|
+
* @throws {AppwriteException}
|
|
852
|
+
* @returns {Promise<Models.OAuth2Google>}
|
|
853
|
+
*/
|
|
854
|
+
updateOAuth2Google(params?: {
|
|
855
|
+
clientId?: string;
|
|
856
|
+
clientSecret?: string;
|
|
857
|
+
enabled?: boolean;
|
|
858
|
+
}): Promise<Models.OAuth2Google>;
|
|
859
|
+
/**
|
|
860
|
+
* Update the project OAuth2 Google configuration.
|
|
861
|
+
*
|
|
862
|
+
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
863
|
+
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
864
|
+
* @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.
|
|
865
|
+
* @throws {AppwriteException}
|
|
866
|
+
* @returns {Promise<Models.OAuth2Google>}
|
|
867
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
868
|
+
*/
|
|
869
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
870
|
+
/**
|
|
871
|
+
* Update the project OAuth2 Keycloak configuration.
|
|
872
|
+
*
|
|
873
|
+
* @param {string} params.clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
874
|
+
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
875
|
+
* @param {string} params.endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
876
|
+
* @param {string} params.realmName - Keycloak realm name. For example: appwrite-realm
|
|
877
|
+
* @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.
|
|
878
|
+
* @throws {AppwriteException}
|
|
879
|
+
* @returns {Promise<Models.OAuth2Keycloak>}
|
|
880
|
+
*/
|
|
881
|
+
updateOAuth2Keycloak(params?: {
|
|
882
|
+
clientId?: string;
|
|
883
|
+
clientSecret?: string;
|
|
884
|
+
endpoint?: string;
|
|
885
|
+
realmName?: string;
|
|
886
|
+
enabled?: boolean;
|
|
887
|
+
}): Promise<Models.OAuth2Keycloak>;
|
|
888
|
+
/**
|
|
889
|
+
* Update the project OAuth2 Keycloak configuration.
|
|
890
|
+
*
|
|
891
|
+
* @param {string} clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
892
|
+
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
893
|
+
* @param {string} endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
894
|
+
* @param {string} realmName - Keycloak realm name. For example: appwrite-realm
|
|
895
|
+
* @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.
|
|
896
|
+
* @throws {AppwriteException}
|
|
897
|
+
* @returns {Promise<Models.OAuth2Keycloak>}
|
|
898
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
899
|
+
*/
|
|
900
|
+
updateOAuth2Keycloak(clientId?: string, clientSecret?: string, endpoint?: string, realmName?: string, enabled?: boolean): Promise<Models.OAuth2Keycloak>;
|
|
901
|
+
/**
|
|
902
|
+
* Update the project OAuth2 Kick configuration.
|
|
903
|
+
*
|
|
904
|
+
* @param {string} params.clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
905
|
+
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
906
|
+
* @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.
|
|
907
|
+
* @throws {AppwriteException}
|
|
908
|
+
* @returns {Promise<Models.OAuth2Kick>}
|
|
909
|
+
*/
|
|
910
|
+
updateOAuth2Kick(params?: {
|
|
911
|
+
clientId?: string;
|
|
912
|
+
clientSecret?: string;
|
|
913
|
+
enabled?: boolean;
|
|
914
|
+
}): Promise<Models.OAuth2Kick>;
|
|
915
|
+
/**
|
|
916
|
+
* Update the project OAuth2 Kick configuration.
|
|
917
|
+
*
|
|
918
|
+
* @param {string} clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
919
|
+
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
920
|
+
* @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.
|
|
921
|
+
* @throws {AppwriteException}
|
|
922
|
+
* @returns {Promise<Models.OAuth2Kick>}
|
|
923
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
924
|
+
*/
|
|
925
|
+
updateOAuth2Kick(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Kick>;
|
|
926
|
+
/**
|
|
927
|
+
* Update the project OAuth2 Linkedin configuration.
|
|
928
|
+
*
|
|
929
|
+
* @param {string} params.clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
930
|
+
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
931
|
+
* @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.
|
|
932
|
+
* @throws {AppwriteException}
|
|
933
|
+
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
934
|
+
*/
|
|
935
|
+
updateOAuth2Linkedin(params?: {
|
|
936
|
+
clientId?: string;
|
|
937
|
+
primaryClientSecret?: string;
|
|
938
|
+
enabled?: boolean;
|
|
939
|
+
}): Promise<Models.OAuth2Linkedin>;
|
|
940
|
+
/**
|
|
941
|
+
* Update the project OAuth2 Linkedin configuration.
|
|
942
|
+
*
|
|
943
|
+
* @param {string} clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
944
|
+
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
945
|
+
* @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.
|
|
946
|
+
* @throws {AppwriteException}
|
|
947
|
+
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
948
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
949
|
+
*/
|
|
950
|
+
updateOAuth2Linkedin(clientId?: string, primaryClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Linkedin>;
|
|
951
|
+
/**
|
|
952
|
+
* Update the project OAuth2 Microsoft configuration.
|
|
953
|
+
*
|
|
954
|
+
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
955
|
+
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
956
|
+
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
957
|
+
* @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.
|
|
958
|
+
* @throws {AppwriteException}
|
|
959
|
+
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
960
|
+
*/
|
|
961
|
+
updateOAuth2Microsoft(params?: {
|
|
962
|
+
applicationId?: string;
|
|
963
|
+
applicationSecret?: string;
|
|
964
|
+
tenant?: string;
|
|
965
|
+
enabled?: boolean;
|
|
966
|
+
}): Promise<Models.OAuth2Microsoft>;
|
|
967
|
+
/**
|
|
968
|
+
* Update the project OAuth2 Microsoft configuration.
|
|
969
|
+
*
|
|
970
|
+
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
971
|
+
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
972
|
+
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
973
|
+
* @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.
|
|
974
|
+
* @throws {AppwriteException}
|
|
975
|
+
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
976
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
977
|
+
*/
|
|
978
|
+
updateOAuth2Microsoft(applicationId?: string, applicationSecret?: string, tenant?: string, enabled?: boolean): Promise<Models.OAuth2Microsoft>;
|
|
979
|
+
/**
|
|
980
|
+
* Update the project OAuth2 Notion configuration.
|
|
981
|
+
*
|
|
982
|
+
* @param {string} params.oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
983
|
+
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
984
|
+
* @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.
|
|
985
|
+
* @throws {AppwriteException}
|
|
986
|
+
* @returns {Promise<Models.OAuth2Notion>}
|
|
987
|
+
*/
|
|
988
|
+
updateOAuth2Notion(params?: {
|
|
989
|
+
oauthClientId?: string;
|
|
990
|
+
oauthClientSecret?: string;
|
|
991
|
+
enabled?: boolean;
|
|
992
|
+
}): Promise<Models.OAuth2Notion>;
|
|
993
|
+
/**
|
|
994
|
+
* Update the project OAuth2 Notion configuration.
|
|
995
|
+
*
|
|
996
|
+
* @param {string} oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
997
|
+
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
998
|
+
* @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.
|
|
999
|
+
* @throws {AppwriteException}
|
|
1000
|
+
* @returns {Promise<Models.OAuth2Notion>}
|
|
1001
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1002
|
+
*/
|
|
1003
|
+
updateOAuth2Notion(oauthClientId?: string, oauthClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Notion>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Update the project OAuth2 Oidc configuration.
|
|
1006
|
+
*
|
|
1007
|
+
* @param {string} params.clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1008
|
+
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1009
|
+
* @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
|
|
1010
|
+
* @param {string} params.authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1011
|
+
* @param {string} params.tokenUrl - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1012
|
+
* @param {string} params.userInfoUrl - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1013
|
+
* @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.
|
|
17
1014
|
* @throws {AppwriteException}
|
|
18
|
-
* @returns {Promise<Models.
|
|
1015
|
+
* @returns {Promise<Models.OAuth2Oidc>}
|
|
19
1016
|
*/
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
1017
|
+
updateOAuth2Oidc(params?: {
|
|
1018
|
+
clientId?: string;
|
|
1019
|
+
clientSecret?: string;
|
|
1020
|
+
wellKnownURL?: string;
|
|
1021
|
+
authorizationURL?: string;
|
|
1022
|
+
tokenUrl?: string;
|
|
1023
|
+
userInfoUrl?: string;
|
|
1024
|
+
enabled?: boolean;
|
|
1025
|
+
}): Promise<Models.OAuth2Oidc>;
|
|
23
1026
|
/**
|
|
24
|
-
*
|
|
1027
|
+
* Update the project OAuth2 Oidc configuration.
|
|
25
1028
|
*
|
|
26
|
-
* @param {
|
|
1029
|
+
* @param {string} clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1030
|
+
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1031
|
+
* @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
|
|
1032
|
+
* @param {string} authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1033
|
+
* @param {string} tokenUrl - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1034
|
+
* @param {string} userInfoUrl - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1035
|
+
* @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.
|
|
27
1036
|
* @throws {AppwriteException}
|
|
28
|
-
* @returns {Promise<Models.
|
|
1037
|
+
* @returns {Promise<Models.OAuth2Oidc>}
|
|
29
1038
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
30
1039
|
*/
|
|
31
|
-
|
|
1040
|
+
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string, tokenUrl?: string, userInfoUrl?: string, enabled?: boolean): Promise<Models.OAuth2Oidc>;
|
|
32
1041
|
/**
|
|
33
|
-
*
|
|
1042
|
+
* Update the project OAuth2 Okta configuration.
|
|
34
1043
|
*
|
|
35
|
-
* @param {
|
|
1044
|
+
* @param {string} params.clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1045
|
+
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1046
|
+
* @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/
|
|
1047
|
+
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1048
|
+
* @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.
|
|
36
1049
|
* @throws {AppwriteException}
|
|
37
|
-
* @returns {Promise<Models.
|
|
1050
|
+
* @returns {Promise<Models.OAuth2Okta>}
|
|
38
1051
|
*/
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
1052
|
+
updateOAuth2Okta(params?: {
|
|
1053
|
+
clientId?: string;
|
|
1054
|
+
clientSecret?: string;
|
|
1055
|
+
domain?: string;
|
|
1056
|
+
authorizationServerId?: string;
|
|
1057
|
+
enabled?: boolean;
|
|
1058
|
+
}): Promise<Models.OAuth2Okta>;
|
|
42
1059
|
/**
|
|
43
|
-
*
|
|
1060
|
+
* Update the project OAuth2 Okta configuration.
|
|
44
1061
|
*
|
|
45
|
-
* @param {
|
|
1062
|
+
* @param {string} clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1063
|
+
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1064
|
+
* @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/
|
|
1065
|
+
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1066
|
+
* @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.
|
|
46
1067
|
* @throws {AppwriteException}
|
|
47
|
-
* @returns {Promise<Models.
|
|
1068
|
+
* @returns {Promise<Models.OAuth2Okta>}
|
|
48
1069
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
49
1070
|
*/
|
|
50
|
-
|
|
1071
|
+
updateOAuth2Okta(clientId?: string, clientSecret?: string, domain?: string, authorizationServerId?: string, enabled?: boolean): Promise<Models.OAuth2Okta>;
|
|
51
1072
|
/**
|
|
52
|
-
*
|
|
1073
|
+
* Update the project OAuth2 Paypal configuration.
|
|
53
1074
|
*
|
|
54
|
-
* @param {
|
|
1075
|
+
* @param {string} params.clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1076
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1077
|
+
* @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.
|
|
55
1078
|
* @throws {AppwriteException}
|
|
56
|
-
* @returns {Promise<Models.
|
|
1079
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
57
1080
|
*/
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
1081
|
+
updateOAuth2Paypal(params?: {
|
|
1082
|
+
clientId?: string;
|
|
1083
|
+
secretKey?: string;
|
|
1084
|
+
enabled?: boolean;
|
|
1085
|
+
}): Promise<Models.OAuth2Paypal>;
|
|
61
1086
|
/**
|
|
62
|
-
*
|
|
1087
|
+
* Update the project OAuth2 Paypal configuration.
|
|
63
1088
|
*
|
|
64
|
-
* @param {
|
|
1089
|
+
* @param {string} clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1090
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1091
|
+
* @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.
|
|
65
1092
|
* @throws {AppwriteException}
|
|
66
|
-
* @returns {Promise<Models.
|
|
1093
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
67
1094
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
68
1095
|
*/
|
|
69
|
-
|
|
1096
|
+
updateOAuth2Paypal(clientId?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2Paypal>;
|
|
70
1097
|
/**
|
|
71
|
-
*
|
|
1098
|
+
* Update the project OAuth2 PaypalSandbox configuration.
|
|
72
1099
|
*
|
|
73
|
-
* @param {string
|
|
74
|
-
* @param {
|
|
1100
|
+
* @param {string} params.clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1101
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1102
|
+
* @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.
|
|
75
1103
|
* @throws {AppwriteException}
|
|
76
|
-
* @returns {Promise<Models.
|
|
1104
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
77
1105
|
*/
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
1106
|
+
updateOAuth2PaypalSandbox(params?: {
|
|
1107
|
+
clientId?: string;
|
|
1108
|
+
secretKey?: string;
|
|
1109
|
+
enabled?: boolean;
|
|
1110
|
+
}): Promise<Models.OAuth2Paypal>;
|
|
82
1111
|
/**
|
|
83
|
-
*
|
|
1112
|
+
* Update the project OAuth2 PaypalSandbox configuration.
|
|
84
1113
|
*
|
|
85
|
-
* @param {string
|
|
86
|
-
* @param {
|
|
1114
|
+
* @param {string} clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1115
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1116
|
+
* @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.
|
|
87
1117
|
* @throws {AppwriteException}
|
|
88
|
-
* @returns {Promise<Models.
|
|
1118
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
89
1119
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
90
1120
|
*/
|
|
91
|
-
|
|
1121
|
+
updateOAuth2PaypalSandbox(clientId?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2Paypal>;
|
|
92
1122
|
/**
|
|
93
|
-
*
|
|
1123
|
+
* Update the project OAuth2 Podio configuration.
|
|
94
1124
|
*
|
|
95
|
-
* @param {string} params.
|
|
96
|
-
* @param {string} params.
|
|
97
|
-
* @param {
|
|
98
|
-
* @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.
|
|
1125
|
+
* @param {string} params.clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1126
|
+
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1127
|
+
* @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.
|
|
99
1128
|
* @throws {AppwriteException}
|
|
100
|
-
* @returns {Promise<Models.
|
|
1129
|
+
* @returns {Promise<Models.OAuth2Podio>}
|
|
101
1130
|
*/
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
}): Promise<Models.Key>;
|
|
1131
|
+
updateOAuth2Podio(params?: {
|
|
1132
|
+
clientId?: string;
|
|
1133
|
+
clientSecret?: string;
|
|
1134
|
+
enabled?: boolean;
|
|
1135
|
+
}): Promise<Models.OAuth2Podio>;
|
|
108
1136
|
/**
|
|
109
|
-
*
|
|
1137
|
+
* Update the project OAuth2 Podio configuration.
|
|
110
1138
|
*
|
|
111
|
-
* @param {string}
|
|
112
|
-
* @param {string}
|
|
113
|
-
* @param {
|
|
114
|
-
* @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.
|
|
1139
|
+
* @param {string} clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1140
|
+
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1141
|
+
* @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.
|
|
115
1142
|
* @throws {AppwriteException}
|
|
116
|
-
* @returns {Promise<Models.
|
|
1143
|
+
* @returns {Promise<Models.OAuth2Podio>}
|
|
117
1144
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
118
1145
|
*/
|
|
119
|
-
|
|
1146
|
+
updateOAuth2Podio(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Podio>;
|
|
120
1147
|
/**
|
|
121
|
-
*
|
|
1148
|
+
* Update the project OAuth2 Salesforce configuration.
|
|
122
1149
|
*
|
|
123
|
-
* @param {string} params.
|
|
1150
|
+
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1151
|
+
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1152
|
+
* @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.
|
|
124
1153
|
* @throws {AppwriteException}
|
|
125
|
-
* @returns {Promise<Models.
|
|
1154
|
+
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
126
1155
|
*/
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
1156
|
+
updateOAuth2Salesforce(params?: {
|
|
1157
|
+
customerKey?: string;
|
|
1158
|
+
customerSecret?: string;
|
|
1159
|
+
enabled?: boolean;
|
|
1160
|
+
}): Promise<Models.OAuth2Salesforce>;
|
|
130
1161
|
/**
|
|
131
|
-
*
|
|
1162
|
+
* Update the project OAuth2 Salesforce configuration.
|
|
132
1163
|
*
|
|
133
|
-
* @param {string}
|
|
1164
|
+
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1165
|
+
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1166
|
+
* @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.
|
|
134
1167
|
* @throws {AppwriteException}
|
|
135
|
-
* @returns {Promise<Models.
|
|
1168
|
+
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
136
1169
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
137
1170
|
*/
|
|
138
|
-
|
|
1171
|
+
updateOAuth2Salesforce(customerKey?: string, customerSecret?: string, enabled?: boolean): Promise<Models.OAuth2Salesforce>;
|
|
139
1172
|
/**
|
|
140
|
-
* Update
|
|
1173
|
+
* Update the project OAuth2 Slack configuration.
|
|
141
1174
|
*
|
|
142
|
-
* @param {string} params.
|
|
143
|
-
* @param {string} params.
|
|
144
|
-
* @param {
|
|
145
|
-
* @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.
|
|
1175
|
+
* @param {string} params.clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1176
|
+
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1177
|
+
* @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.
|
|
146
1178
|
* @throws {AppwriteException}
|
|
147
|
-
* @returns {Promise<Models.
|
|
1179
|
+
* @returns {Promise<Models.OAuth2Slack>}
|
|
148
1180
|
*/
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
}): Promise<Models.Key>;
|
|
1181
|
+
updateOAuth2Slack(params?: {
|
|
1182
|
+
clientId?: string;
|
|
1183
|
+
clientSecret?: string;
|
|
1184
|
+
enabled?: boolean;
|
|
1185
|
+
}): Promise<Models.OAuth2Slack>;
|
|
155
1186
|
/**
|
|
156
|
-
* Update
|
|
1187
|
+
* Update the project OAuth2 Slack configuration.
|
|
157
1188
|
*
|
|
158
|
-
* @param {string}
|
|
159
|
-
* @param {string}
|
|
160
|
-
* @param {
|
|
161
|
-
* @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.
|
|
1189
|
+
* @param {string} clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1190
|
+
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1191
|
+
* @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.
|
|
162
1192
|
* @throws {AppwriteException}
|
|
163
|
-
* @returns {Promise<Models.
|
|
1193
|
+
* @returns {Promise<Models.OAuth2Slack>}
|
|
164
1194
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
165
1195
|
*/
|
|
166
|
-
|
|
1196
|
+
updateOAuth2Slack(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Slack>;
|
|
167
1197
|
/**
|
|
168
|
-
*
|
|
1198
|
+
* Update the project OAuth2 Spotify configuration.
|
|
169
1199
|
*
|
|
170
|
-
* @param {string} params.
|
|
1200
|
+
* @param {string} params.clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1201
|
+
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1202
|
+
* @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.
|
|
171
1203
|
* @throws {AppwriteException}
|
|
172
|
-
* @returns {Promise<
|
|
1204
|
+
* @returns {Promise<Models.OAuth2Spotify>}
|
|
173
1205
|
*/
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
1206
|
+
updateOAuth2Spotify(params?: {
|
|
1207
|
+
clientId?: string;
|
|
1208
|
+
clientSecret?: string;
|
|
1209
|
+
enabled?: boolean;
|
|
1210
|
+
}): Promise<Models.OAuth2Spotify>;
|
|
177
1211
|
/**
|
|
178
|
-
*
|
|
1212
|
+
* Update the project OAuth2 Spotify configuration.
|
|
179
1213
|
*
|
|
180
|
-
* @param {string}
|
|
1214
|
+
* @param {string} clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1215
|
+
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1216
|
+
* @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.
|
|
181
1217
|
* @throws {AppwriteException}
|
|
182
|
-
* @returns {Promise<
|
|
1218
|
+
* @returns {Promise<Models.OAuth2Spotify>}
|
|
183
1219
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
184
1220
|
*/
|
|
185
|
-
|
|
1221
|
+
updateOAuth2Spotify(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Spotify>;
|
|
186
1222
|
/**
|
|
187
|
-
* Update the project
|
|
1223
|
+
* Update the project OAuth2 Stripe configuration.
|
|
188
1224
|
*
|
|
189
|
-
* @param {string
|
|
1225
|
+
* @param {string} params.clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1226
|
+
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1227
|
+
* @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.
|
|
190
1228
|
* @throws {AppwriteException}
|
|
191
|
-
* @returns {Promise<Models.
|
|
1229
|
+
* @returns {Promise<Models.OAuth2Stripe>}
|
|
192
1230
|
*/
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
1231
|
+
updateOAuth2Stripe(params?: {
|
|
1232
|
+
clientId?: string;
|
|
1233
|
+
apiSecretKey?: string;
|
|
1234
|
+
enabled?: boolean;
|
|
1235
|
+
}): Promise<Models.OAuth2Stripe>;
|
|
196
1236
|
/**
|
|
197
|
-
* Update the project
|
|
1237
|
+
* Update the project OAuth2 Stripe configuration.
|
|
198
1238
|
*
|
|
199
|
-
* @param {string
|
|
1239
|
+
* @param {string} clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1240
|
+
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1241
|
+
* @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.
|
|
200
1242
|
* @throws {AppwriteException}
|
|
201
|
-
* @returns {Promise<Models.
|
|
1243
|
+
* @returns {Promise<Models.OAuth2Stripe>}
|
|
202
1244
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
203
1245
|
*/
|
|
204
|
-
|
|
1246
|
+
updateOAuth2Stripe(clientId?: string, apiSecretKey?: string, enabled?: boolean): Promise<Models.OAuth2Stripe>;
|
|
1247
|
+
/**
|
|
1248
|
+
* Update the project OAuth2 Tradeshift configuration.
|
|
1249
|
+
*
|
|
1250
|
+
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1251
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1252
|
+
* @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.
|
|
1253
|
+
* @throws {AppwriteException}
|
|
1254
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1255
|
+
*/
|
|
1256
|
+
updateOAuth2Tradeshift(params?: {
|
|
1257
|
+
oauth2ClientId?: string;
|
|
1258
|
+
oauth2ClientSecret?: string;
|
|
1259
|
+
enabled?: boolean;
|
|
1260
|
+
}): Promise<Models.OAuth2Tradeshift>;
|
|
1261
|
+
/**
|
|
1262
|
+
* Update the project OAuth2 Tradeshift configuration.
|
|
1263
|
+
*
|
|
1264
|
+
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1265
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1266
|
+
* @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.
|
|
1267
|
+
* @throws {AppwriteException}
|
|
1268
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1269
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1270
|
+
*/
|
|
1271
|
+
updateOAuth2Tradeshift(oauth2ClientId?: string, oauth2ClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Tradeshift>;
|
|
1272
|
+
/**
|
|
1273
|
+
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1274
|
+
*
|
|
1275
|
+
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1276
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1277
|
+
* @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.
|
|
1278
|
+
* @throws {AppwriteException}
|
|
1279
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1280
|
+
*/
|
|
1281
|
+
updateOAuth2TradeshiftSandbox(params?: {
|
|
1282
|
+
oauth2ClientId?: string;
|
|
1283
|
+
oauth2ClientSecret?: string;
|
|
1284
|
+
enabled?: boolean;
|
|
1285
|
+
}): Promise<Models.OAuth2Tradeshift>;
|
|
1286
|
+
/**
|
|
1287
|
+
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1288
|
+
*
|
|
1289
|
+
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1290
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1291
|
+
* @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.
|
|
1292
|
+
* @throws {AppwriteException}
|
|
1293
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1294
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1295
|
+
*/
|
|
1296
|
+
updateOAuth2TradeshiftSandbox(oauth2ClientId?: string, oauth2ClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Tradeshift>;
|
|
1297
|
+
/**
|
|
1298
|
+
* Update the project OAuth2 Twitch configuration.
|
|
1299
|
+
*
|
|
1300
|
+
* @param {string} params.clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1301
|
+
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1302
|
+
* @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.
|
|
1303
|
+
* @throws {AppwriteException}
|
|
1304
|
+
* @returns {Promise<Models.OAuth2Twitch>}
|
|
1305
|
+
*/
|
|
1306
|
+
updateOAuth2Twitch(params?: {
|
|
1307
|
+
clientId?: string;
|
|
1308
|
+
clientSecret?: string;
|
|
1309
|
+
enabled?: boolean;
|
|
1310
|
+
}): Promise<Models.OAuth2Twitch>;
|
|
1311
|
+
/**
|
|
1312
|
+
* Update the project OAuth2 Twitch configuration.
|
|
1313
|
+
*
|
|
1314
|
+
* @param {string} clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1315
|
+
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1316
|
+
* @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.
|
|
1317
|
+
* @throws {AppwriteException}
|
|
1318
|
+
* @returns {Promise<Models.OAuth2Twitch>}
|
|
1319
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1320
|
+
*/
|
|
1321
|
+
updateOAuth2Twitch(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Twitch>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Update the project OAuth2 WordPress configuration.
|
|
1324
|
+
*
|
|
1325
|
+
* @param {string} params.clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1326
|
+
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1327
|
+
* @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.
|
|
1328
|
+
* @throws {AppwriteException}
|
|
1329
|
+
* @returns {Promise<Models.OAuth2WordPress>}
|
|
1330
|
+
*/
|
|
1331
|
+
updateOAuth2WordPress(params?: {
|
|
1332
|
+
clientId?: string;
|
|
1333
|
+
clientSecret?: string;
|
|
1334
|
+
enabled?: boolean;
|
|
1335
|
+
}): Promise<Models.OAuth2WordPress>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Update the project OAuth2 WordPress configuration.
|
|
1338
|
+
*
|
|
1339
|
+
* @param {string} clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1340
|
+
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1341
|
+
* @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.
|
|
1342
|
+
* @throws {AppwriteException}
|
|
1343
|
+
* @returns {Promise<Models.OAuth2WordPress>}
|
|
1344
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1345
|
+
*/
|
|
1346
|
+
updateOAuth2WordPress(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2WordPress>;
|
|
1347
|
+
/**
|
|
1348
|
+
* Update the project OAuth2 X configuration.
|
|
1349
|
+
*
|
|
1350
|
+
* @param {string} params.customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1351
|
+
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1352
|
+
* @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.
|
|
1353
|
+
* @throws {AppwriteException}
|
|
1354
|
+
* @returns {Promise<Models.OAuth2X>}
|
|
1355
|
+
*/
|
|
1356
|
+
updateOAuth2X(params?: {
|
|
1357
|
+
customerKey?: string;
|
|
1358
|
+
secretKey?: string;
|
|
1359
|
+
enabled?: boolean;
|
|
1360
|
+
}): Promise<Models.OAuth2X>;
|
|
1361
|
+
/**
|
|
1362
|
+
* Update the project OAuth2 X configuration.
|
|
1363
|
+
*
|
|
1364
|
+
* @param {string} customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1365
|
+
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1366
|
+
* @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.
|
|
1367
|
+
* @throws {AppwriteException}
|
|
1368
|
+
* @returns {Promise<Models.OAuth2X>}
|
|
1369
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1370
|
+
*/
|
|
1371
|
+
updateOAuth2X(customerKey?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2X>;
|
|
1372
|
+
/**
|
|
1373
|
+
* Update the project OAuth2 Yahoo configuration.
|
|
1374
|
+
*
|
|
1375
|
+
* @param {string} params.clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1376
|
+
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1377
|
+
* @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.
|
|
1378
|
+
* @throws {AppwriteException}
|
|
1379
|
+
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
1380
|
+
*/
|
|
1381
|
+
updateOAuth2Yahoo(params?: {
|
|
1382
|
+
clientId?: string;
|
|
1383
|
+
clientSecret?: string;
|
|
1384
|
+
enabled?: boolean;
|
|
1385
|
+
}): Promise<Models.OAuth2Yahoo>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Update the project OAuth2 Yahoo configuration.
|
|
1388
|
+
*
|
|
1389
|
+
* @param {string} clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1390
|
+
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1391
|
+
* @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.
|
|
1392
|
+
* @throws {AppwriteException}
|
|
1393
|
+
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
1394
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1395
|
+
*/
|
|
1396
|
+
updateOAuth2Yahoo(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Yahoo>;
|
|
1397
|
+
/**
|
|
1398
|
+
* Update the project OAuth2 Yandex configuration.
|
|
1399
|
+
*
|
|
1400
|
+
* @param {string} params.clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1401
|
+
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1402
|
+
* @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.
|
|
1403
|
+
* @throws {AppwriteException}
|
|
1404
|
+
* @returns {Promise<Models.OAuth2Yandex>}
|
|
1405
|
+
*/
|
|
1406
|
+
updateOAuth2Yandex(params?: {
|
|
1407
|
+
clientId?: string;
|
|
1408
|
+
clientSecret?: string;
|
|
1409
|
+
enabled?: boolean;
|
|
1410
|
+
}): Promise<Models.OAuth2Yandex>;
|
|
1411
|
+
/**
|
|
1412
|
+
* Update the project OAuth2 Yandex configuration.
|
|
1413
|
+
*
|
|
1414
|
+
* @param {string} clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1415
|
+
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1416
|
+
* @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.
|
|
1417
|
+
* @throws {AppwriteException}
|
|
1418
|
+
* @returns {Promise<Models.OAuth2Yandex>}
|
|
1419
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1420
|
+
*/
|
|
1421
|
+
updateOAuth2Yandex(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Yandex>;
|
|
1422
|
+
/**
|
|
1423
|
+
* Update the project OAuth2 Zoho configuration.
|
|
1424
|
+
*
|
|
1425
|
+
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1426
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1427
|
+
* @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.
|
|
1428
|
+
* @throws {AppwriteException}
|
|
1429
|
+
* @returns {Promise<Models.OAuth2Zoho>}
|
|
1430
|
+
*/
|
|
1431
|
+
updateOAuth2Zoho(params?: {
|
|
1432
|
+
clientId?: string;
|
|
1433
|
+
clientSecret?: string;
|
|
1434
|
+
enabled?: boolean;
|
|
1435
|
+
}): Promise<Models.OAuth2Zoho>;
|
|
1436
|
+
/**
|
|
1437
|
+
* Update the project OAuth2 Zoho configuration.
|
|
1438
|
+
*
|
|
1439
|
+
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1440
|
+
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1441
|
+
* @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.
|
|
1442
|
+
* @throws {AppwriteException}
|
|
1443
|
+
* @returns {Promise<Models.OAuth2Zoho>}
|
|
1444
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1445
|
+
*/
|
|
1446
|
+
updateOAuth2Zoho(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Zoho>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Update the project OAuth2 Zoom configuration.
|
|
1449
|
+
*
|
|
1450
|
+
* @param {string} params.clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1451
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1452
|
+
* @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.
|
|
1453
|
+
* @throws {AppwriteException}
|
|
1454
|
+
* @returns {Promise<Models.OAuth2Zoom>}
|
|
1455
|
+
*/
|
|
1456
|
+
updateOAuth2Zoom(params?: {
|
|
1457
|
+
clientId?: string;
|
|
1458
|
+
clientSecret?: string;
|
|
1459
|
+
enabled?: boolean;
|
|
1460
|
+
}): Promise<Models.OAuth2Zoom>;
|
|
1461
|
+
/**
|
|
1462
|
+
* Update the project OAuth2 Zoom configuration.
|
|
1463
|
+
*
|
|
1464
|
+
* @param {string} clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1465
|
+
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1466
|
+
* @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.
|
|
1467
|
+
* @throws {AppwriteException}
|
|
1468
|
+
* @returns {Promise<Models.OAuth2Zoom>}
|
|
1469
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1470
|
+
*/
|
|
1471
|
+
updateOAuth2Zoom(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Zoom>;
|
|
1472
|
+
/**
|
|
1473
|
+
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1474
|
+
*
|
|
1475
|
+
* @param {string} params.provider - OAuth2 provider key. For example: github, google, apple.
|
|
1476
|
+
* @throws {AppwriteException}
|
|
1477
|
+
* @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>}
|
|
1478
|
+
*/
|
|
1479
|
+
getOAuth2Provider(params: {
|
|
1480
|
+
provider: string;
|
|
1481
|
+
}): 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>;
|
|
1482
|
+
/**
|
|
1483
|
+
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1484
|
+
*
|
|
1485
|
+
* @param {string} provider - OAuth2 provider key. For example: github, google, apple.
|
|
1486
|
+
* @throws {AppwriteException}
|
|
1487
|
+
* @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>}
|
|
1488
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1489
|
+
*/
|
|
1490
|
+
getOAuth2Provider(provider: string): 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>;
|
|
205
1491
|
/**
|
|
206
1492
|
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
207
1493
|
*
|
|
@@ -512,6 +1798,28 @@ export declare class Project {
|
|
|
512
1798
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
513
1799
|
*/
|
|
514
1800
|
deletePlatform(platformId: string): Promise<{}>;
|
|
1801
|
+
/**
|
|
1802
|
+
* Get a list of all project policies and their current configuration.
|
|
1803
|
+
*
|
|
1804
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1805
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1806
|
+
* @throws {AppwriteException}
|
|
1807
|
+
* @returns {Promise<Models.PolicyList>}
|
|
1808
|
+
*/
|
|
1809
|
+
listPolicies(params?: {
|
|
1810
|
+
queries?: string[];
|
|
1811
|
+
total?: boolean;
|
|
1812
|
+
}): Promise<Models.PolicyList>;
|
|
1813
|
+
/**
|
|
1814
|
+
* Get a list of all project policies and their current configuration.
|
|
1815
|
+
*
|
|
1816
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1817
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1818
|
+
* @throws {AppwriteException}
|
|
1819
|
+
* @returns {Promise<Models.PolicyList>}
|
|
1820
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1821
|
+
*/
|
|
1822
|
+
listPolicies(queries?: string[], total?: boolean): Promise<Models.PolicyList>;
|
|
515
1823
|
/**
|
|
516
1824
|
* 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..
|
|
517
1825
|
*
|
|
@@ -699,6 +2007,25 @@ export declare class Project {
|
|
|
699
2007
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
700
2008
|
*/
|
|
701
2009
|
updateUserLimitPolicy(total?: number): Promise<Models.Project>;
|
|
2010
|
+
/**
|
|
2011
|
+
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2012
|
+
*
|
|
2013
|
+
* @param {PolicyId} 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.
|
|
2014
|
+
* @throws {AppwriteException}
|
|
2015
|
+
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2016
|
+
*/
|
|
2017
|
+
getPolicy(params: {
|
|
2018
|
+
policyId: PolicyId;
|
|
2019
|
+
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2020
|
+
/**
|
|
2021
|
+
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2022
|
+
*
|
|
2023
|
+
* @param {PolicyId} 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.
|
|
2024
|
+
* @throws {AppwriteException}
|
|
2025
|
+
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2026
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2027
|
+
*/
|
|
2028
|
+
getPolicy(policyId: PolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
702
2029
|
/**
|
|
703
2030
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
704
2031
|
*
|
|
@@ -808,6 +2135,28 @@ export declare class Project {
|
|
|
808
2135
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
809
2136
|
*/
|
|
810
2137
|
createSMTPTest(emails: string[]): Promise<{}>;
|
|
2138
|
+
/**
|
|
2139
|
+
* Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.
|
|
2140
|
+
*
|
|
2141
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
2142
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
2143
|
+
* @throws {AppwriteException}
|
|
2144
|
+
* @returns {Promise<Models.EmailTemplateList>}
|
|
2145
|
+
*/
|
|
2146
|
+
listEmailTemplates(params?: {
|
|
2147
|
+
queries?: string[];
|
|
2148
|
+
total?: boolean;
|
|
2149
|
+
}): Promise<Models.EmailTemplateList>;
|
|
2150
|
+
/**
|
|
2151
|
+
* Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.
|
|
2152
|
+
*
|
|
2153
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
2154
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
2155
|
+
* @throws {AppwriteException}
|
|
2156
|
+
* @returns {Promise<Models.EmailTemplateList>}
|
|
2157
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2158
|
+
*/
|
|
2159
|
+
listEmailTemplates(queries?: string[], total?: boolean): Promise<Models.EmailTemplateList>;
|
|
811
2160
|
/**
|
|
812
2161
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
813
2162
|
*
|