@appwrite.io/console 12.1.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 +2 -2
- package/dist/cjs/sdk.js +495 -154
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +496 -155
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +496 -155
- package/package.json +1 -1
- package/types/enums/{method-id.d.ts → auth-method.d.ts} +1 -1
- package/types/enums/o-auth-2-google-prompt.d.ts +5 -0
- 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/prompt.d.ts +5 -0
- package/types/enums/proxy-rule-status.d.ts +2 -3
- package/types/enums/scopes.d.ts +2 -2
- package/types/index.d.ts +5 -2
- package/types/models.d.ts +112 -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 +108 -88
- 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,10 @@
|
|
|
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 { Prompt } from '../enums/prompt';
|
|
6
|
+
import { OAuthProvider } from '../enums/o-auth-provider';
|
|
7
|
+
import { ProjectPolicy } from '../enums/project-policy';
|
|
6
8
|
import { ProtocolId } from '../enums/protocol-id';
|
|
7
9
|
import { ServiceId } from '../enums/service-id';
|
|
8
10
|
import { Secure } from '../enums/secure';
|
|
@@ -22,82 +24,25 @@ export declare class Project {
|
|
|
22
24
|
/**
|
|
23
25
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
24
26
|
*
|
|
25
|
-
* @param {
|
|
27
|
+
* @param {AuthMethod} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
26
28
|
* @param {boolean} params.enabled - Auth method status.
|
|
27
29
|
* @throws {AppwriteException}
|
|
28
30
|
* @returns {Promise<Models.Project>}
|
|
29
31
|
*/
|
|
30
32
|
updateAuthMethod(params: {
|
|
31
|
-
methodId:
|
|
33
|
+
methodId: AuthMethod;
|
|
32
34
|
enabled: boolean;
|
|
33
35
|
}): Promise<Models.Project>;
|
|
34
36
|
/**
|
|
35
37
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
36
38
|
*
|
|
37
|
-
* @param {
|
|
39
|
+
* @param {AuthMethod} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
38
40
|
* @param {boolean} enabled - Auth method status.
|
|
39
41
|
* @throws {AppwriteException}
|
|
40
42
|
* @returns {Promise<Models.Project>}
|
|
41
43
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
42
44
|
*/
|
|
43
|
-
updateAuthMethod(methodId:
|
|
44
|
-
/**
|
|
45
|
-
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
46
|
-
*
|
|
47
|
-
* @param {boolean} params.enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
48
|
-
* @throws {AppwriteException}
|
|
49
|
-
* @returns {Promise<Models.Project>}
|
|
50
|
-
*/
|
|
51
|
-
updateCanonicalEmails(params: {
|
|
52
|
-
enabled: boolean;
|
|
53
|
-
}): Promise<Models.Project>;
|
|
54
|
-
/**
|
|
55
|
-
* Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.
|
|
56
|
-
*
|
|
57
|
-
* @param {boolean} enabled - Set whether or not to require canonical email addresses during signup and email updates.
|
|
58
|
-
* @throws {AppwriteException}
|
|
59
|
-
* @returns {Promise<Models.Project>}
|
|
60
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
61
|
-
*/
|
|
62
|
-
updateCanonicalEmails(enabled: boolean): Promise<Models.Project>;
|
|
63
|
-
/**
|
|
64
|
-
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
65
|
-
*
|
|
66
|
-
* @param {boolean} params.enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
67
|
-
* @throws {AppwriteException}
|
|
68
|
-
* @returns {Promise<Models.Project>}
|
|
69
|
-
*/
|
|
70
|
-
updateDisposableEmails(params: {
|
|
71
|
-
enabled: boolean;
|
|
72
|
-
}): Promise<Models.Project>;
|
|
73
|
-
/**
|
|
74
|
-
* Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.
|
|
75
|
-
*
|
|
76
|
-
* @param {boolean} enabled - Set whether or not to block disposable email addresses during signup and email updates.
|
|
77
|
-
* @throws {AppwriteException}
|
|
78
|
-
* @returns {Promise<Models.Project>}
|
|
79
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
80
|
-
*/
|
|
81
|
-
updateDisposableEmails(enabled: boolean): Promise<Models.Project>;
|
|
82
|
-
/**
|
|
83
|
-
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
84
|
-
*
|
|
85
|
-
* @param {boolean} params.enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
86
|
-
* @throws {AppwriteException}
|
|
87
|
-
* @returns {Promise<Models.Project>}
|
|
88
|
-
*/
|
|
89
|
-
updateFreeEmails(params: {
|
|
90
|
-
enabled: boolean;
|
|
91
|
-
}): Promise<Models.Project>;
|
|
92
|
-
/**
|
|
93
|
-
* Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.
|
|
94
|
-
*
|
|
95
|
-
* @param {boolean} enabled - Set whether or not to block free email addresses during signup and email updates.
|
|
96
|
-
* @throws {AppwriteException}
|
|
97
|
-
* @returns {Promise<Models.Project>}
|
|
98
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
99
|
-
*/
|
|
100
|
-
updateFreeEmails(enabled: boolean): Promise<Models.Project>;
|
|
45
|
+
updateAuthMethod(methodId: AuthMethod, enabled: boolean): Promise<Models.Project>;
|
|
101
46
|
/**
|
|
102
47
|
* Get a list of all API keys from the current project.
|
|
103
48
|
*
|
|
@@ -370,10 +315,25 @@ export declare class Project {
|
|
|
370
315
|
/**
|
|
371
316
|
* 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
317
|
*
|
|
318
|
+
* @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
|
|
319
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
373
320
|
* @throws {AppwriteException}
|
|
374
321
|
* @returns {Promise<Models.OAuth2ProviderList>}
|
|
375
322
|
*/
|
|
376
|
-
listOAuth2Providers(
|
|
323
|
+
listOAuth2Providers(params?: {
|
|
324
|
+
queries?: string[];
|
|
325
|
+
total?: boolean;
|
|
326
|
+
}): Promise<Models.OAuth2ProviderList>;
|
|
327
|
+
/**
|
|
328
|
+
* 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.
|
|
329
|
+
*
|
|
330
|
+
* @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
|
|
331
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
332
|
+
* @throws {AppwriteException}
|
|
333
|
+
* @returns {Promise<Models.OAuth2ProviderList>}
|
|
334
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
335
|
+
*/
|
|
336
|
+
listOAuth2Providers(queries?: string[], total?: boolean): Promise<Models.OAuth2ProviderList>;
|
|
377
337
|
/**
|
|
378
338
|
* Update the project OAuth2 Amazon configuration.
|
|
379
339
|
*
|
|
@@ -847,6 +807,7 @@ export declare class Project {
|
|
|
847
807
|
*
|
|
848
808
|
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
849
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.
|
|
850
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.
|
|
851
812
|
* @throws {AppwriteException}
|
|
852
813
|
* @returns {Promise<Models.OAuth2Google>}
|
|
@@ -854,6 +815,7 @@ export declare class Project {
|
|
|
854
815
|
updateOAuth2Google(params?: {
|
|
855
816
|
clientId?: string;
|
|
856
817
|
clientSecret?: string;
|
|
818
|
+
prompt?: Prompt[];
|
|
857
819
|
enabled?: boolean;
|
|
858
820
|
}): Promise<Models.OAuth2Google>;
|
|
859
821
|
/**
|
|
@@ -861,12 +823,13 @@ export declare class Project {
|
|
|
861
823
|
*
|
|
862
824
|
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
863
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.
|
|
864
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.
|
|
865
828
|
* @throws {AppwriteException}
|
|
866
829
|
* @returns {Promise<Models.OAuth2Google>}
|
|
867
830
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
868
831
|
*/
|
|
869
|
-
updateOAuth2Google(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
832
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: Prompt[], enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
870
833
|
/**
|
|
871
834
|
* Update the project OAuth2 Keycloak configuration.
|
|
872
835
|
*
|
|
@@ -1008,8 +971,8 @@ export declare class Project {
|
|
|
1008
971
|
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1009
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
|
|
1010
973
|
* @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.
|
|
974
|
+
* @param {string} params.tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
975
|
+
* @param {string} params.userInfoURL - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1013
976
|
* @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
977
|
* @throws {AppwriteException}
|
|
1015
978
|
* @returns {Promise<Models.OAuth2Oidc>}
|
|
@@ -1019,8 +982,8 @@ export declare class Project {
|
|
|
1019
982
|
clientSecret?: string;
|
|
1020
983
|
wellKnownURL?: string;
|
|
1021
984
|
authorizationURL?: string;
|
|
1022
|
-
|
|
1023
|
-
|
|
985
|
+
tokenURL?: string;
|
|
986
|
+
userInfoURL?: string;
|
|
1024
987
|
enabled?: boolean;
|
|
1025
988
|
}): Promise<Models.OAuth2Oidc>;
|
|
1026
989
|
/**
|
|
@@ -1030,14 +993,14 @@ export declare class Project {
|
|
|
1030
993
|
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1031
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
|
|
1032
995
|
* @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}
|
|
996
|
+
* @param {string} tokenURL - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
997
|
+
* @param {string} userInfoURL - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1035
998
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1036
999
|
* @throws {AppwriteException}
|
|
1037
1000
|
* @returns {Promise<Models.OAuth2Oidc>}
|
|
1038
1001
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1039
1002
|
*/
|
|
1040
|
-
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string,
|
|
1003
|
+
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string, tokenURL?: string, userInfoURL?: string, enabled?: boolean): Promise<Models.OAuth2Oidc>;
|
|
1041
1004
|
/**
|
|
1042
1005
|
* Update the project OAuth2 Okta configuration.
|
|
1043
1006
|
*
|
|
@@ -1472,22 +1435,22 @@ export declare class Project {
|
|
|
1472
1435
|
/**
|
|
1473
1436
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1474
1437
|
*
|
|
1475
|
-
* @param {
|
|
1438
|
+
* @param {OAuthProvider} params.providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1476
1439
|
* @throws {AppwriteException}
|
|
1477
1440
|
* @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
1441
|
*/
|
|
1479
1442
|
getOAuth2Provider(params: {
|
|
1480
|
-
|
|
1443
|
+
providerId: OAuthProvider;
|
|
1481
1444
|
}): 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
1445
|
/**
|
|
1483
1446
|
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1484
1447
|
*
|
|
1485
|
-
* @param {
|
|
1448
|
+
* @param {OAuthProvider} providerId - OAuth2 provider key. For example: github, google, apple.
|
|
1486
1449
|
* @throws {AppwriteException}
|
|
1487
1450
|
* @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
1451
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1489
1452
|
*/
|
|
1490
|
-
getOAuth2Provider(
|
|
1453
|
+
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
1454
|
/**
|
|
1492
1455
|
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
1493
1456
|
*
|
|
@@ -1820,6 +1783,63 @@ export declare class Project {
|
|
|
1820
1783
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1821
1784
|
*/
|
|
1822
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>;
|
|
1823
1843
|
/**
|
|
1824
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..
|
|
1825
1845
|
*
|
|
@@ -2010,22 +2030,22 @@ export declare class Project {
|
|
|
2010
2030
|
/**
|
|
2011
2031
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2012
2032
|
*
|
|
2013
|
-
* @param {
|
|
2033
|
+
* @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
2034
|
* @throws {AppwriteException}
|
|
2015
2035
|
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2016
2036
|
*/
|
|
2017
2037
|
getPolicy(params: {
|
|
2018
|
-
policyId:
|
|
2038
|
+
policyId: ProjectPolicy;
|
|
2019
2039
|
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2020
2040
|
/**
|
|
2021
2041
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2022
2042
|
*
|
|
2023
|
-
* @param {
|
|
2043
|
+
* @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
2044
|
* @throws {AppwriteException}
|
|
2025
2045
|
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2026
2046
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2027
2047
|
*/
|
|
2028
|
-
getPolicy(policyId:
|
|
2048
|
+
getPolicy(policyId: ProjectPolicy): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2029
2049
|
/**
|
|
2030
2050
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2031
2051
|
*
|
|
@@ -2269,7 +2289,7 @@ export declare class Project {
|
|
|
2269
2289
|
/**
|
|
2270
2290
|
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
2271
2291
|
*
|
|
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.
|
|
2292
|
+
* @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
2293
|
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
2274
2294
|
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
2275
2295
|
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2285,7 +2305,7 @@ export declare class Project {
|
|
|
2285
2305
|
/**
|
|
2286
2306
|
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
2287
2307
|
*
|
|
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.
|
|
2308
|
+
* @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
2309
|
* @param {string} key - Variable key. Max length: 255 chars.
|
|
2290
2310
|
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
2291
2311
|
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2297,7 +2317,7 @@ export declare class Project {
|
|
|
2297
2317
|
/**
|
|
2298
2318
|
* Get a variable by its unique ID.
|
|
2299
2319
|
*
|
|
2300
|
-
* @param {string} params.variableId - Variable ID.
|
|
2320
|
+
* @param {string} params.variableId - Variable unique ID.
|
|
2301
2321
|
* @throws {AppwriteException}
|
|
2302
2322
|
* @returns {Promise<Models.Variable>}
|
|
2303
2323
|
*/
|
|
@@ -2307,7 +2327,7 @@ export declare class Project {
|
|
|
2307
2327
|
/**
|
|
2308
2328
|
* Get a variable by its unique ID.
|
|
2309
2329
|
*
|
|
2310
|
-
* @param {string} variableId - Variable ID.
|
|
2330
|
+
* @param {string} variableId - Variable unique ID.
|
|
2311
2331
|
* @throws {AppwriteException}
|
|
2312
2332
|
* @returns {Promise<Models.Variable>}
|
|
2313
2333
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -2316,7 +2336,7 @@ export declare class Project {
|
|
|
2316
2336
|
/**
|
|
2317
2337
|
* Update variable by its unique ID.
|
|
2318
2338
|
*
|
|
2319
|
-
* @param {string} params.variableId - Variable ID.
|
|
2339
|
+
* @param {string} params.variableId - Variable unique ID.
|
|
2320
2340
|
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
2321
2341
|
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
2322
2342
|
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2332,7 +2352,7 @@ export declare class Project {
|
|
|
2332
2352
|
/**
|
|
2333
2353
|
* Update variable by its unique ID.
|
|
2334
2354
|
*
|
|
2335
|
-
* @param {string} variableId - Variable ID.
|
|
2355
|
+
* @param {string} variableId - Variable unique ID.
|
|
2336
2356
|
* @param {string} key - Variable key. Max length: 255 chars.
|
|
2337
2357
|
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
2338
2358
|
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
@@ -2344,7 +2364,7 @@ export declare class Project {
|
|
|
2344
2364
|
/**
|
|
2345
2365
|
* Delete a variable by its unique ID.
|
|
2346
2366
|
*
|
|
2347
|
-
* @param {string} params.variableId - Variable ID.
|
|
2367
|
+
* @param {string} params.variableId - Variable unique ID.
|
|
2348
2368
|
* @throws {AppwriteException}
|
|
2349
2369
|
* @returns {Promise<{}>}
|
|
2350
2370
|
*/
|
|
@@ -2354,7 +2374,7 @@ export declare class Project {
|
|
|
2354
2374
|
/**
|
|
2355
2375
|
* Delete a variable by its unique ID.
|
|
2356
2376
|
*
|
|
2357
|
-
* @param {string} variableId - Variable ID.
|
|
2377
|
+
* @param {string} variableId - Variable unique ID.
|
|
2358
2378
|
* @throws {AppwriteException}
|
|
2359
2379
|
* @returns {Promise<{}>}
|
|
2360
2380
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -9,30 +9,29 @@ export declare class Proxy {
|
|
|
9
9
|
* Get a list of all the proxy rules. You can use the query params to filter your results.
|
|
10
10
|
*
|
|
11
11
|
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
|
|
12
|
-
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
13
12
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
14
13
|
* @throws {AppwriteException}
|
|
15
14
|
* @returns {Promise<Models.ProxyRuleList>}
|
|
16
15
|
*/
|
|
17
16
|
listRules(params?: {
|
|
18
17
|
queries?: string[];
|
|
19
|
-
search?: string;
|
|
20
18
|
total?: boolean;
|
|
21
19
|
}): Promise<Models.ProxyRuleList>;
|
|
22
20
|
/**
|
|
23
21
|
* Get a list of all the proxy rules. You can use the query params to filter your results.
|
|
24
22
|
*
|
|
25
23
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
|
|
26
|
-
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
27
24
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
28
25
|
* @throws {AppwriteException}
|
|
29
26
|
* @returns {Promise<Models.ProxyRuleList>}
|
|
30
27
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
31
28
|
*/
|
|
32
|
-
listRules(queries?: string[],
|
|
29
|
+
listRules(queries?: string[], total?: boolean): Promise<Models.ProxyRuleList>;
|
|
33
30
|
/**
|
|
34
31
|
* Create a new proxy rule for serving Appwrite's API on custom domain.
|
|
35
32
|
*
|
|
33
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
34
|
+
*
|
|
36
35
|
* @param {string} params.domain - Domain name.
|
|
37
36
|
* @throws {AppwriteException}
|
|
38
37
|
* @returns {Promise<Models.ProxyRule>}
|
|
@@ -43,6 +42,8 @@ export declare class Proxy {
|
|
|
43
42
|
/**
|
|
44
43
|
* Create a new proxy rule for serving Appwrite's API on custom domain.
|
|
45
44
|
*
|
|
45
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
46
|
+
*
|
|
46
47
|
* @param {string} domain - Domain name.
|
|
47
48
|
* @throws {AppwriteException}
|
|
48
49
|
* @returns {Promise<Models.ProxyRule>}
|
|
@@ -52,6 +53,8 @@ export declare class Proxy {
|
|
|
52
53
|
/**
|
|
53
54
|
* Create a new proxy rule for executing Appwrite Function on custom domain.
|
|
54
55
|
*
|
|
56
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
57
|
+
*
|
|
55
58
|
* @param {string} params.domain - Domain name.
|
|
56
59
|
* @param {string} params.functionId - ID of function to be executed.
|
|
57
60
|
* @param {string} params.branch - Name of VCS branch to deploy changes automatically
|
|
@@ -66,6 +69,8 @@ export declare class Proxy {
|
|
|
66
69
|
/**
|
|
67
70
|
* Create a new proxy rule for executing Appwrite Function on custom domain.
|
|
68
71
|
*
|
|
72
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
73
|
+
*
|
|
69
74
|
* @param {string} domain - Domain name.
|
|
70
75
|
* @param {string} functionId - ID of function to be executed.
|
|
71
76
|
* @param {string} branch - Name of VCS branch to deploy changes automatically
|
|
@@ -77,6 +82,8 @@ export declare class Proxy {
|
|
|
77
82
|
/**
|
|
78
83
|
* Create a new proxy rule for to redirect from custom domain to another domain.
|
|
79
84
|
*
|
|
85
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
86
|
+
*
|
|
80
87
|
* @param {string} params.domain - Domain name.
|
|
81
88
|
* @param {string} params.url - Target URL of redirection
|
|
82
89
|
* @param {StatusCode} params.statusCode - Status code of redirection
|
|
@@ -95,6 +102,8 @@ export declare class Proxy {
|
|
|
95
102
|
/**
|
|
96
103
|
* Create a new proxy rule for to redirect from custom domain to another domain.
|
|
97
104
|
*
|
|
105
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
106
|
+
*
|
|
98
107
|
* @param {string} domain - Domain name.
|
|
99
108
|
* @param {string} url - Target URL of redirection
|
|
100
109
|
* @param {StatusCode} statusCode - Status code of redirection
|
|
@@ -108,6 +117,8 @@ export declare class Proxy {
|
|
|
108
117
|
/**
|
|
109
118
|
* Create a new proxy rule for serving Appwrite Site on custom domain.
|
|
110
119
|
*
|
|
120
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
121
|
+
*
|
|
111
122
|
* @param {string} params.domain - Domain name.
|
|
112
123
|
* @param {string} params.siteId - ID of site to be executed.
|
|
113
124
|
* @param {string} params.branch - Name of VCS branch to deploy changes automatically
|
|
@@ -122,6 +133,8 @@ export declare class Proxy {
|
|
|
122
133
|
/**
|
|
123
134
|
* Create a new proxy rule for serving Appwrite Site on custom domain.
|
|
124
135
|
*
|
|
136
|
+
* Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
|
|
137
|
+
*
|
|
125
138
|
* @param {string} domain - Domain name.
|
|
126
139
|
* @param {string} siteId - ID of site to be executed.
|
|
127
140
|
* @param {string} branch - Name of VCS branch to deploy changes automatically
|
|
@@ -169,22 +182,22 @@ export declare class Proxy {
|
|
|
169
182
|
*/
|
|
170
183
|
deleteRule(ruleId: string): Promise<{}>;
|
|
171
184
|
/**
|
|
172
|
-
*
|
|
185
|
+
* If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.
|
|
173
186
|
*
|
|
174
187
|
* @param {string} params.ruleId - Rule ID.
|
|
175
188
|
* @throws {AppwriteException}
|
|
176
189
|
* @returns {Promise<Models.ProxyRule>}
|
|
177
190
|
*/
|
|
178
|
-
|
|
191
|
+
updateRuleStatus(params: {
|
|
179
192
|
ruleId: string;
|
|
180
193
|
}): Promise<Models.ProxyRule>;
|
|
181
194
|
/**
|
|
182
|
-
*
|
|
195
|
+
* If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.
|
|
183
196
|
*
|
|
184
197
|
* @param {string} ruleId - Rule ID.
|
|
185
198
|
* @throws {AppwriteException}
|
|
186
199
|
* @returns {Promise<Models.ProxyRule>}
|
|
187
200
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
188
201
|
*/
|
|
189
|
-
|
|
202
|
+
updateRuleStatus(ruleId: string): Promise<Models.ProxyRule>;
|
|
190
203
|
}
|
|
@@ -679,25 +679,32 @@ export declare class Sites {
|
|
|
679
679
|
* Get a list of all variables of a specific site.
|
|
680
680
|
*
|
|
681
681
|
* @param {string} params.siteId - Site unique ID.
|
|
682
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret
|
|
683
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
682
684
|
* @throws {AppwriteException}
|
|
683
685
|
* @returns {Promise<Models.VariableList>}
|
|
684
686
|
*/
|
|
685
687
|
listVariables(params: {
|
|
686
688
|
siteId: string;
|
|
689
|
+
queries?: string[];
|
|
690
|
+
total?: boolean;
|
|
687
691
|
}): Promise<Models.VariableList>;
|
|
688
692
|
/**
|
|
689
693
|
* Get a list of all variables of a specific site.
|
|
690
694
|
*
|
|
691
695
|
* @param {string} siteId - Site unique ID.
|
|
696
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret
|
|
697
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
692
698
|
* @throws {AppwriteException}
|
|
693
699
|
* @returns {Promise<Models.VariableList>}
|
|
694
700
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
695
701
|
*/
|
|
696
|
-
listVariables(siteId: string): Promise<Models.VariableList>;
|
|
702
|
+
listVariables(siteId: string, queries?: string[], total?: boolean): Promise<Models.VariableList>;
|
|
697
703
|
/**
|
|
698
704
|
* Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
|
|
699
705
|
*
|
|
700
706
|
* @param {string} params.siteId - Site unique ID.
|
|
707
|
+
* @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.
|
|
701
708
|
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
702
709
|
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
703
710
|
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
|
|
@@ -706,6 +713,7 @@ export declare class Sites {
|
|
|
706
713
|
*/
|
|
707
714
|
createVariable(params: {
|
|
708
715
|
siteId: string;
|
|
716
|
+
variableId: string;
|
|
709
717
|
key: string;
|
|
710
718
|
value: string;
|
|
711
719
|
secret?: boolean;
|
|
@@ -714,6 +722,7 @@ export declare class Sites {
|
|
|
714
722
|
* Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
|
|
715
723
|
*
|
|
716
724
|
* @param {string} siteId - Site unique ID.
|
|
725
|
+
* @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.
|
|
717
726
|
* @param {string} key - Variable key. Max length: 255 chars.
|
|
718
727
|
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
719
728
|
* @param {boolean} secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
|
|
@@ -721,7 +730,7 @@ export declare class Sites {
|
|
|
721
730
|
* @returns {Promise<Models.Variable>}
|
|
722
731
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
723
732
|
*/
|
|
724
|
-
createVariable(siteId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
|
|
733
|
+
createVariable(siteId: string, variableId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
|
|
725
734
|
/**
|
|
726
735
|
* Get a variable by its unique ID.
|
|
727
736
|
*
|
|
@@ -758,7 +767,7 @@ export declare class Sites {
|
|
|
758
767
|
updateVariable(params: {
|
|
759
768
|
siteId: string;
|
|
760
769
|
variableId: string;
|
|
761
|
-
key
|
|
770
|
+
key?: string;
|
|
762
771
|
value?: string;
|
|
763
772
|
secret?: boolean;
|
|
764
773
|
}): Promise<Models.Variable>;
|
|
@@ -774,7 +783,7 @@ export declare class Sites {
|
|
|
774
783
|
* @returns {Promise<Models.Variable>}
|
|
775
784
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
776
785
|
*/
|
|
777
|
-
updateVariable(siteId: string, variableId: string, key
|
|
786
|
+
updateVariable(siteId: string, variableId: string, key?: string, value?: string, secret?: boolean): Promise<Models.Variable>;
|
|
778
787
|
/**
|
|
779
788
|
* Delete a variable by its unique ID.
|
|
780
789
|
*
|