@appwrite.io/console 12.2.0 → 13.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 +1 -1
- package/dist/cjs/sdk.js +96 -77
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +97 -78
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +96 -77
- package/package.json +1 -1
- package/types/enums/o-auth-2-google-prompt.d.ts +5 -0
- package/types/enums/prompt.d.ts +5 -0
- package/types/index.d.ts +2 -0
- package/types/models.d.ts +5 -0
- package/types/services/project.d.ts +144 -140
|
@@ -2,6 +2,7 @@ import { Client } from '../client';
|
|
|
2
2
|
import type { Models } from '../models';
|
|
3
3
|
import { AuthMethod } from '../enums/auth-method';
|
|
4
4
|
import { Scopes } from '../enums/scopes';
|
|
5
|
+
import { Prompt } from '../enums/prompt';
|
|
5
6
|
import { OAuthProvider } from '../enums/o-auth-provider';
|
|
6
7
|
import { ProjectPolicy } from '../enums/project-policy';
|
|
7
8
|
import { ProtocolId } from '../enums/protocol-id';
|
|
@@ -42,63 +43,6 @@ export declare class Project {
|
|
|
42
43
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
43
44
|
*/
|
|
44
45
|
updateAuthMethod(methodId: AuthMethod, enabled: boolean): Promise<Models.Project>;
|
|
45
|
-
/**
|
|
46
|
-
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
47
|
-
*
|
|
48
|
-
* @param {boolean} params.enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
49
|
-
* @throws {AppwriteException}
|
|
50
|
-
* @returns {Promise<Models.Project>}
|
|
51
|
-
*/
|
|
52
|
-
updateCanonicalEmails(params: {
|
|
53
|
-
enabled: boolean;
|
|
54
|
-
}): Promise<Models.Project>;
|
|
55
|
-
/**
|
|
56
|
-
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
57
|
-
*
|
|
58
|
-
* @param {boolean} enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
59
|
-
* @throws {AppwriteException}
|
|
60
|
-
* @returns {Promise<Models.Project>}
|
|
61
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
62
|
-
*/
|
|
63
|
-
updateCanonicalEmails(enabled: boolean): Promise<Models.Project>;
|
|
64
|
-
/**
|
|
65
|
-
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
66
|
-
*
|
|
67
|
-
* @param {boolean} params.enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
68
|
-
* @throws {AppwriteException}
|
|
69
|
-
* @returns {Promise<Models.Project>}
|
|
70
|
-
*/
|
|
71
|
-
updateDisposableEmails(params: {
|
|
72
|
-
enabled: boolean;
|
|
73
|
-
}): Promise<Models.Project>;
|
|
74
|
-
/**
|
|
75
|
-
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
76
|
-
*
|
|
77
|
-
* @param {boolean} enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
78
|
-
* @throws {AppwriteException}
|
|
79
|
-
* @returns {Promise<Models.Project>}
|
|
80
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
81
|
-
*/
|
|
82
|
-
updateDisposableEmails(enabled: boolean): Promise<Models.Project>;
|
|
83
|
-
/**
|
|
84
|
-
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
85
|
-
*
|
|
86
|
-
* @param {boolean} params.enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
87
|
-
* @throws {AppwriteException}
|
|
88
|
-
* @returns {Promise<Models.Project>}
|
|
89
|
-
*/
|
|
90
|
-
updateFreeEmails(params: {
|
|
91
|
-
enabled: boolean;
|
|
92
|
-
}): Promise<Models.Project>;
|
|
93
|
-
/**
|
|
94
|
-
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
95
|
-
*
|
|
96
|
-
* @param {boolean} enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
97
|
-
* @throws {AppwriteException}
|
|
98
|
-
* @returns {Promise<Models.Project>}
|
|
99
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
100
|
-
*/
|
|
101
|
-
updateFreeEmails(enabled: boolean): Promise<Models.Project>;
|
|
102
46
|
/**
|
|
103
47
|
* Get a list of all API keys from the current project.
|
|
104
48
|
*
|
|
@@ -394,7 +338,7 @@ export declare class Project {
|
|
|
394
338
|
* Update the project OAuth2 Amazon configuration.
|
|
395
339
|
*
|
|
396
340
|
* @param {string} params.clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
397
|
-
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example:
|
|
341
|
+
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
398
342
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
399
343
|
* @throws {AppwriteException}
|
|
400
344
|
* @returns {Promise<Models.OAuth2Amazon>}
|
|
@@ -408,7 +352,7 @@ export declare class Project {
|
|
|
408
352
|
* Update the project OAuth2 Amazon configuration.
|
|
409
353
|
*
|
|
410
354
|
* @param {string} clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
411
|
-
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example:
|
|
355
|
+
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
412
356
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
413
357
|
* @throws {AppwriteException}
|
|
414
358
|
* @returns {Promise<Models.OAuth2Amazon>}
|
|
@@ -450,7 +394,7 @@ export declare class Project {
|
|
|
450
394
|
* Update the project OAuth2 Auth0 configuration.
|
|
451
395
|
*
|
|
452
396
|
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
453
|
-
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example:
|
|
397
|
+
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
454
398
|
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
455
399
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
456
400
|
* @throws {AppwriteException}
|
|
@@ -466,7 +410,7 @@ export declare class Project {
|
|
|
466
410
|
* Update the project OAuth2 Auth0 configuration.
|
|
467
411
|
*
|
|
468
412
|
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
469
|
-
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example:
|
|
413
|
+
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
470
414
|
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
471
415
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
472
416
|
* @throws {AppwriteException}
|
|
@@ -478,7 +422,7 @@ export declare class Project {
|
|
|
478
422
|
* Update the project OAuth2 Authentik configuration.
|
|
479
423
|
*
|
|
480
424
|
* @param {string} params.clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
481
|
-
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example:
|
|
425
|
+
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
482
426
|
* @param {string} params.endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
483
427
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
484
428
|
* @throws {AppwriteException}
|
|
@@ -494,7 +438,7 @@ export declare class Project {
|
|
|
494
438
|
* Update the project OAuth2 Authentik configuration.
|
|
495
439
|
*
|
|
496
440
|
* @param {string} clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
497
|
-
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example:
|
|
441
|
+
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
498
442
|
* @param {string} endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
499
443
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
500
444
|
* @throws {AppwriteException}
|
|
@@ -506,7 +450,7 @@ export declare class Project {
|
|
|
506
450
|
* Update the project OAuth2 Autodesk configuration.
|
|
507
451
|
*
|
|
508
452
|
* @param {string} params.clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
509
|
-
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example:
|
|
453
|
+
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
510
454
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
511
455
|
* @throws {AppwriteException}
|
|
512
456
|
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
@@ -520,7 +464,7 @@ export declare class Project {
|
|
|
520
464
|
* Update the project OAuth2 Autodesk configuration.
|
|
521
465
|
*
|
|
522
466
|
* @param {string} clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
523
|
-
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example:
|
|
467
|
+
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
524
468
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
525
469
|
* @throws {AppwriteException}
|
|
526
470
|
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
@@ -531,7 +475,7 @@ export declare class Project {
|
|
|
531
475
|
* Update the project OAuth2 Bitbucket configuration.
|
|
532
476
|
*
|
|
533
477
|
* @param {string} params.key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
534
|
-
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example:
|
|
478
|
+
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
535
479
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
536
480
|
* @throws {AppwriteException}
|
|
537
481
|
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
@@ -545,7 +489,7 @@ export declare class Project {
|
|
|
545
489
|
* Update the project OAuth2 Bitbucket configuration.
|
|
546
490
|
*
|
|
547
491
|
* @param {string} key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
548
|
-
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example:
|
|
492
|
+
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
549
493
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
550
494
|
* @throws {AppwriteException}
|
|
551
495
|
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
@@ -556,7 +500,7 @@ export declare class Project {
|
|
|
556
500
|
* Update the project OAuth2 Bitly configuration.
|
|
557
501
|
*
|
|
558
502
|
* @param {string} params.clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
559
|
-
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example:
|
|
503
|
+
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
560
504
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
561
505
|
* @throws {AppwriteException}
|
|
562
506
|
* @returns {Promise<Models.OAuth2Bitly>}
|
|
@@ -570,7 +514,7 @@ export declare class Project {
|
|
|
570
514
|
* Update the project OAuth2 Bitly configuration.
|
|
571
515
|
*
|
|
572
516
|
* @param {string} clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
573
|
-
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example:
|
|
517
|
+
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
574
518
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
575
519
|
* @throws {AppwriteException}
|
|
576
520
|
* @returns {Promise<Models.OAuth2Bitly>}
|
|
@@ -581,7 +525,7 @@ export declare class Project {
|
|
|
581
525
|
* Update the project OAuth2 Box configuration.
|
|
582
526
|
*
|
|
583
527
|
* @param {string} params.clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
584
|
-
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example:
|
|
528
|
+
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
585
529
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
586
530
|
* @throws {AppwriteException}
|
|
587
531
|
* @returns {Promise<Models.OAuth2Box>}
|
|
@@ -595,7 +539,7 @@ export declare class Project {
|
|
|
595
539
|
* Update the project OAuth2 Box configuration.
|
|
596
540
|
*
|
|
597
541
|
* @param {string} clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
598
|
-
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example:
|
|
542
|
+
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
599
543
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
600
544
|
* @throws {AppwriteException}
|
|
601
545
|
* @returns {Promise<Models.OAuth2Box>}
|
|
@@ -606,7 +550,7 @@ export declare class Project {
|
|
|
606
550
|
* Update the project OAuth2 Dailymotion configuration.
|
|
607
551
|
*
|
|
608
552
|
* @param {string} params.apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
609
|
-
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example:
|
|
553
|
+
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
610
554
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
611
555
|
* @throws {AppwriteException}
|
|
612
556
|
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
@@ -620,7 +564,7 @@ export declare class Project {
|
|
|
620
564
|
* Update the project OAuth2 Dailymotion configuration.
|
|
621
565
|
*
|
|
622
566
|
* @param {string} apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
623
|
-
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example:
|
|
567
|
+
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
624
568
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
625
569
|
* @throws {AppwriteException}
|
|
626
570
|
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
@@ -631,7 +575,7 @@ export declare class Project {
|
|
|
631
575
|
* Update the project OAuth2 Discord configuration.
|
|
632
576
|
*
|
|
633
577
|
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
634
|
-
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example:
|
|
578
|
+
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
635
579
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
636
580
|
* @throws {AppwriteException}
|
|
637
581
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -645,7 +589,7 @@ export declare class Project {
|
|
|
645
589
|
* Update the project OAuth2 Discord configuration.
|
|
646
590
|
*
|
|
647
591
|
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
648
|
-
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example:
|
|
592
|
+
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
649
593
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
650
594
|
* @throws {AppwriteException}
|
|
651
595
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -656,7 +600,7 @@ export declare class Project {
|
|
|
656
600
|
* Update the project OAuth2 Disqus configuration.
|
|
657
601
|
*
|
|
658
602
|
* @param {string} params.publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
659
|
-
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example:
|
|
603
|
+
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
660
604
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
661
605
|
* @throws {AppwriteException}
|
|
662
606
|
* @returns {Promise<Models.OAuth2Disqus>}
|
|
@@ -670,7 +614,7 @@ export declare class Project {
|
|
|
670
614
|
* Update the project OAuth2 Disqus configuration.
|
|
671
615
|
*
|
|
672
616
|
* @param {string} publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
673
|
-
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example:
|
|
617
|
+
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
674
618
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
675
619
|
* @throws {AppwriteException}
|
|
676
620
|
* @returns {Promise<Models.OAuth2Disqus>}
|
|
@@ -681,7 +625,7 @@ export declare class Project {
|
|
|
681
625
|
* Update the project OAuth2 Dropbox configuration.
|
|
682
626
|
*
|
|
683
627
|
* @param {string} params.appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
684
|
-
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example:
|
|
628
|
+
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
685
629
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
686
630
|
* @throws {AppwriteException}
|
|
687
631
|
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
@@ -695,7 +639,7 @@ export declare class Project {
|
|
|
695
639
|
* Update the project OAuth2 Dropbox configuration.
|
|
696
640
|
*
|
|
697
641
|
* @param {string} appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
698
|
-
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example:
|
|
642
|
+
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
699
643
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
700
644
|
* @throws {AppwriteException}
|
|
701
645
|
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
@@ -706,7 +650,7 @@ export declare class Project {
|
|
|
706
650
|
* Update the project OAuth2 Etsy configuration.
|
|
707
651
|
*
|
|
708
652
|
* @param {string} params.keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
709
|
-
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example:
|
|
653
|
+
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
710
654
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
711
655
|
* @throws {AppwriteException}
|
|
712
656
|
* @returns {Promise<Models.OAuth2Etsy>}
|
|
@@ -720,7 +664,7 @@ export declare class Project {
|
|
|
720
664
|
* Update the project OAuth2 Etsy configuration.
|
|
721
665
|
*
|
|
722
666
|
* @param {string} keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
723
|
-
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example:
|
|
667
|
+
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
724
668
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
725
669
|
* @throws {AppwriteException}
|
|
726
670
|
* @returns {Promise<Models.OAuth2Etsy>}
|
|
@@ -731,7 +675,7 @@ export declare class Project {
|
|
|
731
675
|
* Update the project OAuth2 Facebook configuration.
|
|
732
676
|
*
|
|
733
677
|
* @param {string} params.appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
734
|
-
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example:
|
|
678
|
+
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
735
679
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
736
680
|
* @throws {AppwriteException}
|
|
737
681
|
* @returns {Promise<Models.OAuth2Facebook>}
|
|
@@ -745,7 +689,7 @@ export declare class Project {
|
|
|
745
689
|
* Update the project OAuth2 Facebook configuration.
|
|
746
690
|
*
|
|
747
691
|
* @param {string} appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
748
|
-
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example:
|
|
692
|
+
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
749
693
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
750
694
|
* @throws {AppwriteException}
|
|
751
695
|
* @returns {Promise<Models.OAuth2Facebook>}
|
|
@@ -756,7 +700,7 @@ export declare class Project {
|
|
|
756
700
|
* Update the project OAuth2 Figma configuration.
|
|
757
701
|
*
|
|
758
702
|
* @param {string} params.clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
759
|
-
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example:
|
|
703
|
+
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
760
704
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
761
705
|
* @throws {AppwriteException}
|
|
762
706
|
* @returns {Promise<Models.OAuth2Figma>}
|
|
@@ -770,7 +714,7 @@ export declare class Project {
|
|
|
770
714
|
* Update the project OAuth2 Figma configuration.
|
|
771
715
|
*
|
|
772
716
|
* @param {string} clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
773
|
-
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example:
|
|
717
|
+
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
774
718
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
775
719
|
* @throws {AppwriteException}
|
|
776
720
|
* @returns {Promise<Models.OAuth2Figma>}
|
|
@@ -781,7 +725,7 @@ export declare class Project {
|
|
|
781
725
|
* Update the project OAuth2 FusionAuth configuration.
|
|
782
726
|
*
|
|
783
727
|
* @param {string} params.clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
784
|
-
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example:
|
|
728
|
+
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
785
729
|
* @param {string} params.endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
786
730
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
787
731
|
* @throws {AppwriteException}
|
|
@@ -797,7 +741,7 @@ export declare class Project {
|
|
|
797
741
|
* Update the project OAuth2 FusionAuth configuration.
|
|
798
742
|
*
|
|
799
743
|
* @param {string} clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
800
|
-
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example:
|
|
744
|
+
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
801
745
|
* @param {string} endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
802
746
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
803
747
|
* @throws {AppwriteException}
|
|
@@ -809,7 +753,7 @@ export declare class Project {
|
|
|
809
753
|
* Update the project OAuth2 GitHub configuration.
|
|
810
754
|
*
|
|
811
755
|
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
812
|
-
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example:
|
|
756
|
+
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
813
757
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
814
758
|
* @throws {AppwriteException}
|
|
815
759
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -823,7 +767,7 @@ export declare class Project {
|
|
|
823
767
|
* Update the project OAuth2 GitHub configuration.
|
|
824
768
|
*
|
|
825
769
|
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
826
|
-
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example:
|
|
770
|
+
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
827
771
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
828
772
|
* @throws {AppwriteException}
|
|
829
773
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -834,7 +778,7 @@ export declare class Project {
|
|
|
834
778
|
* Update the project OAuth2 Gitlab configuration.
|
|
835
779
|
*
|
|
836
780
|
* @param {string} params.applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
837
|
-
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example:
|
|
781
|
+
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
838
782
|
* @param {string} params.endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
839
783
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
840
784
|
* @throws {AppwriteException}
|
|
@@ -850,7 +794,7 @@ export declare class Project {
|
|
|
850
794
|
* Update the project OAuth2 Gitlab configuration.
|
|
851
795
|
*
|
|
852
796
|
* @param {string} applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
853
|
-
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example:
|
|
797
|
+
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
854
798
|
* @param {string} endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
855
799
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
856
800
|
* @throws {AppwriteException}
|
|
@@ -862,7 +806,8 @@ export declare class Project {
|
|
|
862
806
|
* Update the project OAuth2 Google configuration.
|
|
863
807
|
*
|
|
864
808
|
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
865
|
-
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example:
|
|
809
|
+
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
810
|
+
* @param {Prompt[]} params.prompt - Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
866
811
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
867
812
|
* @throws {AppwriteException}
|
|
868
813
|
* @returns {Promise<Models.OAuth2Google>}
|
|
@@ -870,24 +815,26 @@ export declare class Project {
|
|
|
870
815
|
updateOAuth2Google(params?: {
|
|
871
816
|
clientId?: string;
|
|
872
817
|
clientSecret?: string;
|
|
818
|
+
prompt?: Prompt[];
|
|
873
819
|
enabled?: boolean;
|
|
874
820
|
}): Promise<Models.OAuth2Google>;
|
|
875
821
|
/**
|
|
876
822
|
* Update the project OAuth2 Google configuration.
|
|
877
823
|
*
|
|
878
824
|
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
879
|
-
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example:
|
|
825
|
+
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
826
|
+
* @param {Prompt[]} prompt - Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
880
827
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
881
828
|
* @throws {AppwriteException}
|
|
882
829
|
* @returns {Promise<Models.OAuth2Google>}
|
|
883
830
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
884
831
|
*/
|
|
885
|
-
updateOAuth2Google(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
832
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: Prompt[], enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
886
833
|
/**
|
|
887
834
|
* Update the project OAuth2 Keycloak configuration.
|
|
888
835
|
*
|
|
889
836
|
* @param {string} params.clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
890
|
-
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example:
|
|
837
|
+
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
891
838
|
* @param {string} params.endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
892
839
|
* @param {string} params.realmName - Keycloak realm name. For example: appwrite-realm
|
|
893
840
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
@@ -905,7 +852,7 @@ export declare class Project {
|
|
|
905
852
|
* Update the project OAuth2 Keycloak configuration.
|
|
906
853
|
*
|
|
907
854
|
* @param {string} clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
908
|
-
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example:
|
|
855
|
+
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
909
856
|
* @param {string} endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
910
857
|
* @param {string} realmName - Keycloak realm name. For example: appwrite-realm
|
|
911
858
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
@@ -918,7 +865,7 @@ export declare class Project {
|
|
|
918
865
|
* Update the project OAuth2 Kick configuration.
|
|
919
866
|
*
|
|
920
867
|
* @param {string} params.clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
921
|
-
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example:
|
|
868
|
+
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
922
869
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
923
870
|
* @throws {AppwriteException}
|
|
924
871
|
* @returns {Promise<Models.OAuth2Kick>}
|
|
@@ -932,7 +879,7 @@ export declare class Project {
|
|
|
932
879
|
* Update the project OAuth2 Kick configuration.
|
|
933
880
|
*
|
|
934
881
|
* @param {string} clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
935
|
-
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example:
|
|
882
|
+
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
936
883
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
937
884
|
* @throws {AppwriteException}
|
|
938
885
|
* @returns {Promise<Models.OAuth2Kick>}
|
|
@@ -943,7 +890,7 @@ export declare class Project {
|
|
|
943
890
|
* Update the project OAuth2 Linkedin configuration.
|
|
944
891
|
*
|
|
945
892
|
* @param {string} params.clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
946
|
-
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example:
|
|
893
|
+
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
947
894
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
948
895
|
* @throws {AppwriteException}
|
|
949
896
|
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
@@ -957,7 +904,7 @@ export declare class Project {
|
|
|
957
904
|
* Update the project OAuth2 Linkedin configuration.
|
|
958
905
|
*
|
|
959
906
|
* @param {string} clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
960
|
-
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example:
|
|
907
|
+
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
961
908
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
962
909
|
* @throws {AppwriteException}
|
|
963
910
|
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
@@ -968,7 +915,7 @@ export declare class Project {
|
|
|
968
915
|
* Update the project OAuth2 Microsoft configuration.
|
|
969
916
|
*
|
|
970
917
|
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
971
|
-
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example:
|
|
918
|
+
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
972
919
|
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
973
920
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
974
921
|
* @throws {AppwriteException}
|
|
@@ -984,7 +931,7 @@ export declare class Project {
|
|
|
984
931
|
* Update the project OAuth2 Microsoft configuration.
|
|
985
932
|
*
|
|
986
933
|
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
987
|
-
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example:
|
|
934
|
+
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
988
935
|
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
989
936
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
990
937
|
* @throws {AppwriteException}
|
|
@@ -996,7 +943,7 @@ export declare class Project {
|
|
|
996
943
|
* Update the project OAuth2 Notion configuration.
|
|
997
944
|
*
|
|
998
945
|
* @param {string} params.oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
999
|
-
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example:
|
|
946
|
+
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
1000
947
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1001
948
|
* @throws {AppwriteException}
|
|
1002
949
|
* @returns {Promise<Models.OAuth2Notion>}
|
|
@@ -1010,7 +957,7 @@ export declare class Project {
|
|
|
1010
957
|
* Update the project OAuth2 Notion configuration.
|
|
1011
958
|
*
|
|
1012
959
|
* @param {string} oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
1013
|
-
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example:
|
|
960
|
+
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
1014
961
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1015
962
|
* @throws {AppwriteException}
|
|
1016
963
|
* @returns {Promise<Models.OAuth2Notion>}
|
|
@@ -1021,7 +968,7 @@ export declare class Project {
|
|
|
1021
968
|
* Update the project OAuth2 Oidc configuration.
|
|
1022
969
|
*
|
|
1023
970
|
* @param {string} params.clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1024
|
-
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example:
|
|
971
|
+
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1025
972
|
* @param {string} params.wellKnownURL - OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1026
973
|
* @param {string} params.authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1027
974
|
* @param {string} params.tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
@@ -1043,7 +990,7 @@ export declare class Project {
|
|
|
1043
990
|
* Update the project OAuth2 Oidc configuration.
|
|
1044
991
|
*
|
|
1045
992
|
* @param {string} clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1046
|
-
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example:
|
|
993
|
+
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1047
994
|
* @param {string} wellKnownURL - OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1048
995
|
* @param {string} authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1049
996
|
* @param {string} tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
@@ -1058,7 +1005,7 @@ export declare class Project {
|
|
|
1058
1005
|
* Update the project OAuth2 Okta configuration.
|
|
1059
1006
|
*
|
|
1060
1007
|
* @param {string} params.clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1061
|
-
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example:
|
|
1008
|
+
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1062
1009
|
* @param {string} params.domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1063
1010
|
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1064
1011
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
@@ -1076,7 +1023,7 @@ export declare class Project {
|
|
|
1076
1023
|
* Update the project OAuth2 Okta configuration.
|
|
1077
1024
|
*
|
|
1078
1025
|
* @param {string} clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1079
|
-
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example:
|
|
1026
|
+
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1080
1027
|
* @param {string} domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1081
1028
|
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1082
1029
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
@@ -1089,7 +1036,7 @@ export declare class Project {
|
|
|
1089
1036
|
* Update the project OAuth2 Paypal configuration.
|
|
1090
1037
|
*
|
|
1091
1038
|
* @param {string} params.clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1092
|
-
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example:
|
|
1039
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1093
1040
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1094
1041
|
* @throws {AppwriteException}
|
|
1095
1042
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1103,7 +1050,7 @@ export declare class Project {
|
|
|
1103
1050
|
* Update the project OAuth2 Paypal configuration.
|
|
1104
1051
|
*
|
|
1105
1052
|
* @param {string} clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1106
|
-
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example:
|
|
1053
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1107
1054
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1108
1055
|
* @throws {AppwriteException}
|
|
1109
1056
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1114,7 +1061,7 @@ export declare class Project {
|
|
|
1114
1061
|
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1115
1062
|
*
|
|
1116
1063
|
* @param {string} params.clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1117
|
-
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example:
|
|
1064
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1118
1065
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1119
1066
|
* @throws {AppwriteException}
|
|
1120
1067
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1128,7 +1075,7 @@ export declare class Project {
|
|
|
1128
1075
|
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1129
1076
|
*
|
|
1130
1077
|
* @param {string} clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1131
|
-
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example:
|
|
1078
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1132
1079
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1133
1080
|
* @throws {AppwriteException}
|
|
1134
1081
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1139,7 +1086,7 @@ export declare class Project {
|
|
|
1139
1086
|
* Update the project OAuth2 Podio configuration.
|
|
1140
1087
|
*
|
|
1141
1088
|
* @param {string} params.clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1142
|
-
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example:
|
|
1089
|
+
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1143
1090
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1144
1091
|
* @throws {AppwriteException}
|
|
1145
1092
|
* @returns {Promise<Models.OAuth2Podio>}
|
|
@@ -1153,7 +1100,7 @@ export declare class Project {
|
|
|
1153
1100
|
* Update the project OAuth2 Podio configuration.
|
|
1154
1101
|
*
|
|
1155
1102
|
* @param {string} clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1156
|
-
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example:
|
|
1103
|
+
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1157
1104
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1158
1105
|
* @throws {AppwriteException}
|
|
1159
1106
|
* @returns {Promise<Models.OAuth2Podio>}
|
|
@@ -1164,7 +1111,7 @@ export declare class Project {
|
|
|
1164
1111
|
* Update the project OAuth2 Salesforce configuration.
|
|
1165
1112
|
*
|
|
1166
1113
|
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1167
|
-
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example:
|
|
1114
|
+
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1168
1115
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1169
1116
|
* @throws {AppwriteException}
|
|
1170
1117
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1178,7 +1125,7 @@ export declare class Project {
|
|
|
1178
1125
|
* Update the project OAuth2 Salesforce configuration.
|
|
1179
1126
|
*
|
|
1180
1127
|
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1181
|
-
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example:
|
|
1128
|
+
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1182
1129
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1183
1130
|
* @throws {AppwriteException}
|
|
1184
1131
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1189,7 +1136,7 @@ export declare class Project {
|
|
|
1189
1136
|
* Update the project OAuth2 Slack configuration.
|
|
1190
1137
|
*
|
|
1191
1138
|
* @param {string} params.clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1192
|
-
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example:
|
|
1139
|
+
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1193
1140
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1194
1141
|
* @throws {AppwriteException}
|
|
1195
1142
|
* @returns {Promise<Models.OAuth2Slack>}
|
|
@@ -1203,7 +1150,7 @@ export declare class Project {
|
|
|
1203
1150
|
* Update the project OAuth2 Slack configuration.
|
|
1204
1151
|
*
|
|
1205
1152
|
* @param {string} clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1206
|
-
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example:
|
|
1153
|
+
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1207
1154
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1208
1155
|
* @throws {AppwriteException}
|
|
1209
1156
|
* @returns {Promise<Models.OAuth2Slack>}
|
|
@@ -1214,7 +1161,7 @@ export declare class Project {
|
|
|
1214
1161
|
* Update the project OAuth2 Spotify configuration.
|
|
1215
1162
|
*
|
|
1216
1163
|
* @param {string} params.clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1217
|
-
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example:
|
|
1164
|
+
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1218
1165
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1219
1166
|
* @throws {AppwriteException}
|
|
1220
1167
|
* @returns {Promise<Models.OAuth2Spotify>}
|
|
@@ -1228,7 +1175,7 @@ export declare class Project {
|
|
|
1228
1175
|
* Update the project OAuth2 Spotify configuration.
|
|
1229
1176
|
*
|
|
1230
1177
|
* @param {string} clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1231
|
-
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example:
|
|
1178
|
+
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1232
1179
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1233
1180
|
* @throws {AppwriteException}
|
|
1234
1181
|
* @returns {Promise<Models.OAuth2Spotify>}
|
|
@@ -1239,7 +1186,7 @@ export declare class Project {
|
|
|
1239
1186
|
* Update the project OAuth2 Stripe configuration.
|
|
1240
1187
|
*
|
|
1241
1188
|
* @param {string} params.clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1242
|
-
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example:
|
|
1189
|
+
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1243
1190
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1244
1191
|
* @throws {AppwriteException}
|
|
1245
1192
|
* @returns {Promise<Models.OAuth2Stripe>}
|
|
@@ -1253,7 +1200,7 @@ export declare class Project {
|
|
|
1253
1200
|
* Update the project OAuth2 Stripe configuration.
|
|
1254
1201
|
*
|
|
1255
1202
|
* @param {string} clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1256
|
-
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example:
|
|
1203
|
+
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1257
1204
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1258
1205
|
* @throws {AppwriteException}
|
|
1259
1206
|
* @returns {Promise<Models.OAuth2Stripe>}
|
|
@@ -1264,7 +1211,7 @@ export declare class Project {
|
|
|
1264
1211
|
* Update the project OAuth2 Tradeshift configuration.
|
|
1265
1212
|
*
|
|
1266
1213
|
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1267
|
-
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example:
|
|
1214
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1268
1215
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1269
1216
|
* @throws {AppwriteException}
|
|
1270
1217
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1278,7 +1225,7 @@ export declare class Project {
|
|
|
1278
1225
|
* Update the project OAuth2 Tradeshift configuration.
|
|
1279
1226
|
*
|
|
1280
1227
|
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1281
|
-
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example:
|
|
1228
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1282
1229
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1283
1230
|
* @throws {AppwriteException}
|
|
1284
1231
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1289,7 +1236,7 @@ export declare class Project {
|
|
|
1289
1236
|
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1290
1237
|
*
|
|
1291
1238
|
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1292
|
-
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example:
|
|
1239
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1293
1240
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1294
1241
|
* @throws {AppwriteException}
|
|
1295
1242
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1303,7 +1250,7 @@ export declare class Project {
|
|
|
1303
1250
|
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1304
1251
|
*
|
|
1305
1252
|
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1306
|
-
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example:
|
|
1253
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1307
1254
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1308
1255
|
* @throws {AppwriteException}
|
|
1309
1256
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1314,7 +1261,7 @@ export declare class Project {
|
|
|
1314
1261
|
* Update the project OAuth2 Twitch configuration.
|
|
1315
1262
|
*
|
|
1316
1263
|
* @param {string} params.clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1317
|
-
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example:
|
|
1264
|
+
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1318
1265
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1319
1266
|
* @throws {AppwriteException}
|
|
1320
1267
|
* @returns {Promise<Models.OAuth2Twitch>}
|
|
@@ -1328,7 +1275,7 @@ export declare class Project {
|
|
|
1328
1275
|
* Update the project OAuth2 Twitch configuration.
|
|
1329
1276
|
*
|
|
1330
1277
|
* @param {string} clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1331
|
-
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example:
|
|
1278
|
+
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1332
1279
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1333
1280
|
* @throws {AppwriteException}
|
|
1334
1281
|
* @returns {Promise<Models.OAuth2Twitch>}
|
|
@@ -1339,7 +1286,7 @@ export declare class Project {
|
|
|
1339
1286
|
* Update the project OAuth2 WordPress configuration.
|
|
1340
1287
|
*
|
|
1341
1288
|
* @param {string} params.clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1342
|
-
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example:
|
|
1289
|
+
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1343
1290
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1344
1291
|
* @throws {AppwriteException}
|
|
1345
1292
|
* @returns {Promise<Models.OAuth2WordPress>}
|
|
@@ -1353,7 +1300,7 @@ export declare class Project {
|
|
|
1353
1300
|
* Update the project OAuth2 WordPress configuration.
|
|
1354
1301
|
*
|
|
1355
1302
|
* @param {string} clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1356
|
-
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example:
|
|
1303
|
+
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1357
1304
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1358
1305
|
* @throws {AppwriteException}
|
|
1359
1306
|
* @returns {Promise<Models.OAuth2WordPress>}
|
|
@@ -1364,7 +1311,7 @@ export declare class Project {
|
|
|
1364
1311
|
* Update the project OAuth2 X configuration.
|
|
1365
1312
|
*
|
|
1366
1313
|
* @param {string} params.customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1367
|
-
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example:
|
|
1314
|
+
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1368
1315
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1369
1316
|
* @throws {AppwriteException}
|
|
1370
1317
|
* @returns {Promise<Models.OAuth2X>}
|
|
@@ -1378,7 +1325,7 @@ export declare class Project {
|
|
|
1378
1325
|
* Update the project OAuth2 X configuration.
|
|
1379
1326
|
*
|
|
1380
1327
|
* @param {string} customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1381
|
-
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example:
|
|
1328
|
+
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1382
1329
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1383
1330
|
* @throws {AppwriteException}
|
|
1384
1331
|
* @returns {Promise<Models.OAuth2X>}
|
|
@@ -1389,7 +1336,7 @@ export declare class Project {
|
|
|
1389
1336
|
* Update the project OAuth2 Yahoo configuration.
|
|
1390
1337
|
*
|
|
1391
1338
|
* @param {string} params.clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1392
|
-
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example:
|
|
1339
|
+
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1393
1340
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1394
1341
|
* @throws {AppwriteException}
|
|
1395
1342
|
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
@@ -1403,7 +1350,7 @@ export declare class Project {
|
|
|
1403
1350
|
* Update the project OAuth2 Yahoo configuration.
|
|
1404
1351
|
*
|
|
1405
1352
|
* @param {string} clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1406
|
-
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example:
|
|
1353
|
+
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1407
1354
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1408
1355
|
* @throws {AppwriteException}
|
|
1409
1356
|
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
@@ -1414,7 +1361,7 @@ export declare class Project {
|
|
|
1414
1361
|
* Update the project OAuth2 Yandex configuration.
|
|
1415
1362
|
*
|
|
1416
1363
|
* @param {string} params.clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1417
|
-
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example:
|
|
1364
|
+
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1418
1365
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1419
1366
|
* @throws {AppwriteException}
|
|
1420
1367
|
* @returns {Promise<Models.OAuth2Yandex>}
|
|
@@ -1428,7 +1375,7 @@ export declare class Project {
|
|
|
1428
1375
|
* Update the project OAuth2 Yandex configuration.
|
|
1429
1376
|
*
|
|
1430
1377
|
* @param {string} clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1431
|
-
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example:
|
|
1378
|
+
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1432
1379
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1433
1380
|
* @throws {AppwriteException}
|
|
1434
1381
|
* @returns {Promise<Models.OAuth2Yandex>}
|
|
@@ -1439,7 +1386,7 @@ export declare class Project {
|
|
|
1439
1386
|
* Update the project OAuth2 Zoho configuration.
|
|
1440
1387
|
*
|
|
1441
1388
|
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1442
|
-
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example:
|
|
1389
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1443
1390
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1444
1391
|
* @throws {AppwriteException}
|
|
1445
1392
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1453,7 +1400,7 @@ export declare class Project {
|
|
|
1453
1400
|
* Update the project OAuth2 Zoho configuration.
|
|
1454
1401
|
*
|
|
1455
1402
|
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1456
|
-
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example:
|
|
1403
|
+
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1457
1404
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1458
1405
|
* @throws {AppwriteException}
|
|
1459
1406
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1464,7 +1411,7 @@ export declare class Project {
|
|
|
1464
1411
|
* Update the project OAuth2 Zoom configuration.
|
|
1465
1412
|
*
|
|
1466
1413
|
* @param {string} params.clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1467
|
-
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example:
|
|
1414
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1468
1415
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1469
1416
|
* @throws {AppwriteException}
|
|
1470
1417
|
* @returns {Promise<Models.OAuth2Zoom>}
|
|
@@ -1478,7 +1425,7 @@ export declare class Project {
|
|
|
1478
1425
|
* Update the project OAuth2 Zoom configuration.
|
|
1479
1426
|
*
|
|
1480
1427
|
* @param {string} clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1481
|
-
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example:
|
|
1428
|
+
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1482
1429
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1483
1430
|
* @throws {AppwriteException}
|
|
1484
1431
|
* @returns {Promise<Models.OAuth2Zoom>}
|
|
@@ -1836,6 +1783,63 @@ export declare class Project {
|
|
|
1836
1783
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1837
1784
|
*/
|
|
1838
1785
|
listPolicies(queries?: string[], total?: boolean): Promise<Models.PolicyList>;
|
|
1786
|
+
/**
|
|
1787
|
+
* Configures if email aliases such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.
|
|
1788
|
+
*
|
|
1789
|
+
* @param {boolean} params.enabled - Set whether or not to block email aliases during signup and email updates.
|
|
1790
|
+
* @throws {AppwriteException}
|
|
1791
|
+
* @returns {Promise<Models.Project>}
|
|
1792
|
+
*/
|
|
1793
|
+
updateDenyCanonicalEmailPolicy(params: {
|
|
1794
|
+
enabled: boolean;
|
|
1795
|
+
}): Promise<Models.Project>;
|
|
1796
|
+
/**
|
|
1797
|
+
* Configures if email aliases such as subaddresses and emails with suffixes are denied during new users sign-ups and email updates.
|
|
1798
|
+
*
|
|
1799
|
+
* @param {boolean} enabled - Set whether or not to block email aliases during signup and email updates.
|
|
1800
|
+
* @throws {AppwriteException}
|
|
1801
|
+
* @returns {Promise<Models.Project>}
|
|
1802
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1803
|
+
*/
|
|
1804
|
+
updateDenyCanonicalEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1805
|
+
/**
|
|
1806
|
+
* Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.
|
|
1807
|
+
*
|
|
1808
|
+
* @param {boolean} params.enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
1809
|
+
* @throws {AppwriteException}
|
|
1810
|
+
* @returns {Promise<Models.Project>}
|
|
1811
|
+
*/
|
|
1812
|
+
updateDenyDisposableEmailPolicy(params: {
|
|
1813
|
+
enabled: boolean;
|
|
1814
|
+
}): Promise<Models.Project>;
|
|
1815
|
+
/**
|
|
1816
|
+
* Configures if disposable emails from known temporary domains are denied during new users sign-ups and email updates.
|
|
1817
|
+
*
|
|
1818
|
+
* @param {boolean} enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
1819
|
+
* @throws {AppwriteException}
|
|
1820
|
+
* @returns {Promise<Models.Project>}
|
|
1821
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1822
|
+
*/
|
|
1823
|
+
updateDenyDisposableEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1824
|
+
/**
|
|
1825
|
+
* Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.
|
|
1826
|
+
*
|
|
1827
|
+
* @param {boolean} params.enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
1828
|
+
* @throws {AppwriteException}
|
|
1829
|
+
* @returns {Promise<Models.Project>}
|
|
1830
|
+
*/
|
|
1831
|
+
updateDenyFreeEmailPolicy(params: {
|
|
1832
|
+
enabled: boolean;
|
|
1833
|
+
}): Promise<Models.Project>;
|
|
1834
|
+
/**
|
|
1835
|
+
* Configures if emails from free providers such as Gmail or Yahoo are denied during new users sign-ups and email updates.
|
|
1836
|
+
*
|
|
1837
|
+
* @param {boolean} enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
1838
|
+
* @throws {AppwriteException}
|
|
1839
|
+
* @returns {Promise<Models.Project>}
|
|
1840
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1841
|
+
*/
|
|
1842
|
+
updateDenyFreeEmailPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1839
1843
|
/**
|
|
1840
1844
|
* Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..
|
|
1841
1845
|
*
|