@appwrite.io/console 10.0.0 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +3008 -1750
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +3008 -1751
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +3105 -1847
- package/package.json +1 -1
- package/types/client.d.ts +7 -0
- package/types/enums/appwrite-migration-resource.d.ts +2 -1
- package/types/enums/build-runtime.d.ts +1 -3
- package/types/enums/detection-framework-type.d.ts +3 -0
- package/types/enums/detection-runtime-type.d.ts +3 -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/resource-type.d.ts +9 -0
- package/types/enums/runtime.d.ts +1 -3
- package/types/enums/runtimes.d.ts +1 -3
- package/types/enums/scopes.d.ts +42 -33
- package/types/enums/{smtp-secure.d.ts → secure.d.ts} +1 -1
- package/types/index.d.ts +9 -7
- package/types/models.d.ts +1590 -159
- package/types/services/account.d.ts +4 -4
- package/types/services/console.d.ts +14 -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 +1737 -71
- package/types/services/projects.d.ts +0 -769
- package/types/services/realtime.d.ts +31 -10
- package/types/enums/sms-template-locale.d.ts +0 -133
- package/types/enums/sms-template-type.d.ts +0 -6
|
@@ -1,16 +1,8 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
3
|
import { Region } from '../enums/region';
|
|
4
|
-
import { AuthMethod } from '../enums/auth-method';
|
|
5
|
-
import { Scopes } from '../enums/scopes';
|
|
6
|
-
import { OAuthProvider } from '../enums/o-auth-provider';
|
|
7
4
|
import { ResourceType } from '../enums/resource-type';
|
|
8
|
-
import { SMTPSecure } from '../enums/smtp-secure';
|
|
9
5
|
import { Status } from '../enums/status';
|
|
10
|
-
import { EmailTemplateType } from '../enums/email-template-type';
|
|
11
|
-
import { EmailTemplateLocale } from '../enums/email-template-locale';
|
|
12
|
-
import { SmsTemplateType } from '../enums/sms-template-type';
|
|
13
|
-
import { SmsTemplateLocale } from '../enums/sms-template-locale';
|
|
14
6
|
export declare class Projects {
|
|
15
7
|
client: Client;
|
|
16
8
|
constructor(client: Client);
|
|
@@ -162,276 +154,6 @@ export declare class Projects {
|
|
|
162
154
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
163
155
|
*/
|
|
164
156
|
update(projectId: string, name: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
|
|
165
|
-
/**
|
|
166
|
-
* Delete a project by its unique ID.
|
|
167
|
-
*
|
|
168
|
-
* @param {string} params.projectId - Project unique ID.
|
|
169
|
-
* @throws {AppwriteException}
|
|
170
|
-
* @returns {Promise<{}>}
|
|
171
|
-
*/
|
|
172
|
-
delete(params: {
|
|
173
|
-
projectId: string;
|
|
174
|
-
}): Promise<{}>;
|
|
175
|
-
/**
|
|
176
|
-
* Delete a project by its unique ID.
|
|
177
|
-
*
|
|
178
|
-
* @param {string} projectId - Project unique ID.
|
|
179
|
-
* @throws {AppwriteException}
|
|
180
|
-
* @returns {Promise<{}>}
|
|
181
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
182
|
-
*/
|
|
183
|
-
delete(projectId: string): Promise<{}>;
|
|
184
|
-
/**
|
|
185
|
-
* Update how long sessions created within a project should stay active for.
|
|
186
|
-
*
|
|
187
|
-
* @param {string} params.projectId - Project unique ID.
|
|
188
|
-
* @param {number} params.duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
189
|
-
* @throws {AppwriteException}
|
|
190
|
-
* @returns {Promise<Models.Project>}
|
|
191
|
-
*/
|
|
192
|
-
updateAuthDuration(params: {
|
|
193
|
-
projectId: string;
|
|
194
|
-
duration: number;
|
|
195
|
-
}): Promise<Models.Project>;
|
|
196
|
-
/**
|
|
197
|
-
* Update how long sessions created within a project should stay active for.
|
|
198
|
-
*
|
|
199
|
-
* @param {string} projectId - Project unique ID.
|
|
200
|
-
* @param {number} duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
201
|
-
* @throws {AppwriteException}
|
|
202
|
-
* @returns {Promise<Models.Project>}
|
|
203
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
204
|
-
*/
|
|
205
|
-
updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
|
|
206
|
-
/**
|
|
207
|
-
* Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
|
208
|
-
*
|
|
209
|
-
* @param {string} params.projectId - Project unique ID.
|
|
210
|
-
* @param {number} params.limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
211
|
-
* @throws {AppwriteException}
|
|
212
|
-
* @returns {Promise<Models.Project>}
|
|
213
|
-
*/
|
|
214
|
-
updateAuthLimit(params: {
|
|
215
|
-
projectId: string;
|
|
216
|
-
limit: number;
|
|
217
|
-
}): Promise<Models.Project>;
|
|
218
|
-
/**
|
|
219
|
-
* Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
|
220
|
-
*
|
|
221
|
-
* @param {string} projectId - Project unique ID.
|
|
222
|
-
* @param {number} limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
223
|
-
* @throws {AppwriteException}
|
|
224
|
-
* @returns {Promise<Models.Project>}
|
|
225
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
226
|
-
*/
|
|
227
|
-
updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
|
|
228
|
-
/**
|
|
229
|
-
* Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
|
230
|
-
*
|
|
231
|
-
* @param {string} params.projectId - Project unique ID.
|
|
232
|
-
* @param {number} params.limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
233
|
-
* @throws {AppwriteException}
|
|
234
|
-
* @returns {Promise<Models.Project>}
|
|
235
|
-
*/
|
|
236
|
-
updateAuthSessionsLimit(params: {
|
|
237
|
-
projectId: string;
|
|
238
|
-
limit: number;
|
|
239
|
-
}): Promise<Models.Project>;
|
|
240
|
-
/**
|
|
241
|
-
* Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
|
242
|
-
*
|
|
243
|
-
* @param {string} projectId - Project unique ID.
|
|
244
|
-
* @param {number} limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
245
|
-
* @throws {AppwriteException}
|
|
246
|
-
* @returns {Promise<Models.Project>}
|
|
247
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
248
|
-
*/
|
|
249
|
-
updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
|
|
250
|
-
/**
|
|
251
|
-
* Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
|
|
252
|
-
*
|
|
253
|
-
* @param {string} params.projectId - Project unique ID.
|
|
254
|
-
* @param {boolean} params.userName - Set to true to show userName to members of a team.
|
|
255
|
-
* @param {boolean} params.userEmail - Set to true to show email to members of a team.
|
|
256
|
-
* @param {boolean} params.mfa - Set to true to show mfa to members of a team.
|
|
257
|
-
* @throws {AppwriteException}
|
|
258
|
-
* @returns {Promise<Models.Project>}
|
|
259
|
-
*/
|
|
260
|
-
updateMembershipsPrivacy(params: {
|
|
261
|
-
projectId: string;
|
|
262
|
-
userName: boolean;
|
|
263
|
-
userEmail: boolean;
|
|
264
|
-
mfa: boolean;
|
|
265
|
-
}): Promise<Models.Project>;
|
|
266
|
-
/**
|
|
267
|
-
* Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
|
|
268
|
-
*
|
|
269
|
-
* @param {string} projectId - Project unique ID.
|
|
270
|
-
* @param {boolean} userName - Set to true to show userName to members of a team.
|
|
271
|
-
* @param {boolean} userEmail - Set to true to show email to members of a team.
|
|
272
|
-
* @param {boolean} mfa - Set to true to show mfa to members of a team.
|
|
273
|
-
* @throws {AppwriteException}
|
|
274
|
-
* @returns {Promise<Models.Project>}
|
|
275
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
276
|
-
*/
|
|
277
|
-
updateMembershipsPrivacy(projectId: string, userName: boolean, userEmail: boolean, mfa: boolean): Promise<Models.Project>;
|
|
278
|
-
/**
|
|
279
|
-
* Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
|
|
280
|
-
*
|
|
281
|
-
* @param {string} params.projectId - Project unique ID.
|
|
282
|
-
* @param {object[]} params.numbers - An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.
|
|
283
|
-
* @throws {AppwriteException}
|
|
284
|
-
* @returns {Promise<Models.Project>}
|
|
285
|
-
*/
|
|
286
|
-
updateMockNumbers(params: {
|
|
287
|
-
projectId: string;
|
|
288
|
-
numbers: object[];
|
|
289
|
-
}): Promise<Models.Project>;
|
|
290
|
-
/**
|
|
291
|
-
* Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
|
|
292
|
-
*
|
|
293
|
-
* @param {string} projectId - Project unique ID.
|
|
294
|
-
* @param {object[]} numbers - An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.
|
|
295
|
-
* @throws {AppwriteException}
|
|
296
|
-
* @returns {Promise<Models.Project>}
|
|
297
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
298
|
-
*/
|
|
299
|
-
updateMockNumbers(projectId: string, numbers: object[]): Promise<Models.Project>;
|
|
300
|
-
/**
|
|
301
|
-
* Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
|
|
302
|
-
*
|
|
303
|
-
* @param {string} params.projectId - Project unique ID.
|
|
304
|
-
* @param {boolean} params.enabled - Set whether or not to enable checking user's password against most commonly used passwords. Default is false.
|
|
305
|
-
* @throws {AppwriteException}
|
|
306
|
-
* @returns {Promise<Models.Project>}
|
|
307
|
-
*/
|
|
308
|
-
updateAuthPasswordDictionary(params: {
|
|
309
|
-
projectId: string;
|
|
310
|
-
enabled: boolean;
|
|
311
|
-
}): Promise<Models.Project>;
|
|
312
|
-
/**
|
|
313
|
-
* Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
|
|
314
|
-
*
|
|
315
|
-
* @param {string} projectId - Project unique ID.
|
|
316
|
-
* @param {boolean} enabled - Set whether or not to enable checking user's password against most commonly used passwords. Default is false.
|
|
317
|
-
* @throws {AppwriteException}
|
|
318
|
-
* @returns {Promise<Models.Project>}
|
|
319
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
320
|
-
*/
|
|
321
|
-
updateAuthPasswordDictionary(projectId: string, enabled: boolean): Promise<Models.Project>;
|
|
322
|
-
/**
|
|
323
|
-
* Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
|
324
|
-
*
|
|
325
|
-
* @param {string} params.projectId - Project unique ID.
|
|
326
|
-
* @param {number} params.limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
327
|
-
* @throws {AppwriteException}
|
|
328
|
-
* @returns {Promise<Models.Project>}
|
|
329
|
-
*/
|
|
330
|
-
updateAuthPasswordHistory(params: {
|
|
331
|
-
projectId: string;
|
|
332
|
-
limit: number;
|
|
333
|
-
}): Promise<Models.Project>;
|
|
334
|
-
/**
|
|
335
|
-
* Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
|
336
|
-
*
|
|
337
|
-
* @param {string} projectId - Project unique ID.
|
|
338
|
-
* @param {number} limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
339
|
-
* @throws {AppwriteException}
|
|
340
|
-
* @returns {Promise<Models.Project>}
|
|
341
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
342
|
-
*/
|
|
343
|
-
updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
|
|
344
|
-
/**
|
|
345
|
-
* Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
|
|
346
|
-
*
|
|
347
|
-
* @param {string} params.projectId - Project unique ID.
|
|
348
|
-
* @param {boolean} params.enabled - Set whether or not to check a password for similarity with personal data. Default is false.
|
|
349
|
-
* @throws {AppwriteException}
|
|
350
|
-
* @returns {Promise<Models.Project>}
|
|
351
|
-
*/
|
|
352
|
-
updatePersonalDataCheck(params: {
|
|
353
|
-
projectId: string;
|
|
354
|
-
enabled: boolean;
|
|
355
|
-
}): Promise<Models.Project>;
|
|
356
|
-
/**
|
|
357
|
-
* Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
|
|
358
|
-
*
|
|
359
|
-
* @param {string} projectId - Project unique ID.
|
|
360
|
-
* @param {boolean} enabled - Set whether or not to check a password for similarity with personal data. Default is false.
|
|
361
|
-
* @throws {AppwriteException}
|
|
362
|
-
* @returns {Promise<Models.Project>}
|
|
363
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
364
|
-
*/
|
|
365
|
-
updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
|
|
366
|
-
/**
|
|
367
|
-
* Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
|
|
368
|
-
*
|
|
369
|
-
* @param {string} params.projectId - Project unique ID.
|
|
370
|
-
* @param {boolean} params.alerts - Set to true to enable session emails.
|
|
371
|
-
* @throws {AppwriteException}
|
|
372
|
-
* @returns {Promise<Models.Project>}
|
|
373
|
-
*/
|
|
374
|
-
updateSessionAlerts(params: {
|
|
375
|
-
projectId: string;
|
|
376
|
-
alerts: boolean;
|
|
377
|
-
}): Promise<Models.Project>;
|
|
378
|
-
/**
|
|
379
|
-
* Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
|
|
380
|
-
*
|
|
381
|
-
* @param {string} projectId - Project unique ID.
|
|
382
|
-
* @param {boolean} alerts - Set to true to enable session emails.
|
|
383
|
-
* @throws {AppwriteException}
|
|
384
|
-
* @returns {Promise<Models.Project>}
|
|
385
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
386
|
-
*/
|
|
387
|
-
updateSessionAlerts(projectId: string, alerts: boolean): Promise<Models.Project>;
|
|
388
|
-
/**
|
|
389
|
-
* Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.
|
|
390
|
-
*
|
|
391
|
-
* @param {string} params.projectId - Project unique ID.
|
|
392
|
-
* @param {boolean} params.enabled - Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change
|
|
393
|
-
* @throws {AppwriteException}
|
|
394
|
-
* @returns {Promise<Models.Project>}
|
|
395
|
-
*/
|
|
396
|
-
updateSessionInvalidation(params: {
|
|
397
|
-
projectId: string;
|
|
398
|
-
enabled: boolean;
|
|
399
|
-
}): Promise<Models.Project>;
|
|
400
|
-
/**
|
|
401
|
-
* Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.
|
|
402
|
-
*
|
|
403
|
-
* @param {string} projectId - Project unique ID.
|
|
404
|
-
* @param {boolean} enabled - Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change
|
|
405
|
-
* @throws {AppwriteException}
|
|
406
|
-
* @returns {Promise<Models.Project>}
|
|
407
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
408
|
-
*/
|
|
409
|
-
updateSessionInvalidation(projectId: string, enabled: boolean): Promise<Models.Project>;
|
|
410
|
-
/**
|
|
411
|
-
* Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
|
|
412
|
-
*
|
|
413
|
-
* @param {string} params.projectId - Project unique ID.
|
|
414
|
-
* @param {AuthMethod} params.method - Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
415
|
-
* @param {boolean} params.status - Set the status of this auth method.
|
|
416
|
-
* @throws {AppwriteException}
|
|
417
|
-
* @returns {Promise<Models.Project>}
|
|
418
|
-
*/
|
|
419
|
-
updateAuthStatus(params: {
|
|
420
|
-
projectId: string;
|
|
421
|
-
method: AuthMethod;
|
|
422
|
-
status: boolean;
|
|
423
|
-
}): Promise<Models.Project>;
|
|
424
|
-
/**
|
|
425
|
-
* Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
|
|
426
|
-
*
|
|
427
|
-
* @param {string} projectId - Project unique ID.
|
|
428
|
-
* @param {AuthMethod} method - Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
429
|
-
* @param {boolean} status - Set the status of this auth method.
|
|
430
|
-
* @throws {AppwriteException}
|
|
431
|
-
* @returns {Promise<Models.Project>}
|
|
432
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
433
|
-
*/
|
|
434
|
-
updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
|
|
435
157
|
/**
|
|
436
158
|
* Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.
|
|
437
159
|
*
|
|
@@ -572,62 +294,6 @@ export declare class Projects {
|
|
|
572
294
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
573
295
|
*/
|
|
574
296
|
deleteDevKey(projectId: string, keyId: string): Promise<{}>;
|
|
575
|
-
/**
|
|
576
|
-
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
577
|
-
*
|
|
578
|
-
* @param {string} params.projectId - Project unique ID.
|
|
579
|
-
* @param {Scopes[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
580
|
-
* @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
581
|
-
* @throws {AppwriteException}
|
|
582
|
-
* @returns {Promise<Models.Jwt>}
|
|
583
|
-
*/
|
|
584
|
-
createJWT(params: {
|
|
585
|
-
projectId: string;
|
|
586
|
-
scopes: Scopes[];
|
|
587
|
-
duration?: number;
|
|
588
|
-
}): Promise<Models.Jwt>;
|
|
589
|
-
/**
|
|
590
|
-
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
591
|
-
*
|
|
592
|
-
* @param {string} projectId - Project unique ID.
|
|
593
|
-
* @param {Scopes[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
594
|
-
* @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
595
|
-
* @throws {AppwriteException}
|
|
596
|
-
* @returns {Promise<Models.Jwt>}
|
|
597
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
598
|
-
*/
|
|
599
|
-
createJWT(projectId: string, scopes: Scopes[], duration?: number): Promise<Models.Jwt>;
|
|
600
|
-
/**
|
|
601
|
-
* Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
|
|
602
|
-
*
|
|
603
|
-
* @param {string} params.projectId - Project unique ID.
|
|
604
|
-
* @param {OAuthProvider} params.provider - Provider Name
|
|
605
|
-
* @param {string} params.appId - Provider app ID. Max length: 256 chars.
|
|
606
|
-
* @param {string} params.secret - Provider secret key. Max length: 512 chars.
|
|
607
|
-
* @param {boolean} params.enabled - Provider status. Set to 'false' to disable new session creation.
|
|
608
|
-
* @throws {AppwriteException}
|
|
609
|
-
* @returns {Promise<Models.Project>}
|
|
610
|
-
*/
|
|
611
|
-
updateOAuth2(params: {
|
|
612
|
-
projectId: string;
|
|
613
|
-
provider: OAuthProvider;
|
|
614
|
-
appId?: string;
|
|
615
|
-
secret?: string;
|
|
616
|
-
enabled?: boolean;
|
|
617
|
-
}): Promise<Models.Project>;
|
|
618
|
-
/**
|
|
619
|
-
* Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
|
|
620
|
-
*
|
|
621
|
-
* @param {string} projectId - Project unique ID.
|
|
622
|
-
* @param {OAuthProvider} provider - Provider Name
|
|
623
|
-
* @param {string} appId - Provider app ID. Max length: 256 chars.
|
|
624
|
-
* @param {string} secret - Provider secret key. Max length: 512 chars.
|
|
625
|
-
* @param {boolean} enabled - Provider status. Set to 'false' to disable new session creation.
|
|
626
|
-
* @throws {AppwriteException}
|
|
627
|
-
* @returns {Promise<Models.Project>}
|
|
628
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
629
|
-
*/
|
|
630
|
-
updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
|
|
631
297
|
/**
|
|
632
298
|
* Get a list of all the project's schedules. You can use the query params to filter your results.
|
|
633
299
|
*
|
|
@@ -709,192 +375,6 @@ export declare class Projects {
|
|
|
709
375
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
710
376
|
*/
|
|
711
377
|
getSchedule(projectId: string, scheduleId: string): Promise<Models.Schedule>;
|
|
712
|
-
/**
|
|
713
|
-
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
714
|
-
*
|
|
715
|
-
* @param {string} params.projectId - Project unique ID.
|
|
716
|
-
* @param {boolean} params.enabled - Enable custom SMTP service
|
|
717
|
-
* @param {string} params.senderName - Name of the email sender
|
|
718
|
-
* @param {string} params.senderEmail - Email of the sender
|
|
719
|
-
* @param {string} params.replyTo - Reply to email
|
|
720
|
-
* @param {string} params.host - SMTP server host name
|
|
721
|
-
* @param {number} params.port - SMTP server port
|
|
722
|
-
* @param {string} params.username - SMTP server username
|
|
723
|
-
* @param {string} params.password - SMTP server password
|
|
724
|
-
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
725
|
-
* @throws {AppwriteException}
|
|
726
|
-
* @returns {Promise<Models.Project>}
|
|
727
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateSMTP` instead.
|
|
728
|
-
*/
|
|
729
|
-
updateSmtp(params: {
|
|
730
|
-
projectId: string;
|
|
731
|
-
enabled: boolean;
|
|
732
|
-
senderName?: string;
|
|
733
|
-
senderEmail?: string;
|
|
734
|
-
replyTo?: string;
|
|
735
|
-
host?: string;
|
|
736
|
-
port?: number;
|
|
737
|
-
username?: string;
|
|
738
|
-
password?: string;
|
|
739
|
-
secure?: SMTPSecure;
|
|
740
|
-
}): Promise<Models.Project>;
|
|
741
|
-
/**
|
|
742
|
-
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
743
|
-
*
|
|
744
|
-
* @param {string} projectId - Project unique ID.
|
|
745
|
-
* @param {boolean} enabled - Enable custom SMTP service
|
|
746
|
-
* @param {string} senderName - Name of the email sender
|
|
747
|
-
* @param {string} senderEmail - Email of the sender
|
|
748
|
-
* @param {string} replyTo - Reply to email
|
|
749
|
-
* @param {string} host - SMTP server host name
|
|
750
|
-
* @param {number} port - SMTP server port
|
|
751
|
-
* @param {string} username - SMTP server username
|
|
752
|
-
* @param {string} password - SMTP server password
|
|
753
|
-
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
754
|
-
* @throws {AppwriteException}
|
|
755
|
-
* @returns {Promise<Models.Project>}
|
|
756
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
757
|
-
*/
|
|
758
|
-
updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
759
|
-
/**
|
|
760
|
-
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
761
|
-
*
|
|
762
|
-
* @param {string} params.projectId - Project unique ID.
|
|
763
|
-
* @param {boolean} params.enabled - Enable custom SMTP service
|
|
764
|
-
* @param {string} params.senderName - Name of the email sender
|
|
765
|
-
* @param {string} params.senderEmail - Email of the sender
|
|
766
|
-
* @param {string} params.replyTo - Reply to email
|
|
767
|
-
* @param {string} params.host - SMTP server host name
|
|
768
|
-
* @param {number} params.port - SMTP server port
|
|
769
|
-
* @param {string} params.username - SMTP server username
|
|
770
|
-
* @param {string} params.password - SMTP server password
|
|
771
|
-
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
772
|
-
* @throws {AppwriteException}
|
|
773
|
-
* @returns {Promise<Models.Project>}
|
|
774
|
-
*/
|
|
775
|
-
updateSMTP(params: {
|
|
776
|
-
projectId: string;
|
|
777
|
-
enabled: boolean;
|
|
778
|
-
senderName?: string;
|
|
779
|
-
senderEmail?: string;
|
|
780
|
-
replyTo?: string;
|
|
781
|
-
host?: string;
|
|
782
|
-
port?: number;
|
|
783
|
-
username?: string;
|
|
784
|
-
password?: string;
|
|
785
|
-
secure?: SMTPSecure;
|
|
786
|
-
}): Promise<Models.Project>;
|
|
787
|
-
/**
|
|
788
|
-
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
789
|
-
*
|
|
790
|
-
* @param {string} projectId - Project unique ID.
|
|
791
|
-
* @param {boolean} enabled - Enable custom SMTP service
|
|
792
|
-
* @param {string} senderName - Name of the email sender
|
|
793
|
-
* @param {string} senderEmail - Email of the sender
|
|
794
|
-
* @param {string} replyTo - Reply to email
|
|
795
|
-
* @param {string} host - SMTP server host name
|
|
796
|
-
* @param {number} port - SMTP server port
|
|
797
|
-
* @param {string} username - SMTP server username
|
|
798
|
-
* @param {string} password - SMTP server password
|
|
799
|
-
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
800
|
-
* @throws {AppwriteException}
|
|
801
|
-
* @returns {Promise<Models.Project>}
|
|
802
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
803
|
-
*/
|
|
804
|
-
updateSMTP(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
805
|
-
/**
|
|
806
|
-
* Send a test email to verify SMTP configuration.
|
|
807
|
-
*
|
|
808
|
-
* @param {string} params.projectId - Project unique ID.
|
|
809
|
-
* @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
810
|
-
* @param {string} params.senderName - Name of the email sender
|
|
811
|
-
* @param {string} params.senderEmail - Email of the sender
|
|
812
|
-
* @param {string} params.host - SMTP server host name
|
|
813
|
-
* @param {string} params.replyTo - Reply to email
|
|
814
|
-
* @param {number} params.port - SMTP server port
|
|
815
|
-
* @param {string} params.username - SMTP server username
|
|
816
|
-
* @param {string} params.password - SMTP server password
|
|
817
|
-
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
818
|
-
* @throws {AppwriteException}
|
|
819
|
-
* @returns {Promise<{}>}
|
|
820
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.createSMTPTest` instead.
|
|
821
|
-
*/
|
|
822
|
-
createSmtpTest(params: {
|
|
823
|
-
projectId: string;
|
|
824
|
-
emails: string[];
|
|
825
|
-
senderName: string;
|
|
826
|
-
senderEmail: string;
|
|
827
|
-
host: string;
|
|
828
|
-
replyTo?: string;
|
|
829
|
-
port?: number;
|
|
830
|
-
username?: string;
|
|
831
|
-
password?: string;
|
|
832
|
-
secure?: SMTPSecure;
|
|
833
|
-
}): Promise<{}>;
|
|
834
|
-
/**
|
|
835
|
-
* Send a test email to verify SMTP configuration.
|
|
836
|
-
*
|
|
837
|
-
* @param {string} projectId - Project unique ID.
|
|
838
|
-
* @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
839
|
-
* @param {string} senderName - Name of the email sender
|
|
840
|
-
* @param {string} senderEmail - Email of the sender
|
|
841
|
-
* @param {string} host - SMTP server host name
|
|
842
|
-
* @param {string} replyTo - Reply to email
|
|
843
|
-
* @param {number} port - SMTP server port
|
|
844
|
-
* @param {string} username - SMTP server username
|
|
845
|
-
* @param {string} password - SMTP server password
|
|
846
|
-
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
847
|
-
* @throws {AppwriteException}
|
|
848
|
-
* @returns {Promise<{}>}
|
|
849
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
850
|
-
*/
|
|
851
|
-
createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
852
|
-
/**
|
|
853
|
-
* Send a test email to verify SMTP configuration.
|
|
854
|
-
*
|
|
855
|
-
* @param {string} params.projectId - Project unique ID.
|
|
856
|
-
* @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
857
|
-
* @param {string} params.senderName - Name of the email sender
|
|
858
|
-
* @param {string} params.senderEmail - Email of the sender
|
|
859
|
-
* @param {string} params.host - SMTP server host name
|
|
860
|
-
* @param {string} params.replyTo - Reply to email
|
|
861
|
-
* @param {number} params.port - SMTP server port
|
|
862
|
-
* @param {string} params.username - SMTP server username
|
|
863
|
-
* @param {string} params.password - SMTP server password
|
|
864
|
-
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
865
|
-
* @throws {AppwriteException}
|
|
866
|
-
* @returns {Promise<{}>}
|
|
867
|
-
*/
|
|
868
|
-
createSMTPTest(params: {
|
|
869
|
-
projectId: string;
|
|
870
|
-
emails: string[];
|
|
871
|
-
senderName: string;
|
|
872
|
-
senderEmail: string;
|
|
873
|
-
host: string;
|
|
874
|
-
replyTo?: string;
|
|
875
|
-
port?: number;
|
|
876
|
-
username?: string;
|
|
877
|
-
password?: string;
|
|
878
|
-
secure?: SMTPSecure;
|
|
879
|
-
}): Promise<{}>;
|
|
880
|
-
/**
|
|
881
|
-
* Send a test email to verify SMTP configuration.
|
|
882
|
-
*
|
|
883
|
-
* @param {string} projectId - Project unique ID.
|
|
884
|
-
* @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
885
|
-
* @param {string} senderName - Name of the email sender
|
|
886
|
-
* @param {string} senderEmail - Email of the sender
|
|
887
|
-
* @param {string} host - SMTP server host name
|
|
888
|
-
* @param {string} replyTo - Reply to email
|
|
889
|
-
* @param {number} port - SMTP server port
|
|
890
|
-
* @param {string} username - SMTP server username
|
|
891
|
-
* @param {string} password - SMTP server password
|
|
892
|
-
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
893
|
-
* @throws {AppwriteException}
|
|
894
|
-
* @returns {Promise<{}>}
|
|
895
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
896
|
-
*/
|
|
897
|
-
createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
898
378
|
/**
|
|
899
379
|
* Update the status of a project. Can be used to archive/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.
|
|
900
380
|
*
|
|
@@ -941,253 +421,4 @@ export declare class Projects {
|
|
|
941
421
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
942
422
|
*/
|
|
943
423
|
updateTeam(projectId: string, teamId: string): Promise<Models.Project>;
|
|
944
|
-
/**
|
|
945
|
-
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
946
|
-
*
|
|
947
|
-
* @param {string} params.projectId - Project unique ID.
|
|
948
|
-
* @param {EmailTemplateType} params.type - Template type
|
|
949
|
-
* @param {EmailTemplateLocale} params.locale - Template locale
|
|
950
|
-
* @throws {AppwriteException}
|
|
951
|
-
* @returns {Promise<Models.EmailTemplate>}
|
|
952
|
-
*/
|
|
953
|
-
getEmailTemplate(params: {
|
|
954
|
-
projectId: string;
|
|
955
|
-
type: EmailTemplateType;
|
|
956
|
-
locale: EmailTemplateLocale;
|
|
957
|
-
}): Promise<Models.EmailTemplate>;
|
|
958
|
-
/**
|
|
959
|
-
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
960
|
-
*
|
|
961
|
-
* @param {string} projectId - Project unique ID.
|
|
962
|
-
* @param {EmailTemplateType} type - Template type
|
|
963
|
-
* @param {EmailTemplateLocale} locale - Template locale
|
|
964
|
-
* @throws {AppwriteException}
|
|
965
|
-
* @returns {Promise<Models.EmailTemplate>}
|
|
966
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
967
|
-
*/
|
|
968
|
-
getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
969
|
-
/**
|
|
970
|
-
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
971
|
-
*
|
|
972
|
-
* @param {string} params.projectId - Project unique ID.
|
|
973
|
-
* @param {EmailTemplateType} params.type - Template type
|
|
974
|
-
* @param {EmailTemplateLocale} params.locale - Template locale
|
|
975
|
-
* @param {string} params.subject - Email Subject
|
|
976
|
-
* @param {string} params.message - Template message
|
|
977
|
-
* @param {string} params.senderName - Name of the email sender
|
|
978
|
-
* @param {string} params.senderEmail - Email of the sender
|
|
979
|
-
* @param {string} params.replyTo - Reply to email
|
|
980
|
-
* @throws {AppwriteException}
|
|
981
|
-
* @returns {Promise<Models.EmailTemplate>}
|
|
982
|
-
*/
|
|
983
|
-
updateEmailTemplate(params: {
|
|
984
|
-
projectId: string;
|
|
985
|
-
type: EmailTemplateType;
|
|
986
|
-
locale: EmailTemplateLocale;
|
|
987
|
-
subject: string;
|
|
988
|
-
message: string;
|
|
989
|
-
senderName?: string;
|
|
990
|
-
senderEmail?: string;
|
|
991
|
-
replyTo?: string;
|
|
992
|
-
}): Promise<Models.EmailTemplate>;
|
|
993
|
-
/**
|
|
994
|
-
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
995
|
-
*
|
|
996
|
-
* @param {string} projectId - Project unique ID.
|
|
997
|
-
* @param {EmailTemplateType} type - Template type
|
|
998
|
-
* @param {EmailTemplateLocale} locale - Template locale
|
|
999
|
-
* @param {string} subject - Email Subject
|
|
1000
|
-
* @param {string} message - Template message
|
|
1001
|
-
* @param {string} senderName - Name of the email sender
|
|
1002
|
-
* @param {string} senderEmail - Email of the sender
|
|
1003
|
-
* @param {string} replyTo - Reply to email
|
|
1004
|
-
* @throws {AppwriteException}
|
|
1005
|
-
* @returns {Promise<Models.EmailTemplate>}
|
|
1006
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1007
|
-
*/
|
|
1008
|
-
updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.EmailTemplate>;
|
|
1009
|
-
/**
|
|
1010
|
-
* Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
|
|
1011
|
-
*
|
|
1012
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1013
|
-
* @param {EmailTemplateType} params.type - Template type
|
|
1014
|
-
* @param {EmailTemplateLocale} params.locale - Template locale
|
|
1015
|
-
* @throws {AppwriteException}
|
|
1016
|
-
* @returns {Promise<Models.EmailTemplate>}
|
|
1017
|
-
*/
|
|
1018
|
-
deleteEmailTemplate(params: {
|
|
1019
|
-
projectId: string;
|
|
1020
|
-
type: EmailTemplateType;
|
|
1021
|
-
locale: EmailTemplateLocale;
|
|
1022
|
-
}): Promise<Models.EmailTemplate>;
|
|
1023
|
-
/**
|
|
1024
|
-
* Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
|
|
1025
|
-
*
|
|
1026
|
-
* @param {string} projectId - Project unique ID.
|
|
1027
|
-
* @param {EmailTemplateType} type - Template type
|
|
1028
|
-
* @param {EmailTemplateLocale} locale - Template locale
|
|
1029
|
-
* @throws {AppwriteException}
|
|
1030
|
-
* @returns {Promise<Models.EmailTemplate>}
|
|
1031
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1032
|
-
*/
|
|
1033
|
-
deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
1034
|
-
/**
|
|
1035
|
-
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1036
|
-
*
|
|
1037
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1038
|
-
* @param {SmsTemplateType} params.type - Template type
|
|
1039
|
-
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1040
|
-
* @throws {AppwriteException}
|
|
1041
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1042
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.getSMSTemplate` instead.
|
|
1043
|
-
*/
|
|
1044
|
-
getSmsTemplate(params: {
|
|
1045
|
-
projectId: string;
|
|
1046
|
-
type: SmsTemplateType;
|
|
1047
|
-
locale: SmsTemplateLocale;
|
|
1048
|
-
}): Promise<Models.SmsTemplate>;
|
|
1049
|
-
/**
|
|
1050
|
-
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1051
|
-
*
|
|
1052
|
-
* @param {string} projectId - Project unique ID.
|
|
1053
|
-
* @param {SmsTemplateType} type - Template type
|
|
1054
|
-
* @param {SmsTemplateLocale} locale - Template locale
|
|
1055
|
-
* @throws {AppwriteException}
|
|
1056
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1057
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1058
|
-
*/
|
|
1059
|
-
getSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1060
|
-
/**
|
|
1061
|
-
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1062
|
-
*
|
|
1063
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1064
|
-
* @param {SmsTemplateType} params.type - Template type
|
|
1065
|
-
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1066
|
-
* @throws {AppwriteException}
|
|
1067
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1068
|
-
*/
|
|
1069
|
-
getSMSTemplate(params: {
|
|
1070
|
-
projectId: string;
|
|
1071
|
-
type: SmsTemplateType;
|
|
1072
|
-
locale: SmsTemplateLocale;
|
|
1073
|
-
}): Promise<Models.SmsTemplate>;
|
|
1074
|
-
/**
|
|
1075
|
-
* Get a custom SMS template for the specified locale and type returning it's contents.
|
|
1076
|
-
*
|
|
1077
|
-
* @param {string} projectId - Project unique ID.
|
|
1078
|
-
* @param {SmsTemplateType} type - Template type
|
|
1079
|
-
* @param {SmsTemplateLocale} locale - Template locale
|
|
1080
|
-
* @throws {AppwriteException}
|
|
1081
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1082
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1083
|
-
*/
|
|
1084
|
-
getSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1085
|
-
/**
|
|
1086
|
-
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1087
|
-
*
|
|
1088
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1089
|
-
* @param {SmsTemplateType} params.type - Template type
|
|
1090
|
-
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1091
|
-
* @param {string} params.message - Template message
|
|
1092
|
-
* @throws {AppwriteException}
|
|
1093
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1094
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateSMSTemplate` instead.
|
|
1095
|
-
*/
|
|
1096
|
-
updateSmsTemplate(params: {
|
|
1097
|
-
projectId: string;
|
|
1098
|
-
type: SmsTemplateType;
|
|
1099
|
-
locale: SmsTemplateLocale;
|
|
1100
|
-
message: string;
|
|
1101
|
-
}): Promise<Models.SmsTemplate>;
|
|
1102
|
-
/**
|
|
1103
|
-
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1104
|
-
*
|
|
1105
|
-
* @param {string} projectId - Project unique ID.
|
|
1106
|
-
* @param {SmsTemplateType} type - Template type
|
|
1107
|
-
* @param {SmsTemplateLocale} locale - Template locale
|
|
1108
|
-
* @param {string} message - Template message
|
|
1109
|
-
* @throws {AppwriteException}
|
|
1110
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1111
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1112
|
-
*/
|
|
1113
|
-
updateSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
|
|
1114
|
-
/**
|
|
1115
|
-
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1116
|
-
*
|
|
1117
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1118
|
-
* @param {SmsTemplateType} params.type - Template type
|
|
1119
|
-
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1120
|
-
* @param {string} params.message - Template message
|
|
1121
|
-
* @throws {AppwriteException}
|
|
1122
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1123
|
-
*/
|
|
1124
|
-
updateSMSTemplate(params: {
|
|
1125
|
-
projectId: string;
|
|
1126
|
-
type: SmsTemplateType;
|
|
1127
|
-
locale: SmsTemplateLocale;
|
|
1128
|
-
message: string;
|
|
1129
|
-
}): Promise<Models.SmsTemplate>;
|
|
1130
|
-
/**
|
|
1131
|
-
* Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
|
1132
|
-
*
|
|
1133
|
-
* @param {string} projectId - Project unique ID.
|
|
1134
|
-
* @param {SmsTemplateType} type - Template type
|
|
1135
|
-
* @param {SmsTemplateLocale} locale - Template locale
|
|
1136
|
-
* @param {string} message - Template message
|
|
1137
|
-
* @throws {AppwriteException}
|
|
1138
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1139
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1140
|
-
*/
|
|
1141
|
-
updateSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
|
|
1142
|
-
/**
|
|
1143
|
-
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1144
|
-
*
|
|
1145
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1146
|
-
* @param {SmsTemplateType} params.type - Template type
|
|
1147
|
-
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1148
|
-
* @throws {AppwriteException}
|
|
1149
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1150
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `Projects.deleteSMSTemplate` instead.
|
|
1151
|
-
*/
|
|
1152
|
-
deleteSmsTemplate(params: {
|
|
1153
|
-
projectId: string;
|
|
1154
|
-
type: SmsTemplateType;
|
|
1155
|
-
locale: SmsTemplateLocale;
|
|
1156
|
-
}): Promise<Models.SmsTemplate>;
|
|
1157
|
-
/**
|
|
1158
|
-
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1159
|
-
*
|
|
1160
|
-
* @param {string} projectId - Project unique ID.
|
|
1161
|
-
* @param {SmsTemplateType} type - Template type
|
|
1162
|
-
* @param {SmsTemplateLocale} locale - Template locale
|
|
1163
|
-
* @throws {AppwriteException}
|
|
1164
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1165
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1166
|
-
*/
|
|
1167
|
-
deleteSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1168
|
-
/**
|
|
1169
|
-
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1170
|
-
*
|
|
1171
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1172
|
-
* @param {SmsTemplateType} params.type - Template type
|
|
1173
|
-
* @param {SmsTemplateLocale} params.locale - Template locale
|
|
1174
|
-
* @throws {AppwriteException}
|
|
1175
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1176
|
-
*/
|
|
1177
|
-
deleteSMSTemplate(params: {
|
|
1178
|
-
projectId: string;
|
|
1179
|
-
type: SmsTemplateType;
|
|
1180
|
-
locale: SmsTemplateLocale;
|
|
1181
|
-
}): Promise<Models.SmsTemplate>;
|
|
1182
|
-
/**
|
|
1183
|
-
* Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
|
1184
|
-
*
|
|
1185
|
-
* @param {string} projectId - Project unique ID.
|
|
1186
|
-
* @param {SmsTemplateType} type - Template type
|
|
1187
|
-
* @param {SmsTemplateLocale} locale - Template locale
|
|
1188
|
-
* @throws {AppwriteException}
|
|
1189
|
-
* @returns {Promise<Models.SmsTemplate>}
|
|
1190
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1191
|
-
*/
|
|
1192
|
-
deleteSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1193
424
|
}
|