@appwrite.io/console 12.1.0 → 12.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +400 -78
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +401 -79
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +401 -79
- package/package.json +1 -1
- package/types/enums/{method-id.d.ts → auth-method.d.ts} +1 -1
- package/types/enums/o-auth-provider.d.ts +3 -1
- package/types/enums/on-duplicate.d.ts +5 -0
- package/types/enums/{policy-id.d.ts → project-policy.d.ts} +1 -1
- package/types/enums/proxy-rule-status.d.ts +2 -3
- package/types/enums/scopes.d.ts +2 -2
- package/types/index.d.ts +3 -2
- package/types/models.d.ts +107 -9
- package/types/services/databases.d.ts +86 -0
- package/types/services/functions.d.ts +13 -4
- package/types/services/migrations.d.ts +13 -3
- package/types/services/project.d.ts +128 -112
- package/types/services/proxy.d.ts +21 -8
- package/types/services/sites.d.ts +13 -4
- package/types/services/tables-db.d.ts +84 -0
- package/types/services/vcs.d.ts +9 -3
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import {
|
|
3
|
+
import { AuthMethod } from '../enums/auth-method';
|
|
4
4
|
import { Scopes } from '../enums/scopes';
|
|
5
|
-
import {
|
|
5
|
+
import { OAuthProvider } from '../enums/o-auth-provider';
|
|
6
|
+
import { ProjectPolicy } from '../enums/project-policy';
|
|
6
7
|
import { ProtocolId } from '../enums/protocol-id';
|
|
7
8
|
import { ServiceId } from '../enums/service-id';
|
|
8
9
|
import { Secure } from '../enums/secure';
|
|
@@ -22,25 +23,25 @@ export declare class Project {
|
|
|
22
23
|
/**
|
|
23
24
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
24
25
|
*
|
|
25
|
-
* @param {
|
|
26
|
+
* @param {AuthMethod} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
26
27
|
* @param {boolean} params.enabled - Auth method status.
|
|
27
28
|
* @throws {AppwriteException}
|
|
28
29
|
* @returns {Promise<Models.Project>}
|
|
29
30
|
*/
|
|
30
31
|
updateAuthMethod(params: {
|
|
31
|
-
methodId:
|
|
32
|
+
methodId: AuthMethod;
|
|
32
33
|
enabled: boolean;
|
|
33
34
|
}): Promise<Models.Project>;
|
|
34
35
|
/**
|
|
35
36
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
36
37
|
*
|
|
37
|
-
* @param {
|
|
38
|
+
* @param {AuthMethod} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
38
39
|
* @param {boolean} enabled - Auth method status.
|
|
39
40
|
* @throws {AppwriteException}
|
|
40
41
|
* @returns {Promise<Models.Project>}
|
|
41
42
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
42
43
|
*/
|
|
43
|
-
updateAuthMethod(methodId:
|
|
44
|
+
updateAuthMethod(methodId: AuthMethod, enabled: boolean): Promise<Models.Project>;
|
|
44
45
|
/**
|
|
45
46
|
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
46
47
|
*
|
|
@@ -370,15 +371,30 @@ export declare class Project {
|
|
|
370
371
|
/**
|
|
371
372
|
* Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.
|
|
372
373
|
*
|
|
374
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
375
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
373
376
|
* @throws {AppwriteException}
|
|
374
377
|
* @returns {Promise<Models.OAuth2ProviderList>}
|
|
375
378
|
*/
|
|
376
|
-
listOAuth2Providers(
|
|
379
|
+
listOAuth2Providers(params?: {
|
|
380
|
+
queries?: string[];
|
|
381
|
+
total?: boolean;
|
|
382
|
+
}): Promise<Models.OAuth2ProviderList>;
|
|
383
|
+
/**
|
|
384
|
+
* Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.
|
|
385
|
+
*
|
|
386
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
387
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
388
|
+
* @throws {AppwriteException}
|
|
389
|
+
* @returns {Promise<Models.OAuth2ProviderList>}
|
|
390
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
391
|
+
*/
|
|
392
|
+
listOAuth2Providers(queries?: string[], total?: boolean): Promise<Models.OAuth2ProviderList>;
|
|
377
393
|
/**
|
|
378
394
|
* Update the project OAuth2 Amazon configuration.
|
|
379
395
|
*
|
|
380
396
|
* @param {string} params.clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
381
|
-
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example:
|
|
397
|
+
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: <CLIENT_SECRET>
|
|
382
398
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
383
399
|
* @throws {AppwriteException}
|
|
384
400
|
* @returns {Promise<Models.OAuth2Amazon>}
|
|
@@ -392,7 +408,7 @@ export declare class Project {
|
|
|
392
408
|
* Update the project OAuth2 Amazon configuration.
|
|
393
409
|
*
|
|
394
410
|
* @param {string} clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
395
|
-
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example:
|
|
411
|
+
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: <CLIENT_SECRET>
|
|
396
412
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
397
413
|
* @throws {AppwriteException}
|
|
398
414
|
* @returns {Promise<Models.OAuth2Amazon>}
|
|
@@ -434,7 +450,7 @@ export declare class Project {
|
|
|
434
450
|
* Update the project OAuth2 Auth0 configuration.
|
|
435
451
|
*
|
|
436
452
|
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
437
|
-
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example:
|
|
453
|
+
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: <CLIENT_SECRET>
|
|
438
454
|
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
439
455
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
440
456
|
* @throws {AppwriteException}
|
|
@@ -450,7 +466,7 @@ export declare class Project {
|
|
|
450
466
|
* Update the project OAuth2 Auth0 configuration.
|
|
451
467
|
*
|
|
452
468
|
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
453
|
-
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example:
|
|
469
|
+
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: <CLIENT_SECRET>
|
|
454
470
|
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
455
471
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
456
472
|
* @throws {AppwriteException}
|
|
@@ -462,7 +478,7 @@ export declare class Project {
|
|
|
462
478
|
* Update the project OAuth2 Authentik configuration.
|
|
463
479
|
*
|
|
464
480
|
* @param {string} params.clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
465
|
-
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example:
|
|
481
|
+
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: <CLIENT_SECRET>
|
|
466
482
|
* @param {string} params.endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
467
483
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
468
484
|
* @throws {AppwriteException}
|
|
@@ -478,7 +494,7 @@ export declare class Project {
|
|
|
478
494
|
* Update the project OAuth2 Authentik configuration.
|
|
479
495
|
*
|
|
480
496
|
* @param {string} clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
481
|
-
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example:
|
|
497
|
+
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: <CLIENT_SECRET>
|
|
482
498
|
* @param {string} endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
483
499
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
484
500
|
* @throws {AppwriteException}
|
|
@@ -490,7 +506,7 @@ export declare class Project {
|
|
|
490
506
|
* Update the project OAuth2 Autodesk configuration.
|
|
491
507
|
*
|
|
492
508
|
* @param {string} params.clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
493
|
-
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example:
|
|
509
|
+
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: <CLIENT_SECRET>
|
|
494
510
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
495
511
|
* @throws {AppwriteException}
|
|
496
512
|
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
@@ -504,7 +520,7 @@ export declare class Project {
|
|
|
504
520
|
* Update the project OAuth2 Autodesk configuration.
|
|
505
521
|
*
|
|
506
522
|
* @param {string} clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
507
|
-
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example:
|
|
523
|
+
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: <CLIENT_SECRET>
|
|
508
524
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
509
525
|
* @throws {AppwriteException}
|
|
510
526
|
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
@@ -515,7 +531,7 @@ export declare class Project {
|
|
|
515
531
|
* Update the project OAuth2 Bitbucket configuration.
|
|
516
532
|
*
|
|
517
533
|
* @param {string} params.key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
518
|
-
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example:
|
|
534
|
+
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example: <CLIENT_SECRET>
|
|
519
535
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
520
536
|
* @throws {AppwriteException}
|
|
521
537
|
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
@@ -529,7 +545,7 @@ export declare class Project {
|
|
|
529
545
|
* Update the project OAuth2 Bitbucket configuration.
|
|
530
546
|
*
|
|
531
547
|
* @param {string} key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
532
|
-
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example:
|
|
548
|
+
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example: <CLIENT_SECRET>
|
|
533
549
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
534
550
|
* @throws {AppwriteException}
|
|
535
551
|
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
@@ -540,7 +556,7 @@ export declare class Project {
|
|
|
540
556
|
* Update the project OAuth2 Bitly configuration.
|
|
541
557
|
*
|
|
542
558
|
* @param {string} params.clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
543
|
-
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example:
|
|
559
|
+
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: <CLIENT_SECRET>
|
|
544
560
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
545
561
|
* @throws {AppwriteException}
|
|
546
562
|
* @returns {Promise<Models.OAuth2Bitly>}
|
|
@@ -554,7 +570,7 @@ export declare class Project {
|
|
|
554
570
|
* Update the project OAuth2 Bitly configuration.
|
|
555
571
|
*
|
|
556
572
|
* @param {string} clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
557
|
-
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example:
|
|
573
|
+
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: <CLIENT_SECRET>
|
|
558
574
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
559
575
|
* @throws {AppwriteException}
|
|
560
576
|
* @returns {Promise<Models.OAuth2Bitly>}
|
|
@@ -565,7 +581,7 @@ export declare class Project {
|
|
|
565
581
|
* Update the project OAuth2 Box configuration.
|
|
566
582
|
*
|
|
567
583
|
* @param {string} params.clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
568
|
-
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example:
|
|
584
|
+
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example: <CLIENT_SECRET>
|
|
569
585
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
570
586
|
* @throws {AppwriteException}
|
|
571
587
|
* @returns {Promise<Models.OAuth2Box>}
|
|
@@ -579,7 +595,7 @@ export declare class Project {
|
|
|
579
595
|
* Update the project OAuth2 Box configuration.
|
|
580
596
|
*
|
|
581
597
|
* @param {string} clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
582
|
-
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example:
|
|
598
|
+
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example: <CLIENT_SECRET>
|
|
583
599
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
584
600
|
* @throws {AppwriteException}
|
|
585
601
|
* @returns {Promise<Models.OAuth2Box>}
|
|
@@ -590,7 +606,7 @@ export declare class Project {
|
|
|
590
606
|
* Update the project OAuth2 Dailymotion configuration.
|
|
591
607
|
*
|
|
592
608
|
* @param {string} params.apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
593
|
-
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example:
|
|
609
|
+
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: <CLIENT_SECRET>
|
|
594
610
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
595
611
|
* @throws {AppwriteException}
|
|
596
612
|
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
@@ -604,7 +620,7 @@ export declare class Project {
|
|
|
604
620
|
* Update the project OAuth2 Dailymotion configuration.
|
|
605
621
|
*
|
|
606
622
|
* @param {string} apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
607
|
-
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example:
|
|
623
|
+
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: <CLIENT_SECRET>
|
|
608
624
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
609
625
|
* @throws {AppwriteException}
|
|
610
626
|
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
@@ -615,7 +631,7 @@ export declare class Project {
|
|
|
615
631
|
* Update the project OAuth2 Discord configuration.
|
|
616
632
|
*
|
|
617
633
|
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
618
|
-
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example:
|
|
634
|
+
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: <CLIENT_SECRET>
|
|
619
635
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
620
636
|
* @throws {AppwriteException}
|
|
621
637
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -629,7 +645,7 @@ export declare class Project {
|
|
|
629
645
|
* Update the project OAuth2 Discord configuration.
|
|
630
646
|
*
|
|
631
647
|
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
632
|
-
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example:
|
|
648
|
+
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: <CLIENT_SECRET>
|
|
633
649
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
634
650
|
* @throws {AppwriteException}
|
|
635
651
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -640,7 +656,7 @@ export declare class Project {
|
|
|
640
656
|
* Update the project OAuth2 Disqus configuration.
|
|
641
657
|
*
|
|
642
658
|
* @param {string} params.publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
643
|
-
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example:
|
|
659
|
+
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: <CLIENT_SECRET>
|
|
644
660
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
645
661
|
* @throws {AppwriteException}
|
|
646
662
|
* @returns {Promise<Models.OAuth2Disqus>}
|
|
@@ -654,7 +670,7 @@ export declare class Project {
|
|
|
654
670
|
* Update the project OAuth2 Disqus configuration.
|
|
655
671
|
*
|
|
656
672
|
* @param {string} publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
657
|
-
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example:
|
|
673
|
+
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: <CLIENT_SECRET>
|
|
658
674
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
659
675
|
* @throws {AppwriteException}
|
|
660
676
|
* @returns {Promise<Models.OAuth2Disqus>}
|
|
@@ -665,7 +681,7 @@ export declare class Project {
|
|
|
665
681
|
* Update the project OAuth2 Dropbox configuration.
|
|
666
682
|
*
|
|
667
683
|
* @param {string} params.appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
668
|
-
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example:
|
|
684
|
+
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example: <CLIENT_SECRET>
|
|
669
685
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
670
686
|
* @throws {AppwriteException}
|
|
671
687
|
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
@@ -679,7 +695,7 @@ export declare class Project {
|
|
|
679
695
|
* Update the project OAuth2 Dropbox configuration.
|
|
680
696
|
*
|
|
681
697
|
* @param {string} appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
682
|
-
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example:
|
|
698
|
+
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example: <CLIENT_SECRET>
|
|
683
699
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
684
700
|
* @throws {AppwriteException}
|
|
685
701
|
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
@@ -690,7 +706,7 @@ export declare class Project {
|
|
|
690
706
|
* Update the project OAuth2 Etsy configuration.
|
|
691
707
|
*
|
|
692
708
|
* @param {string} params.keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
693
|
-
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example:
|
|
709
|
+
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: <CLIENT_SECRET>
|
|
694
710
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
695
711
|
* @throws {AppwriteException}
|
|
696
712
|
* @returns {Promise<Models.OAuth2Etsy>}
|
|
@@ -704,7 +720,7 @@ export declare class Project {
|
|
|
704
720
|
* Update the project OAuth2 Etsy configuration.
|
|
705
721
|
*
|
|
706
722
|
* @param {string} keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
707
|
-
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example:
|
|
723
|
+
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: <CLIENT_SECRET>
|
|
708
724
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
709
725
|
* @throws {AppwriteException}
|
|
710
726
|
* @returns {Promise<Models.OAuth2Etsy>}
|
|
@@ -715,7 +731,7 @@ export declare class Project {
|
|
|
715
731
|
* Update the project OAuth2 Facebook configuration.
|
|
716
732
|
*
|
|
717
733
|
* @param {string} params.appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
718
|
-
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example:
|
|
734
|
+
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example: <CLIENT_SECRET>
|
|
719
735
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
720
736
|
* @throws {AppwriteException}
|
|
721
737
|
* @returns {Promise<Models.OAuth2Facebook>}
|
|
@@ -729,7 +745,7 @@ export declare class Project {
|
|
|
729
745
|
* Update the project OAuth2 Facebook configuration.
|
|
730
746
|
*
|
|
731
747
|
* @param {string} appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
732
|
-
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example:
|
|
748
|
+
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example: <CLIENT_SECRET>
|
|
733
749
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
734
750
|
* @throws {AppwriteException}
|
|
735
751
|
* @returns {Promise<Models.OAuth2Facebook>}
|
|
@@ -740,7 +756,7 @@ export declare class Project {
|
|
|
740
756
|
* Update the project OAuth2 Figma configuration.
|
|
741
757
|
*
|
|
742
758
|
* @param {string} params.clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
743
|
-
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example:
|
|
759
|
+
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example: <CLIENT_SECRET>
|
|
744
760
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
745
761
|
* @throws {AppwriteException}
|
|
746
762
|
* @returns {Promise<Models.OAuth2Figma>}
|
|
@@ -754,7 +770,7 @@ export declare class Project {
|
|
|
754
770
|
* Update the project OAuth2 Figma configuration.
|
|
755
771
|
*
|
|
756
772
|
* @param {string} clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
757
|
-
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example:
|
|
773
|
+
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example: <CLIENT_SECRET>
|
|
758
774
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
759
775
|
* @throws {AppwriteException}
|
|
760
776
|
* @returns {Promise<Models.OAuth2Figma>}
|
|
@@ -765,7 +781,7 @@ export declare class Project {
|
|
|
765
781
|
* Update the project OAuth2 FusionAuth configuration.
|
|
766
782
|
*
|
|
767
783
|
* @param {string} params.clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
768
|
-
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example:
|
|
784
|
+
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: <CLIENT_SECRET>
|
|
769
785
|
* @param {string} params.endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
770
786
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
771
787
|
* @throws {AppwriteException}
|
|
@@ -781,7 +797,7 @@ export declare class Project {
|
|
|
781
797
|
* Update the project OAuth2 FusionAuth configuration.
|
|
782
798
|
*
|
|
783
799
|
* @param {string} clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
784
|
-
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example:
|
|
800
|
+
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: <CLIENT_SECRET>
|
|
785
801
|
* @param {string} endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
786
802
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
787
803
|
* @throws {AppwriteException}
|
|
@@ -793,7 +809,7 @@ export declare class Project {
|
|
|
793
809
|
* Update the project OAuth2 GitHub configuration.
|
|
794
810
|
*
|
|
795
811
|
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
796
|
-
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example:
|
|
812
|
+
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: <CLIENT_SECRET>
|
|
797
813
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
798
814
|
* @throws {AppwriteException}
|
|
799
815
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -807,7 +823,7 @@ export declare class Project {
|
|
|
807
823
|
* Update the project OAuth2 GitHub configuration.
|
|
808
824
|
*
|
|
809
825
|
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
810
|
-
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example:
|
|
826
|
+
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: <CLIENT_SECRET>
|
|
811
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.
|
|
812
828
|
* @throws {AppwriteException}
|
|
813
829
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -818,7 +834,7 @@ export declare class Project {
|
|
|
818
834
|
* Update the project OAuth2 Gitlab configuration.
|
|
819
835
|
*
|
|
820
836
|
* @param {string} params.applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
821
|
-
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example:
|
|
837
|
+
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example: <CLIENT_SECRET>
|
|
822
838
|
* @param {string} params.endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
823
839
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
824
840
|
* @throws {AppwriteException}
|
|
@@ -834,7 +850,7 @@ export declare class Project {
|
|
|
834
850
|
* Update the project OAuth2 Gitlab configuration.
|
|
835
851
|
*
|
|
836
852
|
* @param {string} applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
837
|
-
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example:
|
|
853
|
+
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example: <CLIENT_SECRET>
|
|
838
854
|
* @param {string} endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
839
855
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
840
856
|
* @throws {AppwriteException}
|
|
@@ -846,7 +862,7 @@ export declare class Project {
|
|
|
846
862
|
* Update the project OAuth2 Google configuration.
|
|
847
863
|
*
|
|
848
864
|
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
849
|
-
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example:
|
|
865
|
+
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: <CLIENT_SECRET>
|
|
850
866
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
851
867
|
* @throws {AppwriteException}
|
|
852
868
|
* @returns {Promise<Models.OAuth2Google>}
|
|
@@ -860,7 +876,7 @@ export declare class Project {
|
|
|
860
876
|
* Update the project OAuth2 Google configuration.
|
|
861
877
|
*
|
|
862
878
|
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
863
|
-
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example:
|
|
879
|
+
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: <CLIENT_SECRET>
|
|
864
880
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
865
881
|
* @throws {AppwriteException}
|
|
866
882
|
* @returns {Promise<Models.OAuth2Google>}
|
|
@@ -871,7 +887,7 @@ export declare class Project {
|
|
|
871
887
|
* Update the project OAuth2 Keycloak configuration.
|
|
872
888
|
*
|
|
873
889
|
* @param {string} params.clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
874
|
-
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example:
|
|
890
|
+
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: <CLIENT_SECRET>
|
|
875
891
|
* @param {string} params.endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
876
892
|
* @param {string} params.realmName - Keycloak realm name. For example: appwrite-realm
|
|
877
893
|
* @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.
|
|
@@ -889,7 +905,7 @@ export declare class Project {
|
|
|
889
905
|
* Update the project OAuth2 Keycloak configuration.
|
|
890
906
|
*
|
|
891
907
|
* @param {string} clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
892
|
-
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example:
|
|
908
|
+
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: <CLIENT_SECRET>
|
|
893
909
|
* @param {string} endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
894
910
|
* @param {string} realmName - Keycloak realm name. For example: appwrite-realm
|
|
895
911
|
* @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.
|
|
@@ -902,7 +918,7 @@ export declare class Project {
|
|
|
902
918
|
* Update the project OAuth2 Kick configuration.
|
|
903
919
|
*
|
|
904
920
|
* @param {string} params.clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
905
|
-
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example:
|
|
921
|
+
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example: <CLIENT_SECRET>
|
|
906
922
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
907
923
|
* @throws {AppwriteException}
|
|
908
924
|
* @returns {Promise<Models.OAuth2Kick>}
|
|
@@ -916,7 +932,7 @@ export declare class Project {
|
|
|
916
932
|
* Update the project OAuth2 Kick configuration.
|
|
917
933
|
*
|
|
918
934
|
* @param {string} clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
919
|
-
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example:
|
|
935
|
+
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example: <CLIENT_SECRET>
|
|
920
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.
|
|
921
937
|
* @throws {AppwriteException}
|
|
922
938
|
* @returns {Promise<Models.OAuth2Kick>}
|
|
@@ -927,7 +943,7 @@ export declare class Project {
|
|
|
927
943
|
* Update the project OAuth2 Linkedin configuration.
|
|
928
944
|
*
|
|
929
945
|
* @param {string} params.clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
930
|
-
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example:
|
|
946
|
+
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: <CLIENT_SECRET>
|
|
931
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.
|
|
932
948
|
* @throws {AppwriteException}
|
|
933
949
|
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
@@ -941,7 +957,7 @@ export declare class Project {
|
|
|
941
957
|
* Update the project OAuth2 Linkedin configuration.
|
|
942
958
|
*
|
|
943
959
|
* @param {string} clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
944
|
-
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example:
|
|
960
|
+
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: <CLIENT_SECRET>
|
|
945
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.
|
|
946
962
|
* @throws {AppwriteException}
|
|
947
963
|
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
@@ -952,7 +968,7 @@ export declare class Project {
|
|
|
952
968
|
* Update the project OAuth2 Microsoft configuration.
|
|
953
969
|
*
|
|
954
970
|
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
955
|
-
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example:
|
|
971
|
+
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: <CLIENT_SECRET>
|
|
956
972
|
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
957
973
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
958
974
|
* @throws {AppwriteException}
|
|
@@ -968,7 +984,7 @@ export declare class Project {
|
|
|
968
984
|
* Update the project OAuth2 Microsoft configuration.
|
|
969
985
|
*
|
|
970
986
|
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
971
|
-
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example:
|
|
987
|
+
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: <CLIENT_SECRET>
|
|
972
988
|
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
973
989
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
974
990
|
* @throws {AppwriteException}
|
|
@@ -980,7 +996,7 @@ export declare class Project {
|
|
|
980
996
|
* Update the project OAuth2 Notion configuration.
|
|
981
997
|
*
|
|
982
998
|
* @param {string} params.oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
983
|
-
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example:
|
|
999
|
+
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: <CLIENT_SECRET>
|
|
984
1000
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
985
1001
|
* @throws {AppwriteException}
|
|
986
1002
|
* @returns {Promise<Models.OAuth2Notion>}
|
|
@@ -994,7 +1010,7 @@ export declare class Project {
|
|
|
994
1010
|
* Update the project OAuth2 Notion configuration.
|
|
995
1011
|
*
|
|
996
1012
|
* @param {string} oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
997
|
-
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example:
|
|
1013
|
+
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: <CLIENT_SECRET>
|
|
998
1014
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
999
1015
|
* @throws {AppwriteException}
|
|
1000
1016
|
* @returns {Promise<Models.OAuth2Notion>}
|
|
@@ -1005,11 +1021,11 @@ export declare class Project {
|
|
|
1005
1021
|
* Update the project OAuth2 Oidc configuration.
|
|
1006
1022
|
*
|
|
1007
1023
|
* @param {string} params.clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1008
|
-
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example:
|
|
1024
|
+
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: <CLIENT_SECRET>
|
|
1009
1025
|
* @param {string} params.wellKnownURL - OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1010
1026
|
* @param {string} params.authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1011
|
-
* @param {string} params.
|
|
1012
|
-
* @param {string} params.
|
|
1027
|
+
* @param {string} params.tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1028
|
+
* @param {string} params.userInfoURL - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1013
1029
|
* @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.
|
|
1014
1030
|
* @throws {AppwriteException}
|
|
1015
1031
|
* @returns {Promise<Models.OAuth2Oidc>}
|
|
@@ -1019,30 +1035,30 @@ export declare class Project {
|
|
|
1019
1035
|
clientSecret?: string;
|
|
1020
1036
|
wellKnownURL?: string;
|
|
1021
1037
|
authorizationURL?: string;
|
|
1022
|
-
|
|
1023
|
-
|
|
1038
|
+
tokenURL?: string;
|
|
1039
|
+
userInfoURL?: string;
|
|
1024
1040
|
enabled?: boolean;
|
|
1025
1041
|
}): Promise<Models.OAuth2Oidc>;
|
|
1026
1042
|
/**
|
|
1027
1043
|
* Update the project OAuth2 Oidc configuration.
|
|
1028
1044
|
*
|
|
1029
1045
|
* @param {string} clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1030
|
-
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example:
|
|
1046
|
+
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: <CLIENT_SECRET>
|
|
1031
1047
|
* @param {string} wellKnownURL - OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1032
1048
|
* @param {string} authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1033
|
-
* @param {string}
|
|
1034
|
-
* @param {string}
|
|
1049
|
+
* @param {string} tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1050
|
+
* @param {string} userInfoURL - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1035
1051
|
* @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.
|
|
1036
1052
|
* @throws {AppwriteException}
|
|
1037
1053
|
* @returns {Promise<Models.OAuth2Oidc>}
|
|
1038
1054
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1039
1055
|
*/
|
|
1040
|
-
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string,
|
|
1056
|
+
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string, tokenURL?: string, userInfoURL?: string, enabled?: boolean): Promise<Models.OAuth2Oidc>;
|
|
1041
1057
|
/**
|
|
1042
1058
|
* Update the project OAuth2 Okta configuration.
|
|
1043
1059
|
*
|
|
1044
1060
|
* @param {string} params.clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1045
|
-
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example:
|
|
1061
|
+
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: <CLIENT_SECRET>
|
|
1046
1062
|
* @param {string} params.domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1047
1063
|
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1048
1064
|
* @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.
|
|
@@ -1060,7 +1076,7 @@ export declare class Project {
|
|
|
1060
1076
|
* Update the project OAuth2 Okta configuration.
|
|
1061
1077
|
*
|
|
1062
1078
|
* @param {string} clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1063
|
-
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example:
|
|
1079
|
+
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: <CLIENT_SECRET>
|
|
1064
1080
|
* @param {string} domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1065
1081
|
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1066
1082
|
* @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.
|
|
@@ -1073,7 +1089,7 @@ export declare class Project {
|
|
|
1073
1089
|
* Update the project OAuth2 Paypal configuration.
|
|
1074
1090
|
*
|
|
1075
1091
|
* @param {string} params.clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1076
|
-
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example:
|
|
1092
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: <CLIENT_SECRET>
|
|
1077
1093
|
* @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.
|
|
1078
1094
|
* @throws {AppwriteException}
|
|
1079
1095
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1087,7 +1103,7 @@ export declare class Project {
|
|
|
1087
1103
|
* Update the project OAuth2 Paypal configuration.
|
|
1088
1104
|
*
|
|
1089
1105
|
* @param {string} clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1090
|
-
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example:
|
|
1106
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: <CLIENT_SECRET>
|
|
1091
1107
|
* @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.
|
|
1092
1108
|
* @throws {AppwriteException}
|
|
1093
1109
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1098,7 +1114,7 @@ export declare class Project {
|
|
|
1098
1114
|
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1099
1115
|
*
|
|
1100
1116
|
* @param {string} params.clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1101
|
-
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example:
|
|
1117
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: <CLIENT_SECRET>
|
|
1102
1118
|
* @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.
|
|
1103
1119
|
* @throws {AppwriteException}
|
|
1104
1120
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1112,7 +1128,7 @@ export declare class Project {
|
|
|
1112
1128
|
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1113
1129
|
*
|
|
1114
1130
|
* @param {string} clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1115
|
-
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example:
|
|
1131
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: <CLIENT_SECRET>
|
|
1116
1132
|
* @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.
|
|
1117
1133
|
* @throws {AppwriteException}
|
|
1118
1134
|
* @returns {Promise<Models.OAuth2Paypal>}
|
|
@@ -1123,7 +1139,7 @@ export declare class Project {
|
|
|
1123
1139
|
* Update the project OAuth2 Podio configuration.
|
|
1124
1140
|
*
|
|
1125
1141
|
* @param {string} params.clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1126
|
-
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example:
|
|
1142
|
+
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example: <CLIENT_SECRET>
|
|
1127
1143
|
* @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.
|
|
1128
1144
|
* @throws {AppwriteException}
|
|
1129
1145
|
* @returns {Promise<Models.OAuth2Podio>}
|
|
@@ -1137,7 +1153,7 @@ export declare class Project {
|
|
|
1137
1153
|
* Update the project OAuth2 Podio configuration.
|
|
1138
1154
|
*
|
|
1139
1155
|
* @param {string} clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1140
|
-
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example:
|
|
1156
|
+
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example: <CLIENT_SECRET>
|
|
1141
1157
|
* @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.
|
|
1142
1158
|
* @throws {AppwriteException}
|
|
1143
1159
|
* @returns {Promise<Models.OAuth2Podio>}
|
|
@@ -1148,7 +1164,7 @@ export declare class Project {
|
|
|
1148
1164
|
* Update the project OAuth2 Salesforce configuration.
|
|
1149
1165
|
*
|
|
1150
1166
|
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1151
|
-
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example:
|
|
1167
|
+
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: <CLIENT_SECRET>
|
|
1152
1168
|
* @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.
|
|
1153
1169
|
* @throws {AppwriteException}
|
|
1154
1170
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1162,7 +1178,7 @@ export declare class Project {
|
|
|
1162
1178
|
* Update the project OAuth2 Salesforce configuration.
|
|
1163
1179
|
*
|
|
1164
1180
|
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1165
|
-
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example:
|
|
1181
|
+
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: <CLIENT_SECRET>
|
|
1166
1182
|
* @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.
|
|
1167
1183
|
* @throws {AppwriteException}
|
|
1168
1184
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1173,7 +1189,7 @@ export declare class Project {
|
|
|
1173
1189
|
* Update the project OAuth2 Slack configuration.
|
|
1174
1190
|
*
|
|
1175
1191
|
* @param {string} params.clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1176
|
-
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example:
|
|
1192
|
+
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example: <CLIENT_SECRET>
|
|
1177
1193
|
* @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.
|
|
1178
1194
|
* @throws {AppwriteException}
|
|
1179
1195
|
* @returns {Promise<Models.OAuth2Slack>}
|
|
@@ -1187,7 +1203,7 @@ export declare class Project {
|
|
|
1187
1203
|
* Update the project OAuth2 Slack configuration.
|
|
1188
1204
|
*
|
|
1189
1205
|
* @param {string} clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1190
|
-
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example:
|
|
1206
|
+
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example: <CLIENT_SECRET>
|
|
1191
1207
|
* @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.
|
|
1192
1208
|
* @throws {AppwriteException}
|
|
1193
1209
|
* @returns {Promise<Models.OAuth2Slack>}
|
|
@@ -1198,7 +1214,7 @@ export declare class Project {
|
|
|
1198
1214
|
* Update the project OAuth2 Spotify configuration.
|
|
1199
1215
|
*
|
|
1200
1216
|
* @param {string} params.clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1201
|
-
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example:
|
|
1217
|
+
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: <CLIENT_SECRET>
|
|
1202
1218
|
* @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.
|
|
1203
1219
|
* @throws {AppwriteException}
|
|
1204
1220
|
* @returns {Promise<Models.OAuth2Spotify>}
|
|
@@ -1212,7 +1228,7 @@ export declare class Project {
|
|
|
1212
1228
|
* Update the project OAuth2 Spotify configuration.
|
|
1213
1229
|
*
|
|
1214
1230
|
* @param {string} clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1215
|
-
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example:
|
|
1231
|
+
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: <CLIENT_SECRET>
|
|
1216
1232
|
* @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.
|
|
1217
1233
|
* @throws {AppwriteException}
|
|
1218
1234
|
* @returns {Promise<Models.OAuth2Spotify>}
|
|
@@ -1223,7 +1239,7 @@ export declare class Project {
|
|
|
1223
1239
|
* Update the project OAuth2 Stripe configuration.
|
|
1224
1240
|
*
|
|
1225
1241
|
* @param {string} params.clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1226
|
-
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example:
|
|
1242
|
+
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: <CLIENT_SECRET>
|
|
1227
1243
|
* @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.
|
|
1228
1244
|
* @throws {AppwriteException}
|
|
1229
1245
|
* @returns {Promise<Models.OAuth2Stripe>}
|
|
@@ -1237,7 +1253,7 @@ export declare class Project {
|
|
|
1237
1253
|
* Update the project OAuth2 Stripe configuration.
|
|
1238
1254
|
*
|
|
1239
1255
|
* @param {string} clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1240
|
-
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example:
|
|
1256
|
+
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: <CLIENT_SECRET>
|
|
1241
1257
|
* @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.
|
|
1242
1258
|
* @throws {AppwriteException}
|
|
1243
1259
|
* @returns {Promise<Models.OAuth2Stripe>}
|
|
@@ -1248,7 +1264,7 @@ export declare class Project {
|
|
|
1248
1264
|
* Update the project OAuth2 Tradeshift configuration.
|
|
1249
1265
|
*
|
|
1250
1266
|
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1251
|
-
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example:
|
|
1267
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: <CLIENT_SECRET>
|
|
1252
1268
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1253
1269
|
* @throws {AppwriteException}
|
|
1254
1270
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1262,7 +1278,7 @@ export declare class Project {
|
|
|
1262
1278
|
* Update the project OAuth2 Tradeshift configuration.
|
|
1263
1279
|
*
|
|
1264
1280
|
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1265
|
-
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example:
|
|
1281
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: <CLIENT_SECRET>
|
|
1266
1282
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1267
1283
|
* @throws {AppwriteException}
|
|
1268
1284
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1273,7 +1289,7 @@ export declare class Project {
|
|
|
1273
1289
|
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1274
1290
|
*
|
|
1275
1291
|
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1276
|
-
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example:
|
|
1292
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: <CLIENT_SECRET>
|
|
1277
1293
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1278
1294
|
* @throws {AppwriteException}
|
|
1279
1295
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1287,7 +1303,7 @@ export declare class Project {
|
|
|
1287
1303
|
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1288
1304
|
*
|
|
1289
1305
|
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1290
|
-
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example:
|
|
1306
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: <CLIENT_SECRET>
|
|
1291
1307
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1292
1308
|
* @throws {AppwriteException}
|
|
1293
1309
|
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
@@ -1298,7 +1314,7 @@ export declare class Project {
|
|
|
1298
1314
|
* Update the project OAuth2 Twitch configuration.
|
|
1299
1315
|
*
|
|
1300
1316
|
* @param {string} params.clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1301
|
-
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example:
|
|
1317
|
+
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: <CLIENT_SECRET>
|
|
1302
1318
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1303
1319
|
* @throws {AppwriteException}
|
|
1304
1320
|
* @returns {Promise<Models.OAuth2Twitch>}
|
|
@@ -1312,7 +1328,7 @@ export declare class Project {
|
|
|
1312
1328
|
* Update the project OAuth2 Twitch configuration.
|
|
1313
1329
|
*
|
|
1314
1330
|
* @param {string} clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1315
|
-
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example:
|
|
1331
|
+
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: <CLIENT_SECRET>
|
|
1316
1332
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1317
1333
|
* @throws {AppwriteException}
|
|
1318
1334
|
* @returns {Promise<Models.OAuth2Twitch>}
|
|
@@ -1323,7 +1339,7 @@ export declare class Project {
|
|
|
1323
1339
|
* Update the project OAuth2 WordPress configuration.
|
|
1324
1340
|
*
|
|
1325
1341
|
* @param {string} params.clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1326
|
-
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example:
|
|
1342
|
+
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: <CLIENT_SECRET>
|
|
1327
1343
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1328
1344
|
* @throws {AppwriteException}
|
|
1329
1345
|
* @returns {Promise<Models.OAuth2WordPress>}
|
|
@@ -1337,7 +1353,7 @@ export declare class Project {
|
|
|
1337
1353
|
* Update the project OAuth2 WordPress configuration.
|
|
1338
1354
|
*
|
|
1339
1355
|
* @param {string} clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1340
|
-
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example:
|
|
1356
|
+
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: <CLIENT_SECRET>
|
|
1341
1357
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1342
1358
|
* @throws {AppwriteException}
|
|
1343
1359
|
* @returns {Promise<Models.OAuth2WordPress>}
|
|
@@ -1348,7 +1364,7 @@ export declare class Project {
|
|
|
1348
1364
|
* Update the project OAuth2 X configuration.
|
|
1349
1365
|
*
|
|
1350
1366
|
* @param {string} params.customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1351
|
-
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example:
|
|
1367
|
+
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example: <CLIENT_SECRET>
|
|
1352
1368
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1353
1369
|
* @throws {AppwriteException}
|
|
1354
1370
|
* @returns {Promise<Models.OAuth2X>}
|
|
@@ -1362,7 +1378,7 @@ export declare class Project {
|
|
|
1362
1378
|
* Update the project OAuth2 X configuration.
|
|
1363
1379
|
*
|
|
1364
1380
|
* @param {string} customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1365
|
-
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example:
|
|
1381
|
+
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example: <CLIENT_SECRET>
|
|
1366
1382
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1367
1383
|
* @throws {AppwriteException}
|
|
1368
1384
|
* @returns {Promise<Models.OAuth2X>}
|
|
@@ -1373,7 +1389,7 @@ export declare class Project {
|
|
|
1373
1389
|
* Update the project OAuth2 Yahoo configuration.
|
|
1374
1390
|
*
|
|
1375
1391
|
* @param {string} params.clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1376
|
-
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example:
|
|
1392
|
+
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: <CLIENT_SECRET>
|
|
1377
1393
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1378
1394
|
* @throws {AppwriteException}
|
|
1379
1395
|
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
@@ -1387,7 +1403,7 @@ export declare class Project {
|
|
|
1387
1403
|
* Update the project OAuth2 Yahoo configuration.
|
|
1388
1404
|
*
|
|
1389
1405
|
* @param {string} clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1390
|
-
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example:
|
|
1406
|
+
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: <CLIENT_SECRET>
|
|
1391
1407
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1392
1408
|
* @throws {AppwriteException}
|
|
1393
1409
|
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
@@ -1398,7 +1414,7 @@ export declare class Project {
|
|
|
1398
1414
|
* Update the project OAuth2 Yandex configuration.
|
|
1399
1415
|
*
|
|
1400
1416
|
* @param {string} params.clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1401
|
-
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example:
|
|
1417
|
+
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: <CLIENT_SECRET>
|
|
1402
1418
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1403
1419
|
* @throws {AppwriteException}
|
|
1404
1420
|
* @returns {Promise<Models.OAuth2Yandex>}
|
|
@@ -1412,7 +1428,7 @@ export declare class Project {
|
|
|
1412
1428
|
* Update the project OAuth2 Yandex configuration.
|
|
1413
1429
|
*
|
|
1414
1430
|
* @param {string} clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1415
|
-
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example:
|
|
1431
|
+
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: <CLIENT_SECRET>
|
|
1416
1432
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1417
1433
|
* @throws {AppwriteException}
|
|
1418
1434
|
* @returns {Promise<Models.OAuth2Yandex>}
|
|
@@ -1423,7 +1439,7 @@ export declare class Project {
|
|
|
1423
1439
|
* Update the project OAuth2 Zoho configuration.
|
|
1424
1440
|
*
|
|
1425
1441
|
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1426
|
-
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example:
|
|
1442
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: <CLIENT_SECRET>
|
|
1427
1443
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1428
1444
|
* @throws {AppwriteException}
|
|
1429
1445
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1437,7 +1453,7 @@ export declare class Project {
|
|
|
1437
1453
|
* Update the project OAuth2 Zoho configuration.
|
|
1438
1454
|
*
|
|
1439
1455
|
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1440
|
-
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example:
|
|
1456
|
+
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: <CLIENT_SECRET>
|
|
1441
1457
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1442
1458
|
* @throws {AppwriteException}
|
|
1443
1459
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1448,7 +1464,7 @@ export declare class Project {
|
|
|
1448
1464
|
* Update the project OAuth2 Zoom configuration.
|
|
1449
1465
|
*
|
|
1450
1466
|
* @param {string} params.clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1451
|
-
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example:
|
|
1467
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: <CLIENT_SECRET>
|
|
1452
1468
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1453
1469
|
* @throws {AppwriteException}
|
|
1454
1470
|
* @returns {Promise<Models.OAuth2Zoom>}
|
|
@@ -1462,7 +1478,7 @@ export declare class Project {
|
|
|
1462
1478
|
* Update the project OAuth2 Zoom configuration.
|
|
1463
1479
|
*
|
|
1464
1480
|
* @param {string} clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1465
|
-
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example:
|
|
1481
|
+
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: <CLIENT_SECRET>
|
|
1466
1482
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1467
1483
|
* @throws {AppwriteException}
|
|
1468
1484
|
* @returns {Promise<Models.OAuth2Zoom>}
|
|
@@ -1472,22 +1488,22 @@ export declare class Project {
|
|
|
1472
1488
|
/**
|
|
1473
1489
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1474
1490
|
*
|
|
1475
|
-
* @param {
|
|
1491
|
+
* @param {OAuthProvider} params.providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1476
1492
|
* @throws {AppwriteException}
|
|
1477
1493
|
* @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>}
|
|
1478
1494
|
*/
|
|
1479
1495
|
getOAuth2Provider(params: {
|
|
1480
|
-
|
|
1496
|
+
providerId: OAuthProvider;
|
|
1481
1497
|
}): Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>;
|
|
1482
1498
|
/**
|
|
1483
1499
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1484
1500
|
*
|
|
1485
|
-
* @param {
|
|
1501
|
+
* @param {OAuthProvider} providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1486
1502
|
* @throws {AppwriteException}
|
|
1487
1503
|
* @returns {Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>}
|
|
1488
1504
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1489
1505
|
*/
|
|
1490
|
-
getOAuth2Provider(
|
|
1506
|
+
getOAuth2Provider(providerId: OAuthProvider): Promise<Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft>;
|
|
1491
1507
|
/**
|
|
1492
1508
|
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
1493
1509
|
*
|
|
@@ -2010,22 +2026,22 @@ export declare class Project {
|
|
|
2010
2026
|
/**
|
|
2011
2027
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2012
2028
|
*
|
|
2013
|
-
* @param {
|
|
2029
|
+
* @param {ProjectPolicy} params.policyId - Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.
|
|
2014
2030
|
* @throws {AppwriteException}
|
|
2015
2031
|
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2016
2032
|
*/
|
|
2017
2033
|
getPolicy(params: {
|
|
2018
|
-
policyId:
|
|
2034
|
+
policyId: ProjectPolicy;
|
|
2019
2035
|
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2020
2036
|
/**
|
|
2021
2037
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2022
2038
|
*
|
|
2023
|
-
* @param {
|
|
2039
|
+
* @param {ProjectPolicy} policyId - Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.
|
|
2024
2040
|
* @throws {AppwriteException}
|
|
2025
2041
|
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2026
2042
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2027
2043
|
*/
|
|
2028
|
-
getPolicy(policyId:
|
|
2044
|
+
getPolicy(policyId: ProjectPolicy): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2029
2045
|
/**
|
|
2030
2046
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2031
2047
|
*
|
|
@@ -2269,7 +2285,7 @@ export declare class Project {
|
|
|
2269
2285
|
/**
|
|
2270
2286
|
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
2271
2287
|
*
|
|
2272
|
-
* @param {string} params.variableId - Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2288
|
+
* @param {string} params.variableId - Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2273
2289
|
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
2274
2290
|
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
2275
2291
|
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2285,7 +2301,7 @@ export declare class Project {
|
|
|
2285
2301
|
/**
|
|
2286
2302
|
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
2287
2303
|
*
|
|
2288
|
-
* @param {string} variableId - Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2304
|
+
* @param {string} variableId - Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2289
2305
|
* @param {string} key - Variable key. Max length: 255 chars.
|
|
2290
2306
|
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
2291
2307
|
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2297,7 +2313,7 @@ export declare class Project {
|
|
|
2297
2313
|
/**
|
|
2298
2314
|
* Get a variable by its unique ID.
|
|
2299
2315
|
*
|
|
2300
|
-
* @param {string} params.variableId - Variable ID.
|
|
2316
|
+
* @param {string} params.variableId - Variable unique ID.
|
|
2301
2317
|
* @throws {AppwriteException}
|
|
2302
2318
|
* @returns {Promise<Models.Variable>}
|
|
2303
2319
|
*/
|
|
@@ -2307,7 +2323,7 @@ export declare class Project {
|
|
|
2307
2323
|
/**
|
|
2308
2324
|
* Get a variable by its unique ID.
|
|
2309
2325
|
*
|
|
2310
|
-
* @param {string} variableId - Variable ID.
|
|
2326
|
+
* @param {string} variableId - Variable unique ID.
|
|
2311
2327
|
* @throws {AppwriteException}
|
|
2312
2328
|
* @returns {Promise<Models.Variable>}
|
|
2313
2329
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -2316,7 +2332,7 @@ export declare class Project {
|
|
|
2316
2332
|
/**
|
|
2317
2333
|
* Update variable by its unique ID.
|
|
2318
2334
|
*
|
|
2319
|
-
* @param {string} params.variableId - Variable ID.
|
|
2335
|
+
* @param {string} params.variableId - Variable unique ID.
|
|
2320
2336
|
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
2321
2337
|
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
2322
2338
|
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2332,7 +2348,7 @@ export declare class Project {
|
|
|
2332
2348
|
/**
|
|
2333
2349
|
* Update variable by its unique ID.
|
|
2334
2350
|
*
|
|
2335
|
-
* @param {string} variableId - Variable ID.
|
|
2351
|
+
* @param {string} variableId - Variable unique ID.
|
|
2336
2352
|
* @param {string} key - Variable key. Max length: 255 chars.
|
|
2337
2353
|
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
2338
2354
|
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2344,7 +2360,7 @@ export declare class Project {
|
|
|
2344
2360
|
/**
|
|
2345
2361
|
* Delete a variable by its unique ID.
|
|
2346
2362
|
*
|
|
2347
|
-
* @param {string} params.variableId - Variable ID.
|
|
2363
|
+
* @param {string} params.variableId - Variable unique ID.
|
|
2348
2364
|
* @throws {AppwriteException}
|
|
2349
2365
|
* @returns {Promise<{}>}
|
|
2350
2366
|
*/
|
|
@@ -2354,7 +2370,7 @@ export declare class Project {
|
|
|
2354
2370
|
/**
|
|
2355
2371
|
* Delete a variable by its unique ID.
|
|
2356
2372
|
*
|
|
2357
|
-
* @param {string} variableId - Variable ID.
|
|
2373
|
+
* @param {string} variableId - Variable unique ID.
|
|
2358
2374
|
* @throws {AppwriteException}
|
|
2359
2375
|
* @returns {Promise<{}>}
|
|
2360
2376
|
* @deprecated Use the object parameter style method for a better developer experience.
|